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 出力を制御することもできます。

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

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

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

プロパティまたはフィールドが複合オブジェクト (配列やクラス インスタンスなど) を返す場合、 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 つのオプションがあります。 1 つのオプションは、次のコードに示すように、 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;
}

もう 1 つのオプションは、特殊なパターンを使用して、 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 つの用途があります。最初に、ソースにアクセスできない場合でも、DLL で見つかったオブジェクトのシリアル化を制御および拡張できます。2 つ目は、シリアル化可能なクラスのセットを 1 つ作成できますが、複数の方法でオブジェクトをシリアル化できます。 詳細については、「 XmlAttributeOverrides クラス」および「 方法: 派生クラスのシリアル化を制御する」を参照してください。

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

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

オブジェクトを逆シリアル化するには、(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>の配列

符号なし Long の列挙型のシリアル化

次の条件に該当する場合、 XmlSerializer をインスタンス化して列挙型をシリアル化することはできません。列挙型は符号なし 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]としてマークされているオブジェクトをシリアル化しません。