XmlSerializer クラス

定義

public ref class XmlSerializer

public class XmlSerializer

type XmlSerializer = class

Public Class XmlSerializer

継承

Object

XmlSerializer

例

次の例には、 PurchaseOrder と Testの 2 つの主要なクラスが含まれています。 PurchaseOrder クラスには、1 回の購入に関する情報が含まれています。 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 + "'");
   }
}

Imports System.Xml
Imports System.Xml.Serialization
Imports 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 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


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


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
End Class


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
    
   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
    
   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
    
    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
        
    Private Sub serializer_UnknownNode(sender As Object, e As XmlNodeEventArgs)
        Console.WriteLine(("Unknown Node:" & e.Name & ControlChars.Tab & e.Text))
    End Sub
    
    
    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
End Class

注釈

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 runtime, the following code will fail.
xmlSerializer mySerializer=new XmlSerializer(typeof(LargeNumbers));

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

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

スレッド セーフ

この型はスレッド セーフです。

こちらもご覧ください

• XmlAttributeOverrides
• XmlAttributes
• XmlText
• XML シリアル化の概要
• 方法: XML ストリームの代替要素名を指定する
• 属性を使用した XML シリアル化の制御
• XML シリアル化の例
• XML スキーマ定義ツール (Xsd.exe)
• 方法: 派生クラスのシリアル化を制御する
• <dateTimeSerialization>Element
• <xmlSerializer> 要素