オブジェクトから XML ドキュメントへのシリアル化および XML ドキュメントからオブジェクトへの逆シリアル化を行います。
XmlSerializer により、オブジェクトを XML にエンコードする方法を制御できます。
名前空間: System.Xml.Serialization
アセンブリ: System.Xml (system.xml.dll 内)
Public Class XmlSerializer
Dim instance As XmlSerializer
public class XmlSerializer
public ref class XmlSerializer
public class XmlSerializer
public class XmlSerializer
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 クラスのトピックを参照してください。
メモ |
|---|
| 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 でシリアル化または逆シリアル化することはできません。
2 つのメイン クラス、PurchaseOrder と Test が含まれている例を次に示します。PurchaseOrder クラスには、1 件の購入に関する情報が格納されています。Test クラスには発注書を作成するメソッドと、作成された発注書を読み取るメソッドが含まれています。
Imports System
Imports System.Xml
Imports System.Xml.Serialization
Imports System.IO
Imports Microsoft.VisualBasic
' The XmlRootAttribute allows you to set an alternate name
' (PurchaseOrder) of the XML element, the element namespace; by
' default, the XmlSerializer uses the class name. The attribute
' also allows you to set the XML namespace for the element. Lastly,
' the attribute sets the IsNullable property, which specifies whether
' the xsi:null attribute appears if the class instance is set to
' a null reference.
<XmlRootAttribute("PurchaseOrder", _
Namespace := "http://www.cpandl.com", IsNullable := False)> _
Public Class PurchaseOrder
Public ShipTo As Address
Public OrderDate As String
' The XmlArrayAttribute changes the XML element name
' from the default of "OrderedItems" to "Items".
<XmlArrayAttribute("Items")> _
Public OrderedItems() As OrderedItem
Public SubTotal As Decimal
Public ShipCost As Decimal
Public TotalCost As Decimal
End Class 'PurchaseOrder
Public Class Address
' The XmlAttribute instructs the XmlSerializer to serialize the Name
' field as an XML attribute instead of an XML element (the default
' behavior).
<XmlAttribute()> _
Public Name As String
Public Line1 As String
' Setting the IsNullable property to false instructs the
' XmlSerializer that the XML attribute will not appear if
' the City field is set to a null reference.
<XmlElementAttribute(IsNullable := False)> _
Public City As String
Public State As String
Public Zip As String
End Class 'Address
Public Class OrderedItem
Public ItemName As String
Public Description As String
Public UnitPrice As Decimal
Public Quantity As Integer
Public LineTotal As Decimal
' Calculate is a custom method that calculates the price per item,
' and stores the value in a field.
Public Sub Calculate()
LineTotal = UnitPrice * Quantity
End Sub 'Calculate
End Class 'OrderedItem
Public Class Test
Public Shared Sub Main()
' Read and write purchase orders.
Dim t As New Test()
t.CreatePO("po.xml")
t.ReadPO("po.xml")
End Sub 'Main
Private Sub CreatePO(filename As String)
' Create an instance of the XmlSerializer class;
' specify the type of object to serialize.
Dim serializer As New XmlSerializer(GetType(PurchaseOrder))
Dim writer As New StreamWriter(filename)
Dim po As New PurchaseOrder()
' Create an address to ship and bill to.
Dim billAddress As New Address()
billAddress.Name = "Teresa Atkinson"
billAddress.Line1 = "1 Main St."
billAddress.City = "AnyTown"
billAddress.State = "WA"
billAddress.Zip = "00000"
' Set ShipTo and BillTo to the same addressee.
po.ShipTo = billAddress
po.OrderDate = System.DateTime.Now.ToLongDateString()
' Create an OrderedItem object.
Dim i1 As New OrderedItem()
i1.ItemName = "Widget S"
i1.Description = "Small widget"
i1.UnitPrice = CDec(5.23)
i1.Quantity = 3
i1.Calculate()
' Insert the item into the array.
Dim items(0) As OrderedItem
items(0) = i1
po.OrderedItems = items
' Calculate the total cost.
Dim subTotal As New Decimal()
Dim oi As OrderedItem
For Each oi In items
subTotal += oi.LineTotal
Next oi
po.SubTotal = subTotal
po.ShipCost = CDec(12.51)
po.TotalCost = po.SubTotal + po.ShipCost
' Serialize the purchase order, and close the TextWriter.
serializer.Serialize(writer, po)
writer.Close()
End Sub 'CreatePO
Protected Sub ReadPO(filename As String)
' Create an instance of the XmlSerializer class;
' specify the type of object to be deserialized.
Dim serializer As New XmlSerializer(GetType(PurchaseOrder))
' If the XML document has been altered with unknown
' nodes or attributes, handle them with the
' UnknownNode and UnknownAttribute events.
AddHandler serializer.UnknownNode, AddressOf serializer_UnknownNode
AddHandler serializer.UnknownAttribute, AddressOf serializer_UnknownAttribute
' A FileStream is needed to read the XML document.
Dim fs As New FileStream(filename, FileMode.Open)
' Declare an object variable of the type to be deserialized.
Dim po As PurchaseOrder
' Use the Deserialize method to restore the object's state with
' data from the XML document.
po = CType(serializer.Deserialize(fs), PurchaseOrder)
' Read the order date.
Console.WriteLine(("OrderDate: " & po.OrderDate))
' Read the shipping address.
Dim shipTo As Address = po.ShipTo
ReadAddress(shipTo, "Ship To:")
' Read the list of ordered items.
Dim items As OrderedItem() = po.OrderedItems
Console.WriteLine("Items to be shipped:")
Dim oi As OrderedItem
For Each oi In items
Console.WriteLine((ControlChars.Tab & oi.ItemName & ControlChars.Tab & _
oi.Description & ControlChars.Tab & oi.UnitPrice & ControlChars.Tab & _
oi.Quantity & ControlChars.Tab & oi.LineTotal))
Next oi
' Read the subtotal, shipping cost, and total cost.
Console.WriteLine(( New String(ControlChars.Tab, 5) & _
" Subtotal" & ControlChars.Tab & po.SubTotal))
Console.WriteLine(New String(ControlChars.Tab, 5) & _
" Shipping" & ControlChars.Tab & po.ShipCost )
Console.WriteLine( New String(ControlChars.Tab, 5) & _
" Total" & New String(ControlChars.Tab, 2) & po.TotalCost)
End Sub 'ReadPO
Protected Sub ReadAddress(a As Address, label As String)
' Read the fields of the Address object.
Console.WriteLine(label)
Console.WriteLine(ControlChars.Tab & a.Name)
Console.WriteLine(ControlChars.Tab & a.Line1)
Console.WriteLine(ControlChars.Tab & a.City)
Console.WriteLine(ControlChars.Tab & a.State)
Console.WriteLine(ControlChars.Tab & a.Zip)
Console.WriteLine()
End Sub 'ReadAddress
Private Sub serializer_UnknownNode(sender As Object, e As XmlNodeEventArgs)
Console.WriteLine(("Unknown Node:" & e.Name & ControlChars.Tab & e.Text))
End Sub 'serializer_UnknownNode
Private Sub serializer_UnknownAttribute(sender As Object, e As XmlAttributeEventArgs)
Dim attr As System.Xml.XmlAttribute = e.Attr
Console.WriteLine(("Unknown attribute " & attr.Name & "='" & attr.Value & "'"))
End Sub 'serializer_UnknownAttribute
End Class 'Test
using System;
using System.Xml;
using System.Xml.Serialization;
using System.IO;
/* The XmlRootAttribute allows you to set an alternate name
(PurchaseOrder) of the XML element, the element namespace; by
default, the XmlSerializer uses the class name. The attribute
also allows you to set the XML namespace for the element. Lastly,
the attribute sets the IsNullable property, which specifies whether
the xsi:null attribute appears if the class instance is set to
a null reference. */
[XmlRootAttribute("PurchaseOrder", Namespace="http://www.cpandl.com",
IsNullable = false)]
public class PurchaseOrder
{
public Address ShipTo;
public string OrderDate;
/* The XmlArrayAttribute changes the XML element name
from the default of "OrderedItems" to "Items". */
[XmlArrayAttribute("Items")]
public OrderedItem[] OrderedItems;
public decimal SubTotal;
public decimal ShipCost;
public decimal TotalCost;
}
public class Address
{
/* The XmlAttribute instructs the XmlSerializer to serialize the Name
field as an XML attribute instead of an XML element (the default
behavior). */
[XmlAttribute]
public string Name;
public string Line1;
/* Setting the IsNullable property to false instructs the
XmlSerializer that the XML attribute will not appear if
the City field is set to a null reference. */
[XmlElementAttribute(IsNullable = false)]
public string City;
public string State;
public string Zip;
}
public class OrderedItem
{
public string ItemName;
public string Description;
public decimal UnitPrice;
public int Quantity;
public decimal LineTotal;
/* Calculate is a custom method that calculates the price per item,
and stores the value in a field. */
public void Calculate()
{
LineTotal = UnitPrice * Quantity;
}
}
public class Test
{
public static void Main()
{
// Read and write purchase orders.
Test t = new Test();
t.CreatePO("po.xml");
t.ReadPO("po.xml");
}
private void CreatePO(string filename)
{
// Create an instance of the XmlSerializer class;
// specify the type of object to serialize.
XmlSerializer serializer =
new XmlSerializer(typeof(PurchaseOrder));
TextWriter writer = new StreamWriter(filename);
PurchaseOrder po=new PurchaseOrder();
// Create an address to ship and bill to.
Address billAddress = new Address();
billAddress.Name = "Teresa Atkinson";
billAddress.Line1 = "1 Main St.";
billAddress.City = "AnyTown";
billAddress.State = "WA";
billAddress.Zip = "00000";
// Set ShipTo and BillTo to the same addressee.
po.ShipTo = billAddress;
po.OrderDate = System.DateTime.Now.ToLongDateString();
// Create an OrderedItem object.
OrderedItem i1 = new OrderedItem();
i1.ItemName = "Widget S";
i1.Description = "Small widget";
i1.UnitPrice = (decimal) 5.23;
i1.Quantity = 3;
i1.Calculate();
// Insert the item into the array.
OrderedItem [] items = {i1};
po.OrderedItems = items;
// Calculate the total cost.
decimal subTotal = new decimal();
foreach(OrderedItem oi in items)
{
subTotal += oi.LineTotal;
}
po.SubTotal = subTotal;
po.ShipCost = (decimal) 12.51;
po.TotalCost = po.SubTotal + po.ShipCost;
// Serialize the purchase order, and close the TextWriter.
serializer.Serialize(writer, po);
writer.Close();
}
protected void ReadPO(string filename)
{
// Create an instance of the XmlSerializer class;
// specify the type of object to be deserialized.
XmlSerializer serializer = new XmlSerializer(typeof(PurchaseOrder));
/* If the XML document has been altered with unknown
nodes or attributes, handle them with the
UnknownNode and UnknownAttribute events.*/
serializer.UnknownNode+= new
XmlNodeEventHandler(serializer_UnknownNode);
serializer.UnknownAttribute+= new
XmlAttributeEventHandler(serializer_UnknownAttribute);
// A FileStream is needed to read the XML document.
FileStream fs = new FileStream(filename, FileMode.Open);
// Declare an object variable of the type to be deserialized.
PurchaseOrder po;
/* Use the Deserialize method to restore the object's state with
data from the XML document. */
po = (PurchaseOrder) serializer.Deserialize(fs);
// Read the order date.
Console.WriteLine ("OrderDate: " + po.OrderDate);
// Read the shipping address.
Address shipTo = po.ShipTo;
ReadAddress(shipTo, "Ship To:");
// Read the list of ordered items.
OrderedItem [] items = po.OrderedItems;
Console.WriteLine("Items to be shipped:");
foreach(OrderedItem oi in items)
{
Console.WriteLine("\t"+
oi.ItemName + "\t" +
oi.Description + "\t" +
oi.UnitPrice + "\t" +
oi.Quantity + "\t" +
oi.LineTotal);
}
// Read the subtotal, shipping cost, and total cost.
Console.WriteLine("\t\t\t\t\t Subtotal\t" + po.SubTotal);
Console.WriteLine("\t\t\t\t\t Shipping\t" + po.ShipCost);
Console.WriteLine("\t\t\t\t\t Total\t\t" + po.TotalCost);
}
protected void ReadAddress(Address a, string label)
{
// Read the fields of the Address object.
Console.WriteLine(label);
Console.WriteLine("\t"+ a.Name );
Console.WriteLine("\t" + a.Line1);
Console.WriteLine("\t" + a.City);
Console.WriteLine("\t" + a.State);
Console.WriteLine("\t" + a.Zip );
Console.WriteLine();
}
private void serializer_UnknownNode
(object sender, XmlNodeEventArgs e)
{
Console.WriteLine("Unknown Node:" + e.Name + "\t" + e.Text);
}
private void serializer_UnknownAttribute
(object sender, XmlAttributeEventArgs e)
{
System.Xml.XmlAttribute attr = e.Attr;
Console.WriteLine("Unknown attribute " +
attr.Name + "='" + attr.Value + "'");
}
}
#using <System.Xml.dll>
#using <System.dll>
using namespace System;
using namespace System::Xml;
using namespace System::Xml::Serialization;
using namespace System::IO;
ref class Address;
ref class OrderedItem;
/* The XmlRootAttribute allows you to set an alternate name
(PurchaseOrder) of the XML element, the element namespace; by
default, the XmlSerializer uses the class name. The attribute
also allows you to set the XML namespace for the element. Lastly,
the attribute sets the IsNullable property, which specifies whether
the xsi:null attribute appears if the class instance is set to
a null reference. */
[XmlRootAttribute("PurchaseOrder",Namespace="http://www.cpandl.com",
IsNullable=false)]
public ref class PurchaseOrder
{
public:
Address^ ShipTo;
String^ OrderDate;
/* The XmlArrayAttribute changes the XML element name
from the default of "OrderedItems" to "Items". */
[XmlArrayAttribute("Items")]
array<OrderedItem^>^OrderedItems;
Decimal SubTotal;
Decimal ShipCost;
Decimal TotalCost;
};
public ref class Address
{
public:
/* The XmlAttribute instructs the XmlSerializer to serialize the Name
field as an XML attribute instead of an XML element (the default
behavior). */
[XmlAttributeAttribute]
String^ Name;
String^ Line1;
/* Setting the IsNullable property to false instructs the
XmlSerializer that the XML attribute will not appear if
the City field is set to a null reference. */
[XmlElementAttribute(IsNullable=false)]
String^ City;
String^ State;
String^ Zip;
};
public ref class OrderedItem
{
public:
String^ ItemName;
String^ Description;
Decimal UnitPrice;
int Quantity;
Decimal LineTotal;
/* Calculate is a custom method that calculates the price per item,
and stores the value in a field. */
void Calculate()
{
LineTotal = UnitPrice * Quantity;
}
};
public ref class Test
{
public:
static void main()
{
// Read and write purchase orders.
Test^ t = gcnew Test;
t->CreatePO( "po.xml" );
t->ReadPO( "po.xml" );
}
private:
void CreatePO( String^ filename )
{
// Create an instance of the XmlSerializer class;
// specify the type of object to serialize.
XmlSerializer^ serializer = gcnew XmlSerializer( PurchaseOrder::typeid );
TextWriter^ writer = gcnew StreamWriter( filename );
PurchaseOrder^ po = gcnew PurchaseOrder;
// Create an address to ship and bill to.
Address^ billAddress = gcnew Address;
billAddress->Name = "Teresa Atkinson";
billAddress->Line1 = "1 Main St.";
billAddress->City = "AnyTown";
billAddress->State = "WA";
billAddress->Zip = "00000";
// Set ShipTo and BillTo to the same addressee.
po->ShipTo = billAddress;
po->OrderDate = System::DateTime::Now.ToLongDateString();
// Create an OrderedItem object.
OrderedItem^ i1 = gcnew OrderedItem;
i1->ItemName = "Widget S";
i1->Description = "Small widget";
i1->UnitPrice = (Decimal)5.23;
i1->Quantity = 3;
i1->Calculate();
// Insert the item into the array.
array<OrderedItem^>^items = {i1};
po->OrderedItems = items;
// Calculate the total cost.
Decimal subTotal = Decimal(0);
System::Collections::IEnumerator^ myEnum = items->GetEnumerator();
while ( myEnum->MoveNext() )
{
OrderedItem^ oi = safe_cast<OrderedItem^>(myEnum->Current);
subTotal = subTotal + oi->LineTotal;
}
po->SubTotal = subTotal;
po->ShipCost = (Decimal)12.51;
po->TotalCost = po->SubTotal + po->ShipCost;
// Serialize the purchase order, and close the TextWriter.
serializer->Serialize( writer, po );
writer->Close();
}
protected:
void ReadPO( String^ filename )
{
// Create an instance of the XmlSerializer class;
// specify the type of object to be deserialized.
XmlSerializer^ serializer = gcnew XmlSerializer( PurchaseOrder::typeid );
/* If the XML document has been altered with unknown
nodes or attributes, handle them with the
UnknownNode and UnknownAttribute events.*/
serializer->UnknownNode += gcnew XmlNodeEventHandler( this, &Test::serializer_UnknownNode );
serializer->UnknownAttribute += gcnew XmlAttributeEventHandler( this, &Test::serializer_UnknownAttribute );
// A FileStream is needed to read the XML document.
FileStream^ fs = gcnew FileStream( filename,FileMode::Open );
// Declare an object variable of the type to be deserialized.
PurchaseOrder^ po;
/* Use the Deserialize method to restore the object's state with
data from the XML document. */
po = dynamic_cast<PurchaseOrder^>(serializer->Deserialize( fs ));
// Read the order date.
Console::WriteLine( "OrderDate: {0}", po->OrderDate );
// Read the shipping address.
Address^ shipTo = po->ShipTo;
ReadAddress( shipTo, "Ship To:" );
// Read the list of ordered items.
array<OrderedItem^>^items = po->OrderedItems;
Console::WriteLine( "Items to be shipped:" );
System::Collections::IEnumerator^ myEnum1 = items->GetEnumerator();
while ( myEnum1->MoveNext() )
{
OrderedItem^ oi = safe_cast<OrderedItem^>(myEnum1->Current);
Console::WriteLine( "\t{0}\t{1}\t{2}\t{3}\t{4}", oi->ItemName, oi->Description, oi->UnitPrice, oi->Quantity, oi->LineTotal );
}
Console::WriteLine( "\t\t\t\t\t Subtotal\t{0}", po->SubTotal );
Console::WriteLine( "\t\t\t\t\t Shipping\t{0}", po->ShipCost );
Console::WriteLine( "\t\t\t\t\t Total\t\t{0}", po->TotalCost );
}
void ReadAddress( Address^ a, String^ label )
{
// Read the fields of the Address object.
Console::WriteLine( label );
Console::WriteLine( "\t{0}", a->Name );
Console::WriteLine( "\t{0}", a->Line1 );
Console::WriteLine( "\t{0}", a->City );
Console::WriteLine( "\t{0}", a->State );
Console::WriteLine( "\t{0}", a->Zip );
Console::WriteLine();
}
private:
void serializer_UnknownNode( Object^ /*sender*/, XmlNodeEventArgs^ e )
{
Console::WriteLine( "Unknown Node:{0}\t{1}", e->Name, e->Text );
}
void serializer_UnknownAttribute( Object^ /*sender*/, XmlAttributeEventArgs^ e )
{
System::Xml::XmlAttribute^ attr = e->Attr;
Console::WriteLine( "Unknown attribute {0}='{1}'", attr->Name, attr->Value );
}
};
int main()
{
Test::main();
}
import System.*;
import System.Xml.*;
import System.Xml.Serialization.*;
import System.IO.*;
/* The XmlRootAttribute allows you to set an alternate name
(PurchaseOrder) of the XML element, the element namespace; by
default, the XmlSerializer uses the class name. The attribute
also allows you to set the XML namespace for the element. Lastly,
the attribute sets the IsNullable property, which specifies whether
the xsi:null attribute appears if the class instance is set to
a null reference. */
/** @attribute XmlRootAttribute("PurchaseOrder",
Namespace = "http://www.cpandl.com", IsNullable = false)
*/
public class PurchaseOrder
{
public Address shipTo;
public String orderDate;
/* The XmlArrayAttribute changes the XML element name
from the default of "OrderedItems" to "Items". */
/** @attribute XmlArrayAttribute("Items")
*/
public OrderedItem orderedItems[];
public System.Decimal subTotal;
public System.Decimal shipCost;
public System.Decimal totalCost;
} //PurchaseOrder
public class Address
{
/* The XmlAttribute instructs the XmlSerializer to serialize the Name
field as an XML attribute instead of an XML element (the default
behavior). */
/** @attribute XmlAttribute()
*/
public String name;
public String line1;
/* Setting the IsNullable property to false instructs the
XmlSerializer that the XML attribute will not appear if
the City field is set to a null reference. */
/** @attribute XmlElementAttribute(IsNullable = false)
*/
public String city;
public String state;
public String zip;
} //Address
public class OrderedItem
{
public String itemName;
public String description;
public System.Decimal unitPrice;
public int quantity;
public System.Decimal lineTotal;
/* Calculate is a custom method that calculates the price per item,
and stores the value in a field. */
public void Calculate()
{
lineTotal = Decimal.Multiply(unitPrice, Convert.ToDecimal(quantity));
} //Calculate
} //OrderedItem
public class Test
{
public static void main(String[] args)
{
// Read and write purchase orders.
Test t = new Test();
t.CreatePO("po.xml");
t.ReadPO("po.xml");
} //main
private void CreatePO(String fileName)
{
// Create an instance of the XmlSerializer class;
// specify the type of object to serialize.
XmlSerializer serializer =
new XmlSerializer(PurchaseOrder.class.ToType());
TextWriter writer = new StreamWriter(fileName);
PurchaseOrder po = new PurchaseOrder();
// Create an address to ship and bill to.
Address billAddress = new Address();
billAddress.name = "Teresa Atkinson";
billAddress.line1 = "1 Main St.";
billAddress.city = "AnyTown";
billAddress.state = "WA";
billAddress.zip = "00000";
// Set ShipTo and BillTo to the same addressee.
po.shipTo = billAddress;
po.orderDate = System.DateTime.get_Now().ToLongDateString();
// Create an OrderedItem object.
OrderedItem i1 = new OrderedItem();
i1.itemName = "Widget S";
i1.description = "Small widget";
i1.unitPrice = Convert.ToDecimal(5.23);
i1.quantity = 3;
i1.Calculate();
// Insert the item into the array.
OrderedItem items[] = { i1 };
po.orderedItems = items;
// Calculate the total cost.
System.Decimal subTotal = new System.Decimal();
for (int iCtr = 0; iCtr < items.length; iCtr++) {
OrderedItem oi = items[iCtr];
subTotal = Decimal.Add(subTotal, oi.lineTotal);
}
po.subTotal = subTotal;
po.shipCost = Convert.ToDecimal(12.51);
po.totalCost = Decimal.Add(po.subTotal, po.shipCost);
// Serialize the purchase order, and close the TextWriter.
serializer.Serialize(writer, po);
writer.Close();
} //CreatePO
protected void ReadPO(String fileName)
{
// Create an instance of the XmlSerializer class;
// specify the type of object to be deserialized.
XmlSerializer serializer =
new XmlSerializer(PurchaseOrder.class.ToType());
/* If the XML document has been altered with unknown
nodes or attributes, handle them with the
UnknownNode and UnknownAttribute events.*/
serializer.add_UnknownNode(
new XmlNodeEventHandler(Serializer_UnknownNode));
serializer.add_UnknownAttribute(
new XmlAttributeEventHandler(Serializer_UnknownAttribute));
// A FileStream is needed to read the XML document.
FileStream fs = new FileStream(fileName, FileMode.Open);
// Declare an object variable of the type to be deserialized.
PurchaseOrder po;
/* Use the Deserialize method to restore the object's state with
data from the XML document. */
po = (PurchaseOrder)serializer.Deserialize(fs);
// Read the order date.
Console.WriteLine("OrderDate: " + po.orderDate);
// Read the shipping address.
Address shipTo = po.shipTo;
ReadAddress(shipTo, "Ship To:");
// Read the list of ordered items.
OrderedItem items[] = po.orderedItems;
Console.WriteLine("Items to be shipped:");
for (int iCtr = 0; iCtr < items.length; iCtr++) {
OrderedItem oi = items[iCtr];
Console.WriteLine("\t" + oi.itemName + "\t"
+ oi.description + "\t" + oi.unitPrice + "\t"
+ oi.quantity + "\t" + oi.lineTotal);
}
// Read the subtotal, shipping cost, and total cost.
Console.WriteLine("\t\t\t\t\t Subtotal\t" + po.subTotal);
Console.WriteLine("\t\t\t\t\t Shipping\t" + po.shipCost);
Console.WriteLine("\t\t\t\t\t Total\t\t" + po.totalCost);
} //ReadPO
protected void ReadAddress(Address a, String label)
{
// Read the fields of the Address object.
Console.WriteLine(label);
Console.WriteLine("\t" + a.name);
Console.WriteLine("\t" + a.line1);
Console.WriteLine("\t" + a.city);
Console.WriteLine("\t" + a.state);
Console.WriteLine("\t" + a.zip);
Console.WriteLine();
} //ReadAddress
private void Serializer_UnknownNode(Object sender, XmlNodeEventArgs e)
{
Console.WriteLine("Unknown Node:" + e.get_Name() + "\t" + e.get_Text());
} //Serializer_UnknownNode
private void Serializer_UnknownAttribute(Object sender,
XmlAttributeEventArgs e)
{
System.Xml.XmlAttribute attr = e.get_Attr();
Console.WriteLine("Unknown attribute " + attr.get_Name() + "='"
+ attr.get_Value() + "'");
} //Serializer_UnknownAttribute
} //Test
System.Object
System.Xml.Serialization.XmlSerializer
この型は、マルチスレッド操作に対して安全です。
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。
.NET Framework
サポート対象 : 2.0、1.1、1.0
.NET Compact Framework
サポート対象 : 2.0