XMLSerializer を使用してオブジェクトを XML にシリアル化する

Microsoft はシリアル化されたデータの重要性を認識しているため、.NET フレームワークには、シリアル化機能を提供し、ユーザーが独自のシリアル化メソッドを作成できる機能を提供する名前空間 System.Runtime.Serialization と System.xml.Serialization が含まれています。 System.Xml.Serialization 名前空間は、オブジェクトを XML 形式にシリアル化するための基本的なメソッドを提供します。このメソッドの使用方法を見てみましょう。

XML の魅力

シリアル化 XML とは、保存や送信を容易にするために、オブジェクトのパブリック フィールドと属性をシリアル形式 (ここでは XML 形式) に保存するプロセスを指します。逆シリアル化は、シリアル状態情報を使用して、オブジェクトをシリアル XML 状態から元の状態に復元するプロセスです。したがって、シリアル化は、オブジェクトの状態をストリームまたはバッファーに保存する方法と考えることができます。

シリアル化の目的は、データの保存とデータ変換です。データ ストレージとは、ユーザー セッション間でデータを保存することを指します。アプリケーションが閉じられると、データは保存 (シリアル化) され、ユーザーが戻ってくると、データは再ロード (逆シリアル化) されます。データ変換とは、データを別のシステムが理解できる形式に変換することを指します。シリアル化とXMLを利用することで、データ変換を簡単に行うことができます。

オブジェクト内のデータは、クラス、メソッド、プロパティ、プライベート型、配列にすることができ、System.Xml.XmlElement オブジェクトや System.Xml.XmlAttribute オブジェクトでは、埋め込み XML にすることもできます。

System.Xml.Serialization 名前空間のキー クラスは XmlSerializer です。もちろん、この名前空間には XML や SOAP の他の側面に関連する他のクラスも含まれていますが、ここでは XmlSerializer クラスに焦点を当てます。

XmlSerializer
XmlSerializer クラスは、オブジェクトを XML ファイルにシリアル化し、XML ドキュメントをオブジェクトに逆シリアル化するメソッドを提供します。また、ユーザーはオブジェクトを XML に変換する方法を指定することもできます。シリアル化するオブジェクトの型をパラメータとしてクラス コンストラクターに渡すことができます。次の C# コードは、コンストラクターの使用法を示しています。

    XmlSerializer ser = new XmlSerializer(typeof(objectToSerialize));

以下は同等の VB.NET コードです:

    Dim ser As New XmlSerializer(GetType(objectToSerialize))

実際のシリアル化プロセスは、XmlSerializer クラスの Serialize メソッドに実装されます。このメソッドを使用すると、シリアル化中に TextWriter、Stream、および XmlWriter オブジェクトを呼び出すことができます。次のコード例は、このメソッドを呼び出す方法を示しています。この例では、オブジェクトがシリアル化され、ローカル ディスク上のファイルに保存されます。この例はクラス宣言で始まり、その後にシリアル化されたソース コードが続きます。

using System;
namespace BuilderSerialization {
public class Address {
public Address() {}
public string Address1;
public string Address2;
public string City;
public string State;
public string Zip;
public string Country;
} }
using System;
namespace BuilderSerialization {
public class Author {
public Author() { }
public string FirstName;
public string MiddleName;
public string LastName;
public string Title;
public string Gender;
public Address AddressObject;
} }
namespace BuilderSerialization {
public class Book {
public Book() { }
public string Title;
public Author AuthorObject;
public string ISBN;
public double RetailPRice;
public string Publisher;
}}
using System;
using System.Xml.Serialization;
using System.IO;
namespace BuilderSerialization {
class TestClass {
static void Main(string[] args) {
Book BookObject = new Book();
XmlSerializer ser = new XmlSerializer(typeof(Book));
TextWriter writer = new StreamWriter("booktest.xml");
BookObject.Title = "Practical LotusScript";
BookObject.ISBN = "1884777767 ";
BookObject.Publisher = "Manning Publications";
BookObject.RetailPrice = 43.95;
BookObject.AuthorObject = new Author();
BookObject.AuthorObject.FirstName = "Tony";
BookObject.AuthorObject.LastName = "Patton";
BookObject.AuthorObject.Gender = "Male";
BookObject.AuthorObject.AddressObject = new Address();
BookObject.AuthorObject.AddressObject.Address1 = "1 Main Street";
BookObject.AuthorObject.AddressObject.City = "Anywhere";
BookObject.AuthorObject.AddressObject.State = "KY";
BookObject.AuthorObject.AddressObject.Zip = "40000";
BookObject.AuthorObject.AddressObject.Country = "USA";
ser.Serialize(writer, BookObject);
writer.Close();
} } }

上記のコードは 3 つのオブジェクトを 1 つのオブジェクトに変換し、シリアル化プロセス中に XML ファイルを生成します。以下は、サンプル プログラムによって生成された XML ドキュメントです。

<?xml version="1.0" encoding="utf-8"?>
<Book xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Title>Practical LotusScript</Title>
<AuthorObject>
<FirstName>Tony</FirstName>
<LastName>Patton</LastName>
<Gender>Male</Gender>
<AddressObject>
<Address1>1 Main Street</Address1>
<City>Anywhere</City>
<State>KY</State>
<Zip>40000</Zip>
<Country>USA</Country>
</AddressObject>
</AuthorObject>
<ISBN>1884777767 </ISBN>
<RetailPrice>43.95</RetailPrice>
<Publisher>Manning Publications</Publisher>
</Book>

シリアル化プロセスでは、オブジェクト データのネストも処理できることに注意してください。データは認識可能な形式に変換されるため、データの再ロード (逆シリアル化) や別のシステムへのデータ転送が容易になります。データ転送プロセス中に、受信システムは XML ファイルの形式を知る必要があります (事前に知らない場合)。したがって、XML スキーマ ファイルを提供する必要があります。 .NET Framework の XSD.exe ツールは、シリアル化された XML のスキーマ ファイルを生成できます。

以下は VB.NET で書かれたコード例です:

Public Class Address
Public Address1 As String
Public Address2 As String
Public City As String
Public State As String
Public Zip As String
Public Country As String
End Class
Public Class Author
Public FirstName As String
Public MiddleName As String
Public LastName As String
Public Title As String
Public Gender As String
Public AddressObject As Address
End Class
Public Class Book
Public AuthorObject As Author
Public Title As String
Public ISBN As String
Public RetailPrice As Double
Public Publisher As String
End Class
Imports System.Xml.Serialization
Imports System.IO
Module Module1
Sub Main()
Dim BookObject As New Book
Dim ser As New XmlSerializer(GetType(Book))
Dim writer As New StreamWriter("booktest.xml")
With BookObject
.Title = "Practical LotusScript"
.ISBN = "1884777767 "
.Publisher = "Manning Publications"
.RetailPrice = 43.95
.AuthorObject = New Author
.AuthorObject.FirstName = "Tony"
.AuthorObject.LastName = "Patton"
.AuthorObject.Gender = "Male"
.AuthorObject.AddressObject = New Address
.AuthorObject.AddressObject.Address1 = "1 Main Street"
.AuthorObject.AddressObject.City = "Anywhere"
.AuthorObject.AddressObject.State = "KY"
.AuthorObject.AddressObject.Zip = "40000"
.AuthorObject.AddressObject.Country = "USA"
End With
ser.Serialize(writer, BookObject)
writer.Close()
End Sub
End Module

出力制御

シリアル化プロセスにより標準 XML ファイルが生成され、データ メンバーが XML 要素に変換されます。ただし、すべてのデータ メンバーが要素になるわけではありません。クラス コードにいくつかのタグを追加することで、出力 XML ファイルを制御できます。このようにして、データ メンバーを要素ではなく XML 属性に変換したり、単純に無視したりすることができます。次の例は、ブック クラスの VB.NET コードを変更したものです。

Public Class Book
Public AuthorObject As Author
Public Title As String
<System.Xml.Serialization.XmlAttribute()> _
Public ISBN As String
<System.Xml.Serialization.XmlIgnoreAttribute()> _
Public RetailPrice As Double
Public Publisher As String
End Class

このコードは、XML ファイルの生成時にクラス メンバー ISBN を XML 属性として使用するようにシステムに指示しますが、RetailPrice メンバーは無視します。この変更は、生成された XML ファイルで確認できます:

<?xml version="1.0" encoding="utf-8"?>
<Book xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" ISBN="1884777767 ">
<AuthorObject>
<FirstName>Tony</FirstName>
<LastName>Patton</LastName>
<Gender>Male</Gender>
<AddressObject>
<Address1>1 Main Street</Address1>
<City>Anywhere</City>
<State>KY</State>
<Zip>40000</Zip>
<Country>USA</Country>
</AddressObject>
</AuthorObject>
<Title>Practical LotusScript</Title>
<Publisher>Manning Publications</Publisher>
</Book>

以下は、対応する C# コードです:

public class Book {
public Book() { }
public string Title;
public Author AuthorObject;
[System.Xml.Serialization.XmlAttribute()]
public string ISBN;
[System.Xml.Serialization.XmlIgnoreAttribute()]
public double RetailPrice;
public string Publisher;
}

2 つのマークアップ シンボルについては、上で少しだけ触れています。完全なマークアップ表記については、.NET ドキュメントを参照してください。

逆シリアル化
逆シリアル化されたデータは、XmlSerializer クラスの Deserialize メソッドを呼び出すことで簡単に実装できます。次の VB.NET プログラム フラグメントは、上記の XML ドキュメントの逆シリアル化を完了します:

Dim BookObject As New Book
Dim ser As New XmlSerializer(GetType(Book))
Dim fs As New System.IO.FileStream("booktest.xml", FileMode.Open)
Dim reader As New System.XML.XmlTextReader(fs)
BookObject = CType(ser.Deserialize(reader), Book)
该程序把结果数据放入内存备用。下面是等价的C# 代码：
XmlSerializer ser = new XmlSerializer(typeof(Book));
System.IO.FileStreamfs = new System.IO.FileStream("booktest.xml",
FileMode.Open);
System.Xml.XmlTextReader reader = new System.Xml.XmlTextReader(fs);
Book BookObject = (Book)(ser.Deserialize(reader));

上記は、XMLSerializer を使用してオブジェクトを XML にシリアル化する内容です。さらに関連する内容については、PHP 中国語 Web サイト (www. php.cn )!