XmlSerializer Sınıf

Tanım

Ad Alanı:

System.Xml.Serialization

Bütünleştirilmiş Kodlar:

netstandard.dll, System.Xml.XmlSerializer.dll

Kaynak:

XmlSerializer.cs

XML belgelerine ve xml belgelerinden nesneleri serileştirir ve seri durumdan kaldırır. , XmlSerializer nesnelerin XML'de nasıl kodlanıldığını denetlemenizi sağlar.

public ref class XmlSerializer

public class XmlSerializer

type XmlSerializer = class

Public Class XmlSerializer

Devralma

Object

XmlSerializer

Örnekler

Aşağıdaki örnek iki ana sınıf içerir: PurchaseOrder ve Test. sınıfı, PurchaseOrder tek bir satın alma hakkında bilgi içerir. Test sınıfı, satınalma siparişini oluşturan ve oluşturulan satınalma siparişini okuyan yöntemleri içerir.

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

Açıklamalar

Bu API hakkında daha fazla bilgi için bkz. XmlSerializer için ek API açıklamaları.

Oluşturucular

Name	Description
XmlSerializer()	XmlSerializer sınıfının yeni bir örneğini başlatır.
XmlSerializer(Type, String)	Sınıfın, belirtilen türdeki XmlSerializer nesneleri XML belgelerine seri hale getirebilen ve XML belgelerini belirtilen türde nesneler halinde seri durumdan çıkarabilen yeni bir örneğini başlatır. Tüm XML öğeleri için varsayılan ad alanını belirtir.
XmlSerializer(Type, Type[])	Belirtilen türdeki XmlSerializer nesneleri XML belgelerine seri hale getirebilen ve XML belgelerini belirtilen türde bir nesneye seri durumdan çıkarabilen sınıfın yeni bir örneğini başlatır. Bir özellik veya alan bir dizi döndürürse, extraTypes parametresi diziye eklenebilen nesneleri belirtir.
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String)	türündeki XmlSerializer nesneleri Object XML belge örneklerine seri hale getirebilen ve XML belge örneklerini türündeki Objectnesnelere seri durumdan çıkarabilen yeni bir sınıfı örneği başlatır. Seri hale getirilecek her nesne, bu aşırı yüklemenin diğer sınıflarla geçersiz kıldığı sınıfların örneklerini içerebilir. Bu aşırı yükleme, tüm XML öğeleri ve XML kök öğesi olarak kullanılacak sınıf için varsayılan ad alanını da belirtir.
XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String)	türündeki XmlSerializer nesneleri Object XML belge örneklerine seri hale getirebilen ve XML belge örneklerini türündeki Objectnesnelere seri durumdan çıkarabilen yeni bir sınıfı örneği başlatır. Seri hale getirilecek her nesne, bu aşırı yüklemenin diğer sınıflarla geçersiz kıldığı sınıfların örneklerini içerebilir. Bu aşırı yükleme, tüm XML öğeleri ve XML kök öğesi olarak kullanılacak sınıf için varsayılan ad alanını da belirtir.
XmlSerializer(Type, XmlAttributeOverrides)	Sınıfın, belirtilen türdeki XmlSerializer nesneleri XML belgelerine seri hale getirebilen ve XML belgelerini belirtilen türde nesneler halinde seri durumdan çıkarabilen yeni bir örneğini başlatır. Seri hale getirilecek her nesnenin kendisi sınıfların örneklerini içerebilir ve bu aşırı yükleme diğer sınıflarla geçersiz kılabilir.
XmlSerializer(Type, XmlRootAttribute)	Sınıfın, belirtilen türdeki XmlSerializer nesneleri XML belgeleri halinde seri hale getirebilen ve xml belgesini belirtilen türde bir nesneye seri durumdan çıkarabilen yeni bir örneğini başlatır. Ayrıca XML kök öğesi olarak kullanılacak sınıfı belirtir.
XmlSerializer(Type)	Sınıfın, belirtilen türdeki XmlSerializer nesneleri XML belgelerine seri hale getirebilen ve XML belgelerini belirtilen türde nesneler halinde seri durumdan çıkarabilen yeni bir örneğini başlatır.
XmlSerializer(XmlTypeMapping)	Bir türü başka bir türle XmlSerializer eşleyen bir nesne kullanarak sınıfın bir örneğini başlatır.

Yöntemler

Name	Description
CanDeserialize(XmlReader)	Bunun XmlSerializer belirtilen xml belgesini seri durumdan çıkarıp çıkaramayacağını gösteren bir değer alır.
CreateReader()	Seri hale getirilecek XML belgesini okumak için kullanılan nesneyi döndürür.
CreateWriter()	Türetilmiş bir sınıfta geçersiz kılındığında, nesneyi serileştirmek için kullanılan bir yazıcı döndürür.
Deserialize(Stream)	Belirtilen Streamtarafından bulunan XML belgesini seri durumdan çıkartır.
Deserialize(TextReader)	Belirtilen TextReadertarafından bulunan XML belgesini seri durumdan çıkartır.
Deserialize(XmlReader, String, XmlDeserializationEvents)	Belirtilen XmlReadertarafından kapsanan verileri kullanarak nesneyi seri durumdan çıkartır.
Deserialize(XmlReader, String)	Belirtilen XmlReader ve kodlama stilinin içerdiği XML belgesini seri durumdan çıkartır.
Deserialize(XmlReader, XmlDeserializationEvents)	Belirtilen XmlReader tarafından kapsanan bir XML belgesini seri durumdan çıkarma ve seri durumdan çıkarma sırasında gerçekleşen olayların geçersiz kılınmasına izin verir.
Deserialize(XmlReader)	Belirtilen XmlReadertarafından bulunan XML belgesini seri durumdan çıkartır.
Deserialize(XmlSerializationReader)	Belirtilen XmlSerializationReadertarafından bulunan XML belgesini seri durumdan çıkartır.
Equals(Object)	Belirtilen nesnenin geçerli nesneye eşit olup olmadığını belirler. (Devralındığı yer: Object)
FromMappings(XmlMapping[], Type)	Belirtilen eşlemelerden sınıfının bir örneğini XmlSerializer döndürür.
FromMappings(XmlMapping[])	Bir nesne dizisinden XmlSerializer oluşturulan bir nesne dizisi XmlTypeMapping döndürür.
FromTypes(Type[])	Bir tür dizisinden XmlSerializer oluşturulan bir nesne dizisi döndürür.
GetHashCode()	Varsayılan karma işlevi işlevi görür. (Devralındığı yer: Object)
GetType()	Geçerli örneğin Type alır. (Devralındığı yer: Object)
GetXmlSerializerAssemblyName(Type, String)	Belirtilen ad alanında belirtilen tür için seri hale getiriciyi içeren derlemenin adını döndürür.
GetXmlSerializerAssemblyName(Type)	Özellikle belirtilen türü seri hale getirmek veya seri durumdan XmlSerializer çıkarmak için oluşturulan bir veya daha fazla sürümünü içeren derlemenin adını döndürür.
MemberwiseClone()	Geçerli Objectbasit bir kopyasını oluşturur. (Devralındığı yer: Object)
Serialize(Object, XmlSerializationWriter)	Belirtilen serileştirir ve xml Object belgesini belirtilen XmlSerializationWriterkullanarak bir dosyaya yazar.
Serialize(Stream, Object, XmlSerializerNamespaces)	Belirtileni serileştirir ve belirtilen Object ad alanlarına başvuran belirtilen Stream öğesini kullanarak XML belgesini bir dosyaya yazar.
Serialize(Stream, Object)	Belirtilen serileştirir ve xml Object belgesini belirtilen Streamkullanarak bir dosyaya yazar.
Serialize(TextWriter, Object, XmlSerializerNamespaces)	Belirtileni serileştirir ve belirtilen ObjectTextWriter ad alanlarını kullanarak XML belgesini bir dosyaya yazar ve belirtilen ad alanlarına başvurur.
Serialize(TextWriter, Object)	Belirtilen serileştirir ve xml Object belgesini belirtilen TextWriterkullanarak bir dosyaya yazar.
Serialize(XmlWriter, Object, XmlSerializerNamespaces, String, String)	Belirtileni serileştirir ve belirtilen Object , XML ad alanlarını ve kodlamayı kullanarak XML belgesini bir dosyaya XmlWriteryazar.
Serialize(XmlWriter, Object, XmlSerializerNamespaces, String)	Belirtilen nesneyi serileştirir ve xml belgesini belirtilen XmlWriter kullanarak bir dosyaya yazar ve belirtilen ad alanlarına ve kodlama stiline başvurur.
Serialize(XmlWriter, Object, XmlSerializerNamespaces)	Belirtileni serileştirir ve belirtilen ObjectXmlWriter ad alanlarını kullanarak XML belgesini bir dosyaya yazar ve belirtilen ad alanlarına başvurur.
Serialize(XmlWriter, Object)	Belirtilen serileştirir ve xml Object belgesini belirtilen XmlWriterkullanarak bir dosyaya yazar.
ToString()	Geçerli nesneyi temsil eden bir dize döndürür. (Devralındığı yer: Object)

Ekinlikler

Name	Description
UnknownAttribute	seri durumdan XmlSerializer çıkarma sırasında bilinmeyen türde bir XML özniteliğiyle karşılaştığında oluşur.
UnknownElement	Seri durumdan XmlSerializer çıkarma sırasında bilinmeyen türde bir XML öğesiyle karşılaştığında gerçekleşir.
UnknownNode	Seri durumdan XmlSerializer çıkarma sırasında bilinmeyen türde bir XML düğümüyle karşılaştığında gerçekleşir.
UnreferencedObject	SOAP ile kodlanmış XML akışının seri durumdan çıkarılması sırasında, XmlSerializer kullanılmayan veya başvurulmayan tanınan bir türle karşılaştığında gerçekleşir.

İş Parçacığı Güvenliği

Bu tür iş parçacığı güvenlidir.

Ayrıca bkz.

• XmlAttributeOverrides
• XmlAttributes
• XmlText
• XML Serileştirmeye Giriş
• Nasıl yapılır: XML Akışı için Alternatif Öğe Adı Belirtme
• Öznitelikleri Kullanarak XML Serileştirmesini Denetleme
• XML Serileştirme Örnekleri
• XML Şema Tanımı Aracı (XSD.exe)
• Nasıl yapılır: Türetilmiş Sınıfların Serileştirmesini Denetleme
• <dateTimeSerialization>Öğesi
• <xmlSerializer> Öğesi