System.Xml.Serialization.XmlSerializer クラス

この記事では、この API のリファレンス ドキュメントへの補足的な解説を提供します。

XML シリアル化とは、オブジェクトのパブリック プロパティとパブリック フィールドを格納したり伝送できるようにシリアル形式 (この場合は XML) に変換する処理のことです。 逆シリアル化とは、XML 出力から元の状態のオブジェクトを作り直すことです。 シリアル化は、オブジェクトの状態をストリームまたはバッファーに保存する方法と考えることができます。 たとえば、ASP.NET は、XmlSerializer クラスを使用して XML Web サービス メッセージをエンコードします。

オブジェクトのデータは、クラス、フィールド、プロパティ、プリミティブ型、配列などのプログラミング構成要素、および XmlElement オブジェクトまたは XmlAttribute オブジェクトの形で埋め込まれている XML を使用して記述されます。 属性で注釈を付けて独自のクラスを作成するか、または XML スキーマ定義ツール (Xsd.exe)を使用して、既存の XML スキーマ定義 (XSD) ドキュメントに基づいたクラスを生成できます。 XML スキーマがある場合は、Xsd.exe を実行して、そのスキーマに厳密に型指定された一連のクラスを生成し、シリアル化されるときにスキーマに準拠する属性を使用して注釈を付けることができます。

オブジェクトと XML の間でデータを転送するには、プログラミング言語コンストラクトから XML スキーマ、および XML スキーマからプログラミング言語コンストラクトへのマッピングが必要です。 XmlSerializer と Xsd.exe などの関連ツールは、設計時と実行時の両方でこれら 2 つのテクノロジ間の橋渡しを提供します。 デザイン時に、Xsd.exe を使用して、カスタム クラスから XML スキーマ ドキュメント (.xsd) を生成するか、特定のスキーマからクラスを生成します。 どちらの場合も、XML スキーマ システムと共通言語ランタイムの間でマップする方法を XmlSerializer に指示するカスタム属性でクラスに注釈が付けられます。 実行時に、クラスのインスタンスを、指定されたスキーマに従う XML ドキュメントにシリアル化できます。 同様に、これらの XML ドキュメントはランタイム オブジェクトに逆シリアル化できます。 XML スキーマは省略可能であり、デザイン時または実行時には必要ではありません。

生成された XML を制御する

生成された XML を制御するには、クラスとメンバーに特別な属性を適用します。 たとえば、別の XML 要素名を指定するには、パブリック フィールドまたはプロパティに XmlElementAttribute を適用し、ElementName プロパティを設定します。 類似する属性の完全な一覧については、「XML シリアル化を制御する属性」を参照してください。 また、XML 出力を制御する IXmlSerializable インターフェイスを実装することもできます。

生成された XML が World Wide Consortium ドキュメントのセクション 5、簡易オブジェクト アクセス プロトコル (SOAP) 1.1 に準拠している必要がある場合は、XmlTypeMapping を使用して XmlSerializer を構築する必要があります。 エンコードされた SOAP XML をさらに制御するには、「エンコード済み SOAP シリアル化を制御する属性」に記載されている属性を使用します。

XmlSerializer を使用すると、厳密に型指定されたクラスを使用して作業を行いながら、XML の柔軟性を利用できます。 厳密に型指定されたクラスで XmlElement、XmlAttribute、または XmlNode 型のフィールドまたはプロパティを使用すると、XML ドキュメントの一部を XML オブジェクトに直接読み込むことができます。

拡張 XML スキーマを使用する場合は、元のスキーマで見つからない要素または属性をシリアル化および逆シリアル化するために、XmlAnyElementAttribute および XmlAnyAttributeAttribute 属性を使用することもできます。 オブジェクトを使用するには、XmlElement オブジェクトの配列を返すフィールドに XmlAnyElementAttribute を適用するか、XmlAttribute オブジェクトの配列を返すフィールドに XmlAnyAttributeAttribute を適用します。

プロパティやフィールドが複雑なオブジェクト (配列やクラス インスタンスなど) を返す場合、XmlSerializer は、そのオブジェクトを、メイン XML ドキュメント内で入れ子になっている要素に変換します。 たとえば、次のコード例の最初のクラスは、2 番目のクラスのインスタンスを返します。

Public Class MyClass
    Public MyObjectProperty As MyObject
End Class

Public Class MyObject
    Public ObjectName As String
End Class

public class MyClass
{
    public MyObject MyObjectProperty;
}
public class MyObject
{
    public string ObjectName;
}

シリアル化された XML 出力は次のようになります。

<MyClass>
  <MyObjectProperty>
  <ObjectName>My String</ObjectName>
  </MyObjectProperty>
</MyClass>

スキーマに省略可能な要素 (minOccurs = '0') が含まれている場合、またはスキーマに既定値が含まれている場合は、2 つの選択肢があります。 選択肢の一つは、次のコードに示すように、 System.ComponentModel.DefaultValueAttribute を使用して既定値を指定することです。

Public Class PurchaseOrder
    <System.ComponentModel.DefaultValueAttribute ("2002")> _
    Public Year As String
End Class

public class PurchaseOrder
{
    [System.ComponentModel.DefaultValueAttribute ("2002")]
    public string Year;
}

もう一つの選択肢は、特別なパターンを使用して、XmlSerializer によって認識されるブール型フィールドを作成し、フィールドに XmlIgnoreAttribute を適用することです。 パターンは、propertyNameSpecified の形式で作成されます。 たとえば、"MyFirstName" という名前のフィールドがある場合は、"MyFirstNameSpecified" という名前のフィールドも作成し、"MyFirstName" という名前の XML 要素を生成するかどうかを XmlSerializer に指示します。 これを次の例に示します。

Public Class OptionalOrder
    ' This field's value should not be serialized
    ' if it is uninitialized.
    Public FirstOrder As String

    ' Use the XmlIgnoreAttribute to ignore the
    ' special field named "FirstOrderSpecified".
    <System.Xml.Serialization.XmlIgnoreAttribute> _
    Public FirstOrderSpecified As Boolean
End Class

public class OptionalOrder
{
    // This field should not be serialized
    // if it is uninitialized.
    public string FirstOrder;

    // Use the XmlIgnoreAttribute to ignore the
    // special field named "FirstOrderSpecified".
    [System.Xml.Serialization.XmlIgnoreAttribute]
    public bool FirstOrderSpecified;
}

既定のシリアル化をオーバーライドする

適切な属性の 1 つを作成し、XmlAttributes クラスのインスタンスに追加して、オブジェクトのセットとそのフィールドとプロパティのシリアル化をオーバーライドすることもできます。 この方法でシリアル化をオーバーライドすることには、2 つの用途があります。1 つは、ソースにアクセスできない場合でも、DLL で見つかったオブジェクトのシリアル化を制御および拡張できます。2 つ目は、シリアル化可能なクラスのセットを 1 つ作成できますが、複数の方法でオブジェクトをシリアル化できます。 詳細については、XmlAttributeOverrides クラス、および「方法: 派生クラスのシリアル化を制御する」を参照してください。

オブジェクトをシリアル化するには、Serialize メソッドを呼び出します。 オブジェクトを逆シリアル化するには、Deserialize メソッドを呼び出します。

XML ドキュメントに XML 名前空間を追加するには、XmlSerializerNamespaces を参照してください。

Note

XmlSerializer により、IEnumerable または ICollectionを実装するクラスに特別な処理が提供されます。 IEnumerable を実装するクラスは、単一のパラメーターを受け取るパブリックな Add メソッドを実装している必要があります。 Add メソッドのパラメーターは、GetEnumerator から返される値の Current プロパティから返されるのと同じ型であるか、その型の基底である必要があります。 IEnumerable に加えて ICollection (CollectionBase など) を実装するクラスには、整数を受け取るパブリック Item インデックス付きプロパティ (C# のインデクサー) が必要であり、整数型のパブリック Count プロパティが必要です。 Add メソッドのパラメーターは、Item プロパティから返されるのと同じ型、またはその型の基底のいずれかである必要があります。 ICollectionを実装するクラスの場合、シリアル化する値は、GetEnumerator を呼び出すのではなく、インデックス付き Item プロパティから取得されます。

オブジェクトを逆シリアル化するには、(TEMP 環境変数で定義されているように) 一時ディレクトリに書き込む権限が必要です。

動的に生成されたアセンブリ

パフォーマンスを向上させるために、XML シリアル化インフラストラクチャは、指定された型をシリアル化および逆シリアル化するアセンブリを動的に生成します。 インフラストラクチャにより、これらのアセンブリは検索され再利用されます。 この動作は、次のコンストラクターを使用する場合にのみ発生します。

XmlSerializer.XmlSerializer(Type)

XmlSerializer.XmlSerializer(Type, String)

他のコンストラクターのいずれかを使用すると、同じアセンブリの複数のバージョンが生成され、決してアンロードされないため、メモリ リークが発生してパフォーマンスが低下します。 最も簡単な解決策は、先ほど挙げた 2 つのコンストラクターのいずれかを使用することです。 それ以外の場合は、次の例に示すように、アセンブリを Hashtable にキャッシュする必要があります。

Hashtable serializers = new Hashtable();

// Use the constructor that takes a type and XmlRootAttribute.
XmlSerializer s = new XmlSerializer(typeof(MyClass), myRoot);

// Implement a method named GenerateKey that creates unique keys
// for each instance of the XmlSerializer. The code should take
// into account all parameters passed to the XmlSerializer
// constructor.
object key = GenerateKey(typeof(MyClass), myRoot);

// Check the local cache for a matching serializer.
XmlSerializer ser = (XmlSerializer)serializers[key];
if (ser == null)
{
    ser = new XmlSerializer(typeof(MyClass), myRoot);
    // Cache the serializer.
    serializers[key] = ser;
}

// Use the serializer to serialize or deserialize.

Dim serializers As New Hashtable()

' Use the constructor that takes a type and XmlRootAttribute.
Dim s As New XmlSerializer(GetType([MyClass]), myRoot)

' Implement a method named GenerateKey that creates unique keys
' for each instance of the XmlSerializer. The code should take
' into account all parameters passed to the XmlSerializer
' constructor.
Dim key As Object = GenerateKey(GetType([MyClass]), myRoot)

' Check the local cache for a matching serializer.
Dim ser As XmlSerializer = CType(serializers(key), XmlSerializer)

If ser Is Nothing Then
    ser = New XmlSerializer(GetType([MyClass]), myRoot)
    ' Cache the serializer.
    serializers(key) = ser
End If

' Use the serializer to serialize or deserialize.

ArrayList とジェネリック リストのシリアル化

XmlSerializer は、以下をシリアル化または逆シリアル化できません。

• ArrayList の配列
• List<T> の配列

unsigned Long の列挙型のシリアル化

次の条件に該当する場合、XmlSerializer をインスタンス化して列挙型をシリアル化することはできません。列挙型は unsigned long 型 (C# ではulong ) であり、列挙体には 9,223,372,036,854,775,807 より大きい値を持つメンバーが含まれています。 たとえば、次のコードをシリアル化することはできません。

public enum LargeNumbers: ulong
{
    a = 9223372036854775808
}
// At run time, the following code will fail.
xmlSerializer mySerializer=new XmlSerializer(typeof(LargeNumbers));

互換性のために残されている型

クラスは XmlSerializer 、として [Obsolete]マークされているオブジェクトをシリアル化しません。