XmlSerializer Класс

Определение

Пространство имен:
System.Xml.Serialization
Сборки:
System.Xml.dll, System.Xml.XmlSerializer.dll
Сборки:
netstandard.dll, System.Xml.XmlSerializer.dll
Сборка:
System.Xml.XmlSerializer.dll
Сборка:
System.Xml.dll
Сборка:
netstandard.dll
Исходный код:
XmlSerializer.cs
Исходный код:
XmlSerializer.cs
Исходный код:
XmlSerializer.cs
Исходный код:
XmlSerializer.cs
Исходный код:
XmlSerializer.cs

Сериализует и десериализирует объекты в XML-документы и из нее. Позволяет XmlSerializer управлять кодированием объектов в XML.

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

Примеры

В следующем примере содержатся два основных класса: PurchaseOrder и Test. Класс PurchaseOrder содержит сведения об одной покупке. Класс 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

Комментарии

Дополнительные сведения об этом API см. в дополнительных примечаниях API для XmlSerializer.

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

Имя Описание
XmlSerializer()

Инициализирует новый экземпляр класса XmlSerializer.
XmlSerializer(Type, String)

Инициализирует новый экземпляр XmlSerializer класса, который может сериализовать объекты указанного типа в XML-документы и десериализировать XML-документы в объекты указанного типа. Задает пространство имен по умолчанию для всех XML-элементов.
XmlSerializer(Type, Type[])

Инициализирует новый экземпляр XmlSerializer класса, который может сериализовать объекты указанного типа в XML-документы и десериализировать XML-документы в объект указанного типа. Если свойство или поле возвращает массив, extraTypes параметр указывает объекты, которые можно вставить в массив.
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String, Evidence)
Устаревшие..

Инициализирует новый экземпляр XmlSerializer класса, который может сериализовать объекты указанного типа в экземпляры XML-документа и десериализировать экземпляры XML-документа в объекты указанного типа. Эта перегрузка позволяет предоставлять другие типы, которые могут быть обнаружены во время операции сериализации или десериализации, а также пространство имен по умолчанию для всех XML-элементов, класс, используемый в качестве корневого элемента XML, его расположения и учетных данных, необходимых для доступа.
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String)

Инициализирует новый экземпляр XmlSerializer класса, который может сериализовать объекты типа Object в экземпляры XML-документов и десериализировать экземпляры XML-документа в объекты типа Object. Каждый объект для сериализации может содержать экземпляры классов, которые переопределяются с другими классами. Эта перегрузка также указывает пространство имен по умолчанию для всех XML-элементов и класса, используемых в качестве корневого элемента XML.
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String)

Инициализирует новый экземпляр XmlSerializer класса, который может сериализовать объекты типа Object в экземпляры XML-документов и десериализировать экземпляры XML-документа в объекты типа Object. Каждый объект для сериализации может содержать экземпляры классов, которые переопределяются с другими классами. Эта перегрузка также указывает пространство имен по умолчанию для всех XML-элементов и класса, используемых в качестве корневого элемента XML.
XmlSerializer(Type, XmlAttributeOverrides)

Инициализирует новый экземпляр XmlSerializer класса, который может сериализовать объекты указанного типа в XML-документы и десериализировать XML-документы в объекты указанного типа. Каждый объект, который необходимо сериализовать, может содержать экземпляры классов, которые эта перегрузка может переопределить с другими классами.
XmlSerializer(Type, XmlRootAttribute)

Инициализирует новый экземпляр XmlSerializer класса, который может сериализовать объекты указанного типа в XML-документы и десериализировать XML-документ в объект указанного типа. Он также указывает класс, используемый в качестве корневого элемента XML.
XmlSerializer(Type)

Инициализирует новый экземпляр XmlSerializer класса, который может сериализовать объекты указанного типа в XML-документы и десериализировать XML-документы в объекты указанного типа.
XmlSerializer(XmlTypeMapping)

Инициализирует экземпляр XmlSerializer класса с помощью объекта, который сопоставляет один тип с другим.

Методы

Имя Описание
CanDeserialize(XmlReader)

Возвращает значение, указывающее, может ли это XmlSerializer десериализировать указанный XML-документ.
CreateReader()

Возвращает объект, используемый для чтения XML-документа для сериализации.
CreateWriter()

При переопределении в производном классе возвращает модуль записи, используемый для сериализации объекта.
Deserialize(Stream)

Десериализирует XML-документ, содержащийся указанным Stream.
Deserialize(TextReader)

Десериализирует XML-документ, содержащийся указанным TextReader.
Deserialize(XmlReader, String, XmlDeserializationEvents)

Десериализирует объект с помощью данных, содержащихся в указанном XmlReader.
Deserialize(XmlReader, String)

Десериализация XML-документа, содержащегося в указанном XmlReader стиле и кодировке.
Deserialize(XmlReader, XmlDeserializationEvents)

Десериализирует XML-документ, содержащийся указанным XmlReader , и позволяет переопределять события, возникающие во время десериализации.
Deserialize(XmlReader)

Десериализирует XML-документ, содержащийся указанным XmlReader.
Deserialize(XmlSerializationReader)

Десериализирует XML-документ, содержащийся указанным XmlSerializationReader.
Equals(Object)

Определяет, равен ли указанный объект текущему объекту.

(Унаследовано от Object)
FromMappings(XmlMapping[], Evidence)
Устаревшие..

Возвращает экземпляр класса, созданного из сопоставлений XmlSerializer одного типа XML с другим.
FromMappings(XmlMapping[], Type)

Возвращает экземпляр XmlSerializer класса из указанных сопоставлений.
FromMappings(XmlMapping[])

Возвращает массив объектов, созданных XmlSerializer из массива XmlTypeMapping объектов.
FromTypes(Type[])

Возвращает массив объектов, созданных XmlSerializer из массива типов.
GenerateSerializer(Type[], XmlMapping[], CompilerParameters)

Возвращает сборку, содержащую настраиваемые сериализаторы, используемые для сериализации или десериализации указанного типа или типов, с помощью указанных сопоставлений и параметров компилятора.
GenerateSerializer(Type[], XmlMapping[])

Возвращает сборку, содержащую настраиваемые сериализаторы, используемые для сериализации или десериализации указанного типа или типов, с помощью указанных сопоставлений.
GetHashCode()

Служит хэш-функцией по умолчанию.

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

Возвращает Type текущего экземпляра.

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

Возвращает имя сборки, содержащей сериализатор для указанного типа в указанном пространстве имен.
GetXmlSerializerAssemblyName(Type)

Возвращает имя сборки, содержащей одну или несколько версий специально созданной для сериализации или десериализации указанного XmlSerializer типа.
MemberwiseClone()

Создает неглубокую копию текущей Object.

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

Сериализует указанный Object и записывает XML-документ в файл с помощью указанного XmlSerializationWriter.
Serialize(Stream, Object, XmlSerializerNamespaces)

Сериализует указанный Object и записывает XML-документ в файл, используя указанные Stream ссылки на указанные пространства имен.
Serialize(Stream, Object)

Сериализует указанный Object и записывает XML-документ в файл с помощью указанного Stream.
Serialize(TextWriter, Object, XmlSerializerNamespaces)

Сериализует указанный Object и записывает XML-документ в файл с помощью указанного TextWriter и ссылается на указанные пространства имен.
Serialize(TextWriter, Object)

Сериализует указанный Object и записывает XML-документ в файл с помощью указанного TextWriter.
Serialize(XmlWriter, Object, XmlSerializerNamespaces, String, String)

Сериализует указанный Object и записывает XML-документ в файл с помощью указанных XmlWriterпространств имен XML и кодирования.
Serialize(XmlWriter, Object, XmlSerializerNamespaces, String)

Сериализует указанный объект и записывает XML-документ в файл с помощью указанного XmlWriter и ссылается на указанные пространства имен и стиль кодирования.
Serialize(XmlWriter, Object, XmlSerializerNamespaces)

Сериализует указанный Object и записывает XML-документ в файл с помощью указанного XmlWriter и ссылается на указанные пространства имен.
Serialize(XmlWriter, Object)

Сериализует указанный Object и записывает XML-документ в файл с помощью указанного XmlWriter.
ToString()

Возвращает строку, представляющую текущий объект.

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

События

Имя Описание
UnknownAttribute

Происходит при XmlSerializer обнаружении XML-атрибута неизвестного типа во время десериализации.
UnknownElement

Происходит при XmlSerializer обнаружении XML-элемента неизвестного типа во время десериализации.
UnknownNode

Возникает при XmlSerializer обнаружении XML-узла неизвестного типа во время десериализации.
UnreferencedObject

Происходит во время десериализации XML-потока в кодировке SOAP, когда XmlSerializer обнаруживается распознанный тип, который не используется или не имеет ссылок.

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

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

Этот тип является потокобезопасной.

См. также раздел