XmlSerializer: удалите ненужные пространства имен xsi и xsd

Есть ли способ настроить XmlSerializer так, чтобы он не записывал пространства имен по умолчанию в корневой элемент?

Что я получаю, это:

<?xml ...>
<rootelement xmlns:xsi="..." xmlns:xsd="...">
</rootelement>

и я хочу удалить оба объявления xmlns.

Дубликат : Как сериализовать объект в XML без получения xmlns = ”…”?

119 голосов | спросил Dave Van den Eynde 17 PMpFri, 17 Apr 2009 16:44:21 +040044Friday 2009, 16:44:21

3 ответа


0

Поскольку Дейв попросил меня повторить мой ответ на пропуск всех пространств имен 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 пространства имен.


На этом мой ответ на другой вопрос заканчивается. Но я хотел убедиться, что я ответил на вопрос OP об использовании пространств имен, так как я чувствую, что на самом деле не обращался к немуеще. Предположим, что <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>
ответил fourpastmidnight 21 J0000006Europe/Moscow 2012, 16:33:44
0
//Create our own namespaces for the output
XmlSerializerNamespaces ns = new XmlSerializerNamespaces();

//Add an empty namespace and empty value
ns.Add("", "");

//Create the serializer
XmlSerializer slz = new XmlSerializer(someType);

//Serialize the object with our own namespaces (notice the overload)
slz.Serialize(myXmlTextWriter, someObject, ns)
ответил Jeremy 17 PMpFri, 17 Apr 2009 16:52:23 +040052Friday 2009, 16:52:23
0

Существует альтернатива - вы можете предоставить член типа XmlSerializerNamespaces в типе для сериализации. Украсьте его атрибутом XmlNamespaceDeclarations . Добавьте к этому члену префиксы пространства имен и URI. Затем любая сериализация, которая явно не предоставляет XmlSerializerNamespaces, будет использовать префикс пространства имен + пары URI, которые вы ввели в свой тип.

Пример кода. Предположим, это ваш тип:

[XmlRoot(Namespace = "urn:mycompany.2009")]
public class Person {
  [XmlAttribute] 
  public bool Known;
  [XmlElement]
  public string Name;
  [XmlNamespaceDeclarations]
  public XmlSerializerNamespaces xmlns;
}

Вы можете сделать это:

var p = new Person
  { 
      Name = "Charley",
      Known = false, 
      xmlns = new XmlSerializerNamespaces()
  }
p.xmlns.Add("",""); // default namespace is emoty
p.xmlns.Add("c", "urn:mycompany.2009");

И это будет означать, что любая сериализация этого экземпляра, в которой не указан собственный набор пар префикс + URI, будет использовать префикс «p» для пространства имен «urn: mycompany.2009». Также будут пропущены пространства имен xsi и xsd.

Разница в том, что вы добавляете XmlSerializerNamespaces к самому типу, а не используете его явно при вызове XmlSerializer.Serialize (). Это означает, что если экземпляр вашего типа сериализуется кодом, которым вы не владеете (например, в стеке веб-сервисов), и этот код явно не предоставляет XmlSerializerNamespaces, этот сериализатор будет использовать пространства имен, предоставленные в экземпляре.

ответил Cheeso 19 Mayam09 2009, 02:16:26

Похожие вопросы

Популярные теги

security × 330linux × 316macos × 2827 × 268performance × 244command-line × 241sql-server × 235joomla-3.x × 222java × 189c++ × 186windows × 180cisco × 168bash × 158c# × 142gmail × 139arduino-uno × 139javascript × 134ssh × 133seo × 132mysql × 132