.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シリアライゼーションはそこにありますか？

別の大きな落とし穴：Webページ（ASP.NET）を介してXMLを出力する場合、Unicode Byte-Order Markを含めたくないでしょう。もちろん、BOMを使用する方法と使用しない方法はほぼ同じです。

BAD（BOMを含む）：

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

良い：

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

明示的にfalseを渡して、BOMが不要であることを示すことができます。間に明確な、明白な違いに注意Encoding.UTF8してをUTF8Encoding。

先頭の3つの追加のBOMバイトは（0xEFBBBF）または（239 187 191）です。

リファレンス：http : //chrislaco.com/blog/troubleshooting-common-problems-with-the-xmlserializer/

まだコメントはできませんので、Dr8kの投稿にコメントし、再度観察します。パブリックゲッター/セッタープロパティとして公開され、それらのプロパティを通じてシリアル化/非シリアル化されるプライベート変数。私はいつも私の古い仕事でそれをしました。

ただし、これらのプロパティにロジックがある場合はロジックが実行されるため、シリアル化の順序が実際に重要になることがあります。メンバーはコード内での順序によって暗黙的に順序付けられますが、特に別のオブジェクトを継承している場合は保証されません。それらを明示的に注文することは、後部の苦痛です。

過去にこれでやけどをしたことがあります。

メモリストリームからXML文字列にシリアル化する場合は、MemoryStream＃GetBuffer（）ではなくMemoryStream＃ToArray（）を使用してください。そうしないと、余分なバッファーが割り当てられるため、適切に非直列化されないジャンク文字が発生します。

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>利回りリターンによって生成されたものはシリアル化できません。これは、コンパイラーがyield returnを実装する別のクラスを生成し、そのクラスがシリアライズ可能としてマークされていないためです。

読み取り専用プロパティをシリアル化することはできません。逆シリアル化を使用してXMLをオブジェクトに変換するつもりがない場合でも、ゲッターとセッターが必要です。

同じ理由で、インターフェイスを返すプロパティをシリアル化することはできません。デシリアライザはインスタンス化する具体的なクラスを認識しません。

ああ、これは良いことです。XMLシリアル化コードが生成されて別のDLLに配置されるので、シリアライザを破壊するコードに誤りがあっても、意味のあるエラーは発生しません。「s3d3fsdf.dllが見つかりません」のようなものです。いいね。

パラメータなしのコンストラクタを持たないオブジェクトにシリアル化できません（そのコンストラクタに噛まれただけです）。

そして、何らかの理由で、次のプロパティからValueはシリアル化されますが、FullNameはシリアル化されません。

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

理由を理解するために丸くなりませんでした。値を内部に変更しました...

注意すべきもう1つのこと：「デフォルト」のXMLシリアル化を使用している場合、プライベート/保護されたクラスメンバーをシリアル化することはできません。

ただし、クラスにIXmlSerializableを実装するカスタムXMLシリアル化ロジックを指定して、必要な/必要なプライベートフィールドをシリアル化できます。

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

XMLシリアル化によって生成されたアセンブリが、それを使用しようとするコードと同じLoadコンテキストにない場合、次のような素晴らしいエラーが発生します。

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コンテキストを使用することに対して多くの欠点があります。その1つを追跡するのはかなり楽しいです。

タイプがColorやFontのオブジェクトのシリアル化で問題が発生する場合があります。

ここに私を助けたアドバイスがあります：

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

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

XMLシリアライザがサポートする内容の詳細、およびサポートされているXSD機能がサポートされる方法の詳細については、「高度なXMLスキーマ定義言語の属性バインディングサポート」を参照してください。

配列、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; }
}

また、memstreamにシリアル化する場合は、使用する前に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を区別しません。基本のMessageクラスとの間でのみシリアル化されます。

プライベート変数/プロパティは、XMLシリアル化ではシリアル化されませんが、バイナリシリアル化されます。

パブリックプロパティを介してプライベートメンバーを公開している場合にも、これが役立つと思います。プライベートメンバーはシリアル化されないため、パブリックメンバーはすべてnull値を参照しています。