.Net XML серіалізація отриманих? [зачинено]

Я зіткнувся з декількома хетчами під час серіалізації C # XML, на яку я думав, що поділюсь:

• Ви не можете серіалізувати елементи, які доступні лише для читання (наприклад, KeyValuePairs)
• Ви не можете серіалізувати загальний словник. Натомість спробуйте цей клас обгортки (від http://weblogs.asp.net/pwelter34/archive/2006/05/03/444961.aspx ):

using System;
using System.Collections.Generic;
using System.Text;
using System.Xml.Serialization;

[XmlRoot("dictionary")]
public class SerializableDictionary<TKey, TValue> : Dictionary<TKey, TValue>, IXmlSerializable
{      
    public System.Xml.Schema.XmlSchema GetSchema()
    {
        return null;
    }

    public void ReadXml(System.Xml.XmlReader reader)
    {
        XmlSerializer keySerializer = new XmlSerializer(typeof(TKey));
        XmlSerializer valueSerializer = new XmlSerializer(typeof(TValue));

        bool wasEmpty = reader.IsEmptyElement;
        reader.Read();

        if (wasEmpty)
            return;

        while (reader.NodeType != System.Xml.XmlNodeType.EndElement)
        {
            reader.ReadStartElement("item");

            reader.ReadStartElement("key");
            TKey key = (TKey)keySerializer.Deserialize(reader);
            reader.ReadEndElement();

            reader.ReadStartElement("value");
            TValue value = (TValue)valueSerializer.Deserialize(reader);
            reader.ReadEndElement();

            this.Add(key, value);

            reader.ReadEndElement();
            reader.MoveToContent();
        }
        reader.ReadEndElement();
    }

    public void WriteXml(System.Xml.XmlWriter writer)
    {
        XmlSerializer keySerializer = new XmlSerializer(typeof(TKey));
        XmlSerializer valueSerializer = new XmlSerializer(typeof(TValue));

        foreach (TKey key in this.Keys)
        {
            writer.WriteStartElement("item");

            writer.WriteStartElement("key");
            keySerializer.Serialize(writer, key);
            writer.WriteEndElement();

            writer.WriteStartElement("value");
            TValue value = this[key];
            valueSerializer.Serialize(writer, value);
            writer.WriteEndElement();

            writer.WriteEndElement();
        }
    }
}

Будь-яка інша XML-серіалізація є там?

Ще одна величезна проблема: виводячи XML через веб-сторінку (ASP.NET), ви не хочете включати позначку байтового замовлення Unicode . Звичайно, способи використання або не використання BOM майже однакові:

BAD (включає BOM):

XmlTextWriter wr = new XmlTextWriter(stream, new System.Text.Encoding.UTF8);

ДОБРО:

XmlTextWriter  wr = new XmlTextWriter(stream, new System.Text.UTF8Encoding(false))

Ви можете явно передати помилкове значення, щоб вказати, що не хочете BOM. Зауважте чітку, очевидну різницю між Encoding.UTF8та UTF8Encoding.

Три додаткові байти BOM на початку - (0xEFBBBF) або (239 187 191).

Довідка: http://chrislaco.com/blog/troubleshooting-common-problems-with-the-xmlserializer/

Я поки не можу коментувати, тому я прокоментую допис Dr8k та ще одне зауваження. Приватні змінні, які піддаються публічним властивостям getter / setter і отримують серіалізацію / десеріалізацію як такі через ці властивості. Ми це робили на моїй старій роботі ще в той час.

Однак слід зазначити, що якщо у цих властивостях є якась логіка, логіка запускається, тому іноді порядок серіалізації насправді має значення. Члени є неявно упорядковуються тим, як вони упорядковані в коді, але гарантій немає, особливо коли ви успадковуєте інший об'єкт. Явно їх замовлення - це біль у тилу.

Мене це спалювало в минулому.

Під час серіалізації в XML-рядок із потоку пам’яті обов'язково використовуйте MemoryStream # ToArray () замість MemoryStream # GetBuffer (), інакше у вас з’являться непотрібні символи, які не десаріалізуються належним чином (через додатковий буфер).

http://msdn.microsoft.com/en-us/library/system.io.memorystream.getbuffer(VS.80).aspx

Якщо серіалізатор стикається з членом / властивістю, який має інтерфейс як свій тип, він не буде серіалізувати. Наприклад, наступне не буде серіалізуватись у XML:

public class ValuePair
{
    public ICompareable Value1 { get; set; }
    public ICompareable Value2 { get; set; }
}

Хоча це буде серіалізувати:

public class ValuePair
{
    public object Value1 { get; set; }
    public object Value2 { get; set; }
}

IEnumerables<T>які генеруються за рахунок прибутковості прибутковості, не піддаються серіалізації. Це пояснюється тим, що компілятор генерує окремий клас, щоб реалізувати віддачу, і цей клас не позначається як серіалізаційний.

Ви не можете серіалізувати властивості лише для читання. У вас повинні бути геттер і сеттер, навіть якщо ви ніколи не збираєтесь використовувати десяріалізацію для перетворення XML в об'єкт.

З тієї ж причини ви не можете серіалізувати властивості, що повертають інтерфейси: десеріалізатор не знатиме, який конкретний клас інстанціювати.

О, це добре: оскільки код серіалізації XML генерується та розміщується в окремій DLL, ви не отримуєте жодної суттєвої помилки, коли в коді є помилка, яка порушує серіалізатор. Щось на зразок "не вдається знайти s3d3fsdf.dll". Приємно.

Неможливо серіалізувати об'єкт, який не має параметричного конструктора (просто його покусав).

І чомусь із наведених нижче властивостей значення отримує серіалізацію, але не FullName:

    public string FullName { get; set; }
    public double Value { get; set; }

Я ніколи не стикався з розробкою чому, я просто змінив значення на внутрішнє ...

Ще одне, що слід зазначити: ви не можете серіалізувати приватних / захищених членів класу, якщо ви використовуєте серіалізацію XML "за замовчуванням".

Але ви можете вказати власну логіку серіалізації XML, реалізуючи IXmlSerializable у своєму класі, і серіалізувати будь-які приватні поля, які вам потрібні / потрібні.

http://msdn.microsoft.com/en-us/library/system.xml.serialization.ixmlserializable.aspx

Якщо збірка, створена XML-серіалізацією, не знаходиться в тому ж контексті завантаження, що і код, який намагається її використовувати, ви зіткнетеся з дивними помилками, такими як:

System.InvalidOperationException: There was an error generating the XML document.
---System.InvalidCastException: Unable to cast object
of type 'MyNamespace.Settings' to type 'MyNamespace.Settings'. at
Microsoft.Xml.Serialization.GeneratedAssembly.
  XmlSerializationWriterSettings.Write3_Settings(Object o)

Причиною цього для мене став плагін, завантажений за допомогою контексту LoadFrom, який має багато недоліків у використанні контексту Load. Досить весело відстежуючи це вниз.

Ви можете зіткнутися з проблемами серіалізації об'єктів типу Колір та / або Шрифт.

Ось поради, які допомогли мені:

http://www.codeproject.com/KB/XML/xmlsettings.aspx

http://www.codeproject.com/KB/cs/GenericXmlSerializition.aspx

Дивіться розділ « Advanced XML Schema Definition Language Атрибути Зв'язування підтримки » для деталей того , що підтримується XML Serializer і детальну інформацію про те , яким чином підтримуються підтримувані функції XSD.

Якщо ви спробуєте серіалізовать масив, List<T>або IEnumerable<T>який містить екземпляри підкласів з T, ви повинні використовувати XmlArrayItemAttribute до списку всіх підтипів використовуються. Інакше System.InvalidOperationExceptionпід час серіалізації ви отримаєте невикористаний під час виконання.

Ось частина повного прикладу з документації

public class Group
{  
   /* The XmlArrayItemAttribute allows the XmlSerializer to insert both the base 
      type (Employee) and derived type (Manager) into serialized arrays. */

   [XmlArrayItem(typeof(Manager)), XmlArrayItem(typeof(Employee))]
   public Employee[] Employees;

Приватні змінні / властивості не серіалізуються в механізмі за замовчуванням для серіалізації XML, але є у двійковій серіалізації.

Властивості, позначені Obsoleteатрибутом, не серіалізуються. Я не перевіряв Deprecatedатрибут, але я припускаю, що він би діяв так само.

Я справді не можу пояснити це, але я виявив, що це не буде серіалізувати:

[XmlElement("item")]
public myClass[] item
{
    get { return this.privateList.ToArray(); }
}

але це:

[XmlElement("item")]
public List<myClass> item
{
    get { return this.privateList; }
}

А також варто зауважити, що якщо ви серіалізуєте до пам’яті, ви, можливо, захочете скористатися 0, перш ніж використовувати його.

Будьте обережні, типи серіалізації без явної серіалізації, це може спричинити затримки під час .Net будує їх. Я виявив це нещодавно під час серіалізації RSAParameters .

Якщо ваш XSD використовує групи заміщення, то, швидше за все, ви не зможете (де) серіалізувати його автоматично. Вам потрібно буде написати власні серіалізатори для вирішення цього сценарію.

Напр.

<xs:complexType name="MessageType" abstract="true">
    <xs:attributeGroup ref="commonMessageAttributes"/>
</xs:complexType>

<xs:element name="Message" type="MessageType"/>

<xs:element name="Envelope">
    <xs:complexType mixed="false">
        <xs:complexContent mixed="false">
            <xs:element ref="Message" minOccurs="0" maxOccurs="unbounded"/>
        </xs:complexContent>
    </xs:complexType>
</xs:element>

<xs:element name="ExampleMessageA" substitutionGroup="Message">
    <xs:complexType mixed="false">
        <xs:complexContent mixed="false">
                <xs:attribute name="messageCode"/>
        </xs:complexContent>
    </xs:complexType>
</xs:element>

<xs:element name="ExampleMessageB" substitutionGroup="Message">
    <xs:complexType mixed="false">
        <xs:complexContent mixed="false">
                <xs:attribute name="messageCode"/>
        </xs:complexContent>
    </xs:complexType>
</xs:element>

У цьому прикладі конверт може містити Повідомлення. Однак серіалізатор .NET за замовчуванням не розрізняє повідомлення, ExampleMessageA та ExampleMessageB. Він буде серіалізуватися лише до та із базового класу повідомлень.

Приватні змінні / властивості не серіалізуються в серіалізації XML, а є у двійковій серіалізації.

Я вважаю, що це також отримує вас, якщо ви піддаєте приватних членів через публічну власність - приватні члени не серіалізуються, тому загальнодоступні члени посилаються на нульові значення.