Поскольку Дейв попросил меня повторить мой ответ на Пропускать все пространства имен xsi и xsd при сериализации объекта в .NET , я обновил этот пост и повторил свой ответ здесь по вышеупомянутой ссылке. Пример, использованный в этом ответе, является тем же примером, который использовался для другого вопроса. Последующее скопировано, дословно.
Прочитав документацию Microsoft и несколько решений в Интернете, я нашел решение этой проблемы. Он работает как со встроенной XmlSerializer, так и с пользовательской сериализацией XML через IXmlSerialiazble.
Для примера я буду использовать тот же MyTypeWithNamespaces пример XML, который использовался в ответах на этот вопрос до сих пор.
[XmlRoot("MyTypeWithNamespaces", Namespace="urn:Abracadabra", IsNullable=false)]
public class MyTypeWithNamespaces
{
// As noted below, per Microsoft's documentation, if the class exposes a public
// member of type XmlSerializerNamespaces decorated with the
// XmlNamespacesDeclarationAttribute, then the XmlSerializer will utilize those
// namespaces during serialization.
public MyTypeWithNamespaces( )
{
this._namespaces = new XmlSerializerNamespaces(new XmlQualifiedName[] {
// Don't do this!! Microsoft's documentation explicitly says it's not supported.
// It doesn't throw any exceptions, but in my testing, it didn't always work.
// new XmlQualifiedName(string.Empty, string.Empty), // And don't do this:
// new XmlQualifiedName("", "")
// DO THIS:
new XmlQualifiedName(string.Empty, "urn:Abracadabra") // Default Namespace
// Add any other namespaces, with prefixes, here.
});
}
// If you have other constructors, make sure to call the default constructor.
public MyTypeWithNamespaces(string label, int epoch) : this( )
{
this._label = label;
this._epoch = epoch;
}
// An element with a declared namespace different than the namespace
// of the enclosing type.
[XmlElement(Namespace="urn:Whoohoo")]
public string Label
{
get { return this._label; }
set { this._label = value; }
}
private string _label;
// An element whose tag will be the same name as the property name.
// Also, this element will inherit the namespace of the enclosing type.
public int Epoch
{
get { return this._epoch; }
set { this._epoch = value; }
}
private int _epoch;
// Per Microsoft's documentation, you can add some public member that
// returns a XmlSerializerNamespaces object. They use a public field,
// but that's sloppy. So I'll use a private backed-field with a public
// getter property. Also, per the documentation, for this to work with
// the XmlSerializer, decorate it with the XmlNamespaceDeclarations
// attribute.
[XmlNamespaceDeclarations]
public XmlSerializerNamespaces Namespaces
{
get { return this._namespaces; }
}
private XmlSerializerNamespaces _namespaces;
}
Это все для этого класса. Теперь некоторые возражали против наличия объекта XmlSerializerNamespaces где-то в пределах своих классов; но, как вы можете видеть, я аккуратно спрятал его в конструкторе по умолчанию и открыл открытое свойство для возврата пространств имен.
Теперь, когда придет время сериализовать класс, вы должны использовать следующий код:
MyTypeWithNamespaces myType = new MyTypeWithNamespaces("myLabel", 42);
/******
OK, I just figured I could do this to make the code shorter, so I commented out the
below and replaced it with what follows:
// You have to use this constructor in order for the root element to have the right namespaces.
// If you need to do custom serialization of inner objects, you can use a shortened constructor.
XmlSerializer xs = new XmlSerializer(typeof(MyTypeWithNamespaces), new XmlAttributeOverrides(),
new Type[]{}, new XmlRootAttribute("MyTypeWithNamespaces"), "urn:Abracadabra");
******/
XmlSerializer xs = new XmlSerializer(typeof(MyTypeWithNamespaces),
new XmlRootAttribute("MyTypeWithNamespaces") { Namespace="urn:Abracadabra" });
// I'll use a MemoryStream as my backing store.
MemoryStream ms = new MemoryStream();
// This is extra! If you want to change the settings for the XmlSerializer, you have to create
// a separate XmlWriterSettings object and use the XmlTextWriter.Create(...) factory method.
// So, in this case, I want to omit the XML declaration.
XmlWriterSettings xws = new XmlWriterSettings();
xws.OmitXmlDeclaration = true;
xws.Encoding = Encoding.UTF8; // This is probably the default
// You could use the XmlWriterSetting to set indenting and new line options, but the
// XmlTextWriter class has a much easier method to accomplish that.
// The factory method returns a XmlWriter, not a XmlTextWriter, so cast it.
XmlTextWriter xtw = (XmlTextWriter)XmlTextWriter.Create(ms, xws);
// Then we can set our indenting options (this is, of course, optional).
xtw.Formatting = Formatting.Indented;
// Now serialize our object.
xs.Serialize(xtw, myType, myType.Namespaces);
Как только вы это сделаете, вы должны получить следующий вывод:
<MyTypeWithNamespaces>
<Label xmlns="urn:Whoohoo">myLabel</Label>
<Epoch>42</Epoch>
</MyTypeWithNamespaces>
Я успешно использовал этот метод в недавнем проекте с глубокой иерархией классов, которые сериализуются в XML для вызовов веб-служб. В документации Microsoft не очень ясно, что делать с общедоступным XmlSerializerNamespaces участником после его создания, и многие считают его бесполезным. Но, следуя их документации и используя ее, как показано выше, вы можете настроить, как XmlSerializer генерирует XML для ваших классов, не прибегая к неподдерживаемому поведению или «раскручивая собственную» сериализацию путем реализации IXmlSerializable.
Я надеюсь, что этот ответ раз и навсегда положит конец тому, как избавиться от стандартных пространств имен xsi и xsd, генерируемых XmlSerializer.
ОБНОВЛЕНИЕ: Я просто хочу убедиться, что я ответил на вопрос ОП об удалении всех пространств имен. Мой код выше будет работать для этого; позвольте мне показать вам, как. Теперь, в приведенном выше примере, вы действительно не можете избавиться от всех пространств имен (потому что используются два пространства имен). Где-то в вашем XML-документе вам понадобится что-то вроде xmlns="urn:Abracadabra" xmlns:w="urn:Whoohoo. Если класс в примере является частью более крупного документа, то где-то над пространством имен должно быть объявлено одно из (или оба) Abracadbra и Whoohoo. Если нет, то элемент в одном или обоих пространствах имен должен быть украшен каким-либо префиксом (у вас не может быть двух пространств имен по умолчанию, верно?). Так, для этого примера Abracadabra является пространством имен по умолчанию. Я мог бы внутри своего MyTypeWithNamespaces класса добавить префикс пространства имен для Whoohoo пространства имен следующим образом:
public MyTypeWithNamespaces
{
this._namespaces = new XmlSerializerNamespaces(new XmlQualifiedName[] {
new XmlQualifiedName(string.Empty, "urn:Abracadabra"), // Default Namespace
new XmlQualifiedName("w", "urn:Whoohoo")
});
}
Теперь в своем определении класса я указал, что элемент <Label/> находится в пространстве имен "urn:Whoohoo", поэтому мне не нужно ничего делать дальше. Когда я теперь сериализую класс, используя мой код сериализации без изменений, это вывод:
<MyTypeWithNamespaces xmlns:w="urn:Whoohoo">
<w:Label>myLabel</w:Label>
<Epoch>42</Epoch>
</MyTypeWithNamespaces>
Поскольку <Label> находится в другом пространстве имен, чем остальная часть документа, в некотором роде оно должно быть "украшено" пространством имен. Обратите внимание, что по-прежнему нет пространств имен xsi и xsd.
На этом мой ответ на другой вопрос заканчивается. Но я хотел убедиться, что я ответил на вопрос ОП об использовании пространств имен, поскольку я чувствую, что на самом деле еще не решил его. Предположим, что <Label> является частью того же пространства имен, что и остальная часть документа, в данном случае urn:Abracadabra:
<MyTypeWithNamespaces>
<Label>myLabel<Label>
<Epoch>42</Epoch>
</MyTypeWithNamespaces>
Ваш конструктор будет выглядеть так же, как в моем самом первом примере кода, вместе с открытым свойством для получения пространства имен по умолчанию:
// As noted below, per Microsoft's documentation, if the class exposes a public
// member of type XmlSerializerNamespaces decorated with the
// XmlNamespacesDeclarationAttribute, then the XmlSerializer will utilize those
// namespaces during serialization.
public MyTypeWithNamespaces( )
{
this._namespaces = new XmlSerializerNamespaces(new XmlQualifiedName[] {
new XmlQualifiedName(string.Empty, "urn:Abracadabra") // Default Namespace
});
}
[XmlNamespaceDeclarations]
public XmlSerializerNamespaces Namespaces
{
get { return this._namespaces; }
}
private XmlSerializerNamespaces _namespaces;
Затем, позже, в вашем коде, который использует объект MyTypeWithNamespaces для его сериализации, вы бы назвали его, как я делал выше:
MyTypeWithNamespaces myType = new MyTypeWithNamespaces("myLabel", 42);
XmlSerializer xs = new XmlSerializer(typeof(MyTypeWithNamespaces),
new XmlRootAttribute("MyTypeWithNamespaces") { Namespace="urn:Abracadabra" });
...
// Above, you'd setup your XmlTextWriter.
// Now serialize our object.
xs.Serialize(xtw, myType, myType.Namespaces);
И XmlSerializer выдаст тот же XML, как показано выше, без дополнительных пространств имен в выводе:
<MyTypeWithNamespaces>
<Label>myLabel<Label>
<Epoch>42</Epoch>
</MyTypeWithNamespaces>