XmlSerializer Класс

Определение

Сериализует и десериализует объекты в XML-документы и из них.Serializes and deserializes objects into and from XML documents. XmlSerializer позволяет контролировать способ кодирования объектов в XML.The XmlSerializer enables you to control how objects are encoded into XML.

public ref class XmlSerializer
public class XmlSerializer
type XmlSerializer = class
Public Class XmlSerializer
Наследование
XmlSerializer

Примеры

Следующий пример содержит два основных класса: PurchaseOrder и Test.The following example contains two main classes: PurchaseOrder and Test. Класс PurchaseOrder содержит сведения об отдельной покупке.The PurchaseOrder class contains information about a single purchase. Класс Test содержит методы, создающие заказ на покупку и считывающие созданный заказ на покупку.The Test class contains the methods that create the purchase order, and that read the created purchase order.

#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();
}
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 serialization is the process of converting an object's public properties and fields to a serial format (in this case, XML) for storage or transport. При десериализации объект повторно создается в исходном состоянии из выходных данных XML.Deserialization re-creates the object in its original state from the XML output. Сериализацию можно представить как способ сохранения состояния объекта в поток или буфер.You can think of serialization as a way of saving the state of an object into a stream or buffer. Например, ASP.NET использует класс XmlSerializer для кодирования сообщений веб-службы XML.For example, ASP.NET uses the XmlSerializer class to encode XML Web service messages.

Данные в объектах описываются с помощью конструкций языка программирования, например классов, полей, свойств, типов-примитивов, массивов и даже встроенного XML в форме объектов XmlElement или XmlAttribute.The data in your objects is described using programming language constructs like classes, fields, properties, primitive types, arrays, and even embedded XML in the form of XmlElement or XmlAttribute objects. Вы можете создавать собственные классы, закомментировать их атрибутами или используя средство определения схемы XML (XSD. exe) для создания классов на основе существующего документа определения схемы XML (XSD).You have the option of creating your own classes, annotated with attributes, or using the XML Schema Definition Tool (Xsd.exe) to generate the classes based on an existing XML Schema definition (XSD) document. При наличии схемы XML можно запустить XSD. exe, чтобы создать набор классов, строго типизированных в схему, и добавить к ним атрибуты, которые будут соответствовать схеме при сериализации.If you have an XML Schema, you can run the Xsd.exe to produce a set of classes that are strongly typed to the schema and annotated with attributes to adhere to the schema when serialized.

Для перемещения данных между объектами и XML требуется сопоставление из конструкций языка программирования с XML-схемой и из схемы XML в конструкции языка программирования.To transfer data between objects and XML requires a mapping from the programming language constructs to XML schema and from the XML schema to the programming language constructs. XmlSerializer и связанные с ними средства, такие как XSD. exe, предоставляют мост между этими двумя технологиями как во время разработки, так и в среде выполнения.The XmlSerializer and related tools like Xsd.exe provide the bridge between these two technologies at both design time and runtime. Во время разработки используйте XSD. exe для создания документа схемы XML (XSD) из пользовательских классов или для создания классов из заданной схемы.At design time, use the Xsd.exe to produce an XML schema document (.xsd) from your custom classes or to produce classes from a given schema. В любом случае классы снабжаются с помощью настраиваемых атрибутов, чтобы указать XmlSerializer, как сопоставлять систему XML-схем и среду CLR.In either case, the classes are annotated with custom attributes to instruct the XmlSerializer how to map between the XML schema system and the common language runtime. Во время выполнения экземпляры классов могут быть сериализованы в XML-документы, следующие за заданной схемой.At runtime, instances of the classes can be serialized into XML documents that follow the given schema. Аналогичным образом эти XML-документы можно десериализовать в объекты среды выполнения.Likewise, these XML documents can be deserialized into runtime objects. Обратите внимание, что схема XML является необязательной и не требуется во время разработки или в среде выполнения.Note that the XML schema is optional, and not required at design time or runtime.

Управление созданным XMLControlling Generated XML

Для управления созданным XML можно применять специальные атрибуты к классам и членам.To control the generated XML, you can apply special attributes to classes and members. Например, чтобы указать другое имя XML-элемента, примените XmlElementAttribute к открытому полю или свойству и задайте свойство ElementName.For example, to specify a different XML element name, apply an XmlElementAttribute to a public field or property, and set the ElementName property. Полный список схожих атрибутов см. в разделе атрибуты, управляющие СЕРИАЛИЗАЦИЕЙ XML.For a complete list of similar attributes, see Attributes That Control XML Serialization. Можно также реализовать интерфейс IXmlSerializable для управления выходными данными в формате XML.You can also implement the IXmlSerializable interface to control the XML output.

Если созданный XML-код должен соответствовать разделу 5 документа консорциума World, протоколу SOAP 1,1, необходимо создать XmlSerializer с XmlTypeMapping.If the XML generated must conform to section 5 of the World Wide Consortium document, Simple Object Access Protocol (SOAP) 1.1, you must construct the XmlSerializer with an XmlTypeMapping. Для дальнейшего управления кодированными SOAP XML используйте атрибуты, перечисленные в атрибутах, которые управляют кодированной СЕРИАЛИЗАЦИЕЙ SOAP.To further control the encoded SOAP XML, use the attributes listed in Attributes That Control Encoded SOAP Serialization.

С XmlSerializer можно воспользоваться преимуществами работы со строго типизированными классами и обеспечить гибкость XML.With the XmlSerializer you can take advantage of working with strongly typed classes and still have the flexibility of XML. Используя поля или свойства типа XmlElement, XmlAttribute или XmlNode в строго типизированных классах, можно считывать части XML-документа непосредственно в объекты XML.Using fields or properties of type XmlElement, XmlAttribute or XmlNode in your strongly typed classes, you can read parts of the XML document directly into XML objects.

При работе с расширяемыми XML-схемами можно также использовать атрибуты XmlAnyElementAttribute и XmlAnyAttributeAttribute для сериализации и десериализации элементов или атрибутов, не найденных в исходной схеме.If you work with extensible XML schemas, you can also use the XmlAnyElementAttribute and XmlAnyAttributeAttribute attributes to serialize and deserialize elements or attributes that are not found in the original schema. Чтобы использовать объекты, примените XmlAnyElementAttribute к полю, которое возвращает массив объектов XmlElement, или примените XmlAnyAttributeAttribute к полю, которое возвращает массив объектов XmlAttribute.To use the objects, apply an XmlAnyElementAttribute to a field that returns an array of XmlElement objects, or apply an XmlAnyAttributeAttribute to a field that returns an array of XmlAttribute objects.

Если свойство или поле возвращает сложный объект (например, массив или экземпляр класса), XmlSerializer преобразует его в элемент, вложенный в рамках основного документа XML.If a property or field returns a complex object (such as an array or a class instance), the XmlSerializer converts it to an element nested within the main XML document. Например, первый класс в следующем коде возвращает экземпляр второго класса.For example, the first class in the following code returns an instance of the second class.

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 выглядят следующим образом:The serialized, XML output looks like this:

<MyClass>  
  <MyObjectProperty>  
  <ObjectName>My String</ObjectName>  
  </MyObjectProperty>  
</MyClass>  

Если схема включает элемент, который является необязательным (minOccurs = ' 0 '), или если схема содержит значение по умолчанию, у вас есть два варианта.If a schema includes an element that is optional (minOccurs = '0'), or if the schema includes a default value, you have two options. Один из вариантов — использовать System.ComponentModel.DefaultValueAttribute, чтобы указать значение по умолчанию, как показано в следующем коде.One option is to use System.ComponentModel.DefaultValueAttribute to specify the default value, as shown in the following code.

Public Class PurchaseOrder  
    <System.ComponentModel.DefaultValueAttribute ("2002")> _  
    Public Year As String  
End Class  
public class PurchaseOrder  
{  
    [System.ComponentModel.DefaultValueAttribute ("2002")]  
    public string Year;  
}  

Другой вариант — использовать специальный шаблон для создания логического поля, распознаваемого XmlSerializer, и для применения XmlIgnoreAttribute к полю.Another option is to use a special pattern to create a Boolean field recognized by the XmlSerializer, and to apply the XmlIgnoreAttribute to the field. Шаблон создается в виде propertyNameSpecified.The pattern is created in the form of propertyNameSpecified. Например, если имеется поле с именем "Мифирстнаме", вы также создадите поле с именем "МифирстнамеспеЦифиед", которое указывает XmlSerializer, следует ли создавать XML-элемент с именем "Мифирстнаме".For example, if there is a field named "MyFirstName" you would also create a field named "MyFirstNameSpecified" that instructs the XmlSerializer whether to generate the XML element named "MyFirstName". Эти действия показаны в следующем примере.This is shown in the following example.

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;  
}  

Переопределение сериализации по умолчаниюOverriding Default Serialization

Можно также переопределить сериализацию любого набора объектов, их полей и свойств, создав один из соответствующих атрибутов и добавив их в экземпляр класса XmlAttributes.You can also override the serialization of any set of objects and their fields and properties by creating one of the appropriate attributes, and adding it to an instance of the XmlAttributes class. Переопределение сериализации таким способом имеет два использования: сначала можно управлять и дополнять сериализацию объектов, найденных в библиотеке DLL, даже если у вас нет доступа к источнику. Во вторых, можно создать один набор сериализуемых классов, но сериализовать объекты несколькими способами.Overriding serialization in this way has two uses: first, you can control and augment the serialization of objects found in a DLL, even if you do not have access to the source; second, you can create one set of serializable classes, but serialize the objects in multiple ways. Дополнительные сведения см. в разделе класс XmlAttributeOverrides и инструкции: Управление сериализацией производных классов.For more details, see the XmlAttributeOverrides class and How to: Control Serialization of Derived Classes.

Чтобы сериализовать объект, вызовите метод Serialize.To serialize an object, call the Serialize method. Чтобы десериализовать объект, вызовите метод Deserialize.To deserialize an object, call the Deserialize method.

Сведения о добавлении пространств имен XML в XML-документ см. в разделе XmlSerializerNamespaces.To add XML namespaces to an XML document, see XmlSerializerNamespaces.

Примечание

XmlSerializer предоставляет особую обработку для классов, реализующих IEnumerable или ICollection.The XmlSerializer gives special treatment to classes that implement IEnumerable or ICollection. Класс, реализующий IEnumerable, должен реализовывать открытый метод Add, принимающий один параметр.A class that implements IEnumerable must implement a public Add method that takes a single parameter. Параметр метода Add должен иметь тот же тип, что и возвращенный из свойства Current значения, возвращаемого GetEnumerator, или одного из базовых типов.The Add method's parameter must be of the same type as is returned from the Current property on the value returned from GetEnumerator, or one of that type's bases. Класс, реализующий ICollection (например, CollectionBase) в дополнение к IEnumerable должен иметь открытое Item индексированное свойство (индексатор в C#), которое принимает целое число и должно иметь открытое свойство Count типа Integer.A class that implements ICollection (such as CollectionBase) in addition to IEnumerable must have a public Item indexed property (indexer in C#) that takes an integer, and it must have a public Count property of type integer. Параметр метода Add должен иметь тот же тип, что и возвращаемый свойством Item, или один из базовых типов.The parameter to the Add method must be the same type as is returned from the Item property, or one of that type's bases. Для классов, реализующих ICollection, значения для сериализации извлекаются из свойства индексированного Item, а не путем вызова GetEnumerator.For classes that implement ICollection, values to be serialized are retrieved from the indexed Item property, not by calling GetEnumerator.

Для десериализации объекта необходимо иметь разрешение на запись во временный каталог (как определено переменной среды TEMP).You must have permission to write to the temporary directory (as defined by the TEMP environment variable) to deserialize an object.

Динамически создаваемые сборкиDynamically Generated Assemblies

Для повышения производительности инфраструктура сериализации XML динамически создает сборки для сериализации и десериализации указанных типов.To increase performance, the XML serialization infrastructure dynamically generates assemblies to serialize and deserialize specified types. Инфраструктура находит и повторно использует эти сборки.The infrastructure finds and reuses those assemblies. Это поведение возникает только при использовании следующих конструкторов:This behavior occurs only when using the following constructors:

XmlSerializer.XmlSerializer(Type)

XmlSerializer.XmlSerializer(Type, String)

При использовании любого из других конструкторов несколько версий одной и той же сборки создаются и никогда не выгружаются, что приводит к утечке памяти и снижению производительности.If you use any of the other constructors, multiple versions of the same assembly are generated and never unloaded, which results in a memory leak and poor performance. Самым простым решением является использование одного из упомянутых выше двух конструкторов.The easiest solution is to use one of the previously mentioned two constructors. В противном случае сборки необходимо кэшировать в Hashtable, как показано в следующем примере.Otherwise, you must cache the assemblies in a Hashtable, as shown in the following example.

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 и универсального спискаSerialization of ArrayList and Generic List

XmlSerializer не может сериализовать или десериализовать следующее:The XmlSerializer cannot serialize or deserialize the following:

Сериализация перечислений неподписанных значений longSerialization of Enumerations of Unsigned Long

Невозможно создать экземпляр XmlSerializer для сериализации перечисления, если выполняются следующие условия. Перечисление имеет тип long без знака (ulong в C#), а перечисление содержит любой элемент со значением, превышающим 9 223 372 036 854 775 807.The XmlSerializer cannot be instantiated to serialize an enumeration if the following conditions are true: The enumeration is of type unsigned long (ulong in C#) and the enumeration contains any member with a value larger than 9,223,372,036,854,775,807. Например, невозможно выполнить сериализацию следующего.For example, the following cannot be serialized.

public enum LargeNumbers: ulong  
{  
    a = 9223372036854775808  
}  
// At runtime, the following code will fail.  
xmlSerializer mySerializer=new XmlSerializer(typeof(LargeNumbers));  

Объекты, помеченные атрибутом Obsolete, больше не сериализуютсяObjects marked with the Obsolete Attribute no longer serialized

В .NET Framework 3,5.NET Framework 3.5 класс XmlSerializer больше не сериализует объекты, помеченные как [Obsolete].In the .NET Framework 3,5.NET Framework 3.5 the XmlSerializer class no longer serializes objects that are marked as [Obsolete].

Конструкторы

XmlSerializer()

Инициализирует новый экземпляр класса XmlSerializer.Initializes a new instance of the XmlSerializer class.

XmlSerializer(Type)

Инициализирует новый экземпляр класса XmlSerializer, который может сериализовать объекты заданного типа в XML-документы, а также десериализовать XML-документы в объекты заданного типа.Initializes a new instance of the XmlSerializer class that can serialize objects of the specified type into XML documents, and deserialize XML documents into objects of the specified type.

XmlSerializer(Type, String)

Инициализирует новый экземпляр класса XmlSerializer, который может сериализовать объекты заданного типа в XML-документы, а также десериализовать XML-документы в объекты заданного типа.Initializes a new instance of the XmlSerializer class that can serialize objects of the specified type into XML documents, and deserialize XML documents into objects of the specified type. Указывает пространство имен по умолчанию для всех XML-элементов.Specifies the default namespace for all the XML elements.

XmlSerializer(Type, Type[])

Инициализирует новый экземпляр класса XmlSerializer, который может сериализовать объекты заданного типа в XML-документы, а также десериализовать XML-документы в объект заданного типа.Initializes a new instance of the XmlSerializer class that can serialize objects of the specified type into XML documents, and deserialize XML documents into object of a specified type. Если свойство или поле возвращает массив, параметр extraTypes определяет объекты, которые могут быть вставлены в массив.If a property or field returns an array, the extraTypes parameter specifies objects that can be inserted into the array.

XmlSerializer(Type, XmlAttributeOverrides)

Инициализирует новый экземпляр класса XmlSerializer, который может сериализовать объекты заданного типа в XML-документы, а также десериализовать XML-документы в объекты заданного типа.Initializes a new instance of the XmlSerializer class that can serialize objects of the specified type into XML documents, and deserialize XML documents into objects of the specified type. Каждый сериализуемый объект может сам содержать экземпляры классов, которые данная перегрузка позволяет переопределить с другими классами.Each object to be serialized can itself contain instances of classes, which this overload can override with other classes.

XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String)

Инициализирует новый экземпляр класса XmlSerializer, который может сериализовать объекты типа Object в экземпляры XML-документа, а также десериализовать экземпляры XML-документа в объекты типа Object.Initializes a new instance of the XmlSerializer class that can serialize objects of type Object into XML document instances, and deserialize XML document instances into objects of type Object. Каждый сериализуемый объект может сам содержать экземпляры классов, которые данная перегрузка переопределяет с другими классами.Each object to be serialized can itself contain instances of classes, which this overload overrides with other classes. Данная перегрузка также указывает пространство имен по умолчанию для всех XML-элементов и класс для использования в качестве корневого XML-элемента.This overload also specifies the default namespace for all the XML elements and the class to use as the XML root element.

XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String)

Инициализирует новый экземпляр класса XmlSerializer, который может сериализовать объекты типа Object в экземпляры XML-документа, а также десериализовать экземпляры XML-документа в объекты типа Object.Initializes a new instance of the XmlSerializer class that can serialize objects of type Object into XML document instances, and deserialize XML document instances into objects of type Object. Каждый сериализуемый объект может сам содержать экземпляры классов, которые данная перегрузка переопределяет с другими классами.Each object to be serialized can itself contain instances of classes, which this overload overrides with other classes. Данная перегрузка также указывает пространство имен по умолчанию для всех XML-элементов и класс для использования в качестве корневого XML-элемента.This overload also specifies the default namespace for all the XML elements and the class to use as the XML root element.

XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String, Evidence)

Инициализирует новый экземпляр класса XmlSerializer, который может сериализовать объекты заданного типа в экземпляры XML-документов, а также десериализовать экземпляры XML-документов в объекты заданного типа.Initializes a new instance of the XmlSerializer class that can serialize objects of the specified type into XML document instances, and deserialize XML document instances into objects of the specified type. Данная перегрузка позволяет предоставить другие типы, которые могут быть обнаружены во время операции сериализации или десериализации, а также пространства имен для всех XML-элементов по умолчанию, класс для использования в качестве корневого XML-элемента, его расположение и учетные данные, требуемые для доступа.This overload allows you to supply other types that can be encountered during a serialization or deserialization operation, as well as a default namespace for all XML elements, the class to use as the XML root element, its location, and credentials required for access.

XmlSerializer(Type, XmlRootAttribute)

Инициализирует новый экземпляр класса XmlSerializer, который может сериализовать объекты заданного типа в XML-документы, а также десериализовать XML-документ в объект заданного типа.Initializes a new instance of the XmlSerializer class that can serialize objects of the specified type into XML documents, and deserialize an XML document into object of the specified type. Также указывает класс для использования в качестве корневого XML-элемента.It also specifies the class to use as the XML root element.

XmlSerializer(XmlTypeMapping)

Инициализирует экземпляр класса XmlSerializer с помощью объекта, сопоставляющего один тип с другим.Initializes an instance of the XmlSerializer class using an object that maps one type to another.

Методы

CanDeserialize(XmlReader)

Возвращает значение, указывающее возможность выполнения данным XmlSerializer десериализации XML-документа.Gets a value that indicates whether this XmlSerializer can deserialize a specified XML document.

CreateReader()

Возвращает объект, используемый для считывания сериализуемого XML-документа.Returns an object used to read the XML document to be serialized.

CreateWriter()

При переопределении в производном классе возвращает модуль записи, использованный при сериализации объекта.When overridden in a derived class, returns a writer used to serialize the object.

Deserialize(Stream)

Десериализует XML-документ, содержащийся указанным Stream.Deserializes the XML document contained by the specified Stream.

Deserialize(TextReader)

Десериализует XML-документ, содержащийся указанным TextReader.Deserializes the XML document contained by the specified TextReader.

Deserialize(XmlReader)

Десериализует XML-документ, содержащийся указанным XmlReader.Deserializes the XML document contained by the specified XmlReader.

Deserialize(XmlReader, String)

Десериализует XML-документ, содержащийся указанным XmlReader, и стиль кодирования.Deserializes the XML document contained by the specified XmlReader and encoding style.

Deserialize(XmlReader, String, XmlDeserializationEvents)

Десериализует объект с помощью данных, содержащихся в указанном XmlReader.Deserializes the object using the data contained by the specified XmlReader.

Deserialize(XmlReader, XmlDeserializationEvents)

Десериализует XML-документ, содержащийся в указанном XmlReader, и позволяет переопределять события, происходящие во время десериализации.Deserializes an XML document contained by the specified XmlReader and allows the overriding of events that occur during deserialization.

Deserialize(XmlSerializationReader)

Десериализует XML-документ, содержащийся указанным XmlSerializationReader.Deserializes the XML document contained by the specified XmlSerializationReader.

Equals(Object)

Определяет, равен ли заданный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
FromMappings(XmlMapping[])

Возвращает массив объектов XmlSerializer, созданный из массива объектов XmlTypeMapping.Returns an array of XmlSerializer objects created from an array of XmlTypeMapping objects.

FromMappings(XmlMapping[], Evidence)

Возвращает экземпляр класса XmlSerializer, созданный из сопоставлений одного типа XML с другим.Returns an instance of the XmlSerializer class created from mappings of one XML type to another.

FromMappings(XmlMapping[], Type)

Возвращает экземпляр класса XmlSerializer из указанных сопоставлений.Returns an instance of the XmlSerializer class from the specified mappings.

FromTypes(Type[])

Возвращает массив объектов XmlSerializer, созданный из массива типов.Returns an array of XmlSerializer objects created from an array of types.

GenerateSerializer(Type[], XmlMapping[])

Возвращает сборку, содержащую клиентские сериализаторы, используемые для сериализации и десериализации заданных типов или типов с помощью указанных сопоставлений.Returns an assembly that contains custom-made serializers used to serialize or deserialize the specified type or types, using the specified mappings.

GenerateSerializer(Type[], XmlMapping[], CompilerParameters)

Возвращает сборку, содержащую клиентские сериализаторы, используемые для сериализации и десериализации заданных типов или типов с помощью указанных сопоставлений, а также настроек и параметров компилятора.Returns an assembly that contains custom-made serializers used to serialize or deserialize the specified type or types, using the specified mappings and compiler settings and options.

GetHashCode()

Служит хэш-функцией по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
GetXmlSerializerAssemblyName(Type)

Возвращает имя сборки, содержащей одну или более версий XmlSerializer, которая специально создана для сериализации или десериализации определенного типа.Returns the name of the assembly that contains one or more versions of the XmlSerializer especially created to serialize or deserialize the specified type.

GetXmlSerializerAssemblyName(Type, String)

Возвращает имя сборки, содержащей сериализатор для заданного типа в определенном пространстве имен.Returns the name of the assembly that contains the serializer for the specified type in the specified namespace.

MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
Serialize(Object, XmlSerializationWriter)

Сериализует указанный Object и записывает XML-документ в файл с помощью заданного XmlSerializationWriter.Serializes the specified Object and writes the XML document to a file using the specified XmlSerializationWriter.

Serialize(Stream, Object)

Сериализует указанный Object и записывает XML-документ в файл с помощью заданного Stream.Serializes the specified Object and writes the XML document to a file using the specified Stream.

Serialize(Stream, Object, XmlSerializerNamespaces)

Сериализует указанный Object и записывает XML-документ в файл с помощью заданного Stream, ссылающегося на заданные пространства имен.Serializes the specified Object and writes the XML document to a file using the specified Stream that references the specified namespaces.

Serialize(TextWriter, Object)

Сериализует указанный Object и записывает XML-документ в файл с помощью заданного TextWriter.Serializes the specified Object and writes the XML document to a file using the specified TextWriter.

Serialize(TextWriter, Object, XmlSerializerNamespaces)

Сериализует указанный объект Object, записывает XML-документ в файл с помощью заданного TextWriter и ссылается на заданные пространства имен.Serializes the specified Object and writes the XML document to a file using the specified TextWriter and references the specified namespaces.

Serialize(XmlWriter, Object)

Сериализует указанный Object и записывает XML-документ в файл с помощью заданного XmlWriter.Serializes the specified Object and writes the XML document to a file using the specified XmlWriter.

Serialize(XmlWriter, Object, XmlSerializerNamespaces)

Сериализует указанный объект Object, записывает XML-документ в файл с помощью заданного XmlWriter и ссылается на заданные пространства имен.Serializes the specified Object and writes the XML document to a file using the specified XmlWriter and references the specified namespaces.

Serialize(XmlWriter, Object, XmlSerializerNamespaces, String)

Сериализует указанный объект, записывает XML-документ в файл с помощью заданного XmlWriter и ссылается на заданные пространства имен и стиль кодирования.Serializes the specified object and writes the XML document to a file using the specified XmlWriter and references the specified namespaces and encoding style.

Serialize(XmlWriter, Object, XmlSerializerNamespaces, String, String)

Сериализует указанный Object и записывает XML-документ в файл с помощью заданных XmlWriter, пространства имен XML и кодирования.Serializes the specified Object and writes the XML document to a file using the specified XmlWriter, XML namespaces, and encoding.

ToString()

Возвращает строку, представляющую текущий объект.Returns a string that represents the current object.

(Унаследовано от Object)

События

UnknownAttribute

Происходит, когда во время десериализации XmlSerializer встречает атрибут XML неизвестного типа.Occurs when the XmlSerializer encounters an XML attribute of unknown type during deserialization.

UnknownElement

Происходит, когда во время десериализации XmlSerializer встречает XML-элемент неизвестного типа.Occurs when the XmlSerializer encounters an XML element of unknown type during deserialization.

UnknownNode

Происходит, когда во время десериализации XmlSerializer встречает XML-узел неизвестного типа.Occurs when the XmlSerializer encounters an XML node of unknown type during deserialization.

UnreferencedObject

Происходит во время десериализации SOAP-кодированного потока XML, когда XmlSerializer обнаруживает неиспользуемый тип или тип без ссылок.Occurs during deserialization of a SOAP-encoded XML stream, when the XmlSerializer encounters a recognized type that is not used or is unreferenced.

Применяется к

Потокобезопасность

Данный тип потокобезопасен.This type is thread safe.

Дополнительно