XML シリアル化とは、オブジェクトのパブリック プロパティとパブリック フィールドを格納したり伝送できるようにシリアル形式 (この場合は XML) に変換する処理のことです。逆シリアル化とは、その XML 出力から元の状態のオブジェクトを作り直すことです。したがって、シリアル化はオブジェクトの状態をストリームまたはバッファに保存しておく方法の 1 つと考えることができます。たとえば、ASP.NET では、XmlSerializer クラスを使用して Web サービス メッセージをエンコードします。
オブジェクトのデータは、クラス、フィールド、プロパティ、プリミティブ型、配列などのプログラミング構成要素、および XmlElement オブジェクトまたは XmlAttribute オブジェクトの形で埋め込まれている XML を使用して記述されます。属性で注釈を付けて独自のクラスを作成するか、XML スキーマ定義ツール (Xsd.exe) を使用して既存の XML スキーマ定義 (XSD: XML Schema Definition) ドキュメントに基づいたクラスを作成できます。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 シリアル化を制御する属性」を参照してください。IXmlSerializable インターフェイスを実装して、XML 出力を制御することもできます。
生成される XML が、W3C (World Wide Web Consortium) (www.w3.org) のドキュメント『Simple Object Access Protocol (SOAP) 1.1』のセクション 5 に準拠している必要がある場合は、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 つのオプションがあります。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 が認識する Boolean フィールドを作成し、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 にアクセスしなくても、DLL 内のオブジェクトのシリアル化の制御および増大ができます。第 2 に、シリアル化できるクラスを 1 セット作成し、オブジェクトを複数の方法でシリアル化できます。詳細については、XmlAttributeOverrides クラスのトピックおよび「方法 : 派生クラスのシリアル化を制御する」を参照してください。
オブジェクトをシリアル化するには、Serialize メソッドを呼び出します。オブジェクトを逆シリアル化するには、Deserialize メソッドを呼び出します。
XML ドキュメントに XML 名前空間を追加する方法については、XmlSerializerNamespaces クラスのトピックを参照してください。
.gif) メモ |
|---|
| XmlSerializer は、IEnumerable または ICollection を実装するクラスは特別に対処します。IEnumerable を実装するクラスは、1 つのパラメータを受け取るパブリックな Add メソッドを実装している必要があります。Add メソッドのパラメータは、GetEnumerator から返された値の Current プロパティから返された型と同じであるか、またはその型の基本型の 1 つであることが必要です。IEnumerable に加えて ICollection (CollectionBase など) を実装しているクラスは、整数を受け取るパブリックな Item インデックス付きプロパティ (C# のインデクサ) および整数型のパブリック Count プロパティを持っている必要があります。Add メソッドのパラメータは、Item プロパティから返された型か、その型の基本型の 1 つと同じ型であることが必要です。ICollection を実装するクラスの場合、シリアル化する値は GetEnumerator を呼び出して取得するのではなく、インデックス付き Item プロパティから取得します。 |
オブジェクトを逆シリアル化するには、一時ディレクトリ (TEMP 環境変数で定義) に書き込むためのアクセス許可が必要です。
動的に生成されるアセンブリ
パフォーマンスを向上するために、XML シリアル化インフラストラクチャでは、指定した型のシリアル化と逆シリアル化を行うアセンブリが動的に生成されます。それらのアセンブリはインフラストラクチャによって検索および再利用されます。この動作は、次のコンストラクタを使用するときにだけ発生します。
System.Xml.Serialization.XmlSerializer(Type)
System.Xml.Serialization.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;
}
else
{
// 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
Else
' Use the serializer to serialize, or deserialize.
End If
ArrayList およびジェネリック リストのシリアル化
次のようなデータについては、XmlSerializer でシリアル化または逆シリアル化することはできません。