XmlSerializer Třída

Definice

Serializace a deserializace objektů do a z dokumentů XML. XmlSerializerUmožňuje řídit, jak jsou objekty kódovány do XML.

public ref class XmlSerializer
public class XmlSerializer
type XmlSerializer = class
Public Class XmlSerializer
Dědičnost
XmlSerializer

Příklady

Následující příklad obsahuje dvě hlavní třídy: PurchaseOrder a Test . PurchaseOrderTřída obsahuje informace o jednom nákupu. TestTřída obsahuje metody, které vytvářejí nákupní objednávku a které si přečtou vytvořenou nákupní objednávku.

#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

Poznámky

Serializace XML je proces převodu veřejných vlastností objektu a polí na sériového formátu (v tomto případě XML) pro úložiště nebo přenos. Deserializace znovu vytvoří objekt v původním stavu z výstupu XML. Serializaci lze představit jako způsob uložení stavu objektu do datového proudu nebo vyrovnávací paměti. například ASP.NET používá XmlSerializer třídu ke kódování zpráv webové služby XML.

Data v objekty je popsána pomocí konstrukcí programovací jazyk jako třídy, pole, vlastnosti, primitivní typy, pole a dokonce i vloženého XML ve formě XmlElement nebo XmlAttribute objekty. Máte možnost vytvořit si vlastní třídy s poznámkami pomocí atributů nebo pomocí nástroje definice schématu XML (Xsd.exe) k vygenerování tříd založených na stávajícím dokumentu XSD (XML Schema Definition). Máte-li schéma XML, můžete spustit Xsd.exe a vytvořit sadu tříd, které jsou silně typované do schématu a popsány atributy, které mají být při serializaci dodrženy.

Pro přenos dat mezi objekty a XML vyžaduje mapování z konstrukcí programovacích jazyků do schématu XML a ze schématu XML na konstrukce programovacích jazyků. XmlSerializerNástroje a související nástroje jako Xsd.exe poskytují most mezi těmito dvěma technologiemi v době návrhu i v modulu runtime. V době návrhu použijte Xsd.exe k vytvoření dokumentu schématu XML (. XSD) z vašich vlastních tříd nebo pro vytvoření tříd z daného schématu. V obou případech jsou třídy opatřeny poznámkami s vlastními atributy, které XmlSerializer popisují mapování mezi systémem schématu XML a modulem CLR (Common Language Runtime). Za běhu lze instance tříd serializovat do dokumentů XML, které následují po daném schématu. Podobně je možné tyto dokumenty XML deserializovat do běhových objektů. Všimněte si, že schéma XML je volitelné a není vyžadováno v době návrhu nebo za běhu.

Řízení generovaného kódu XML

Chcete-li řídit vygenerovaný kód XML, můžete použít speciální atributy na třídy a členy. Například chcete-li zadat jiný název elementu XML, použijte XmlElementAttribute pro veřejné pole nebo vlastnost a nastavte ElementName vlastnost. Úplný seznam podobných atributů naleznete v tématu atributy, které řídí serializaci XML. Můžete také implementovat IXmlSerializable rozhraní pro řízení výstupu XML.

Pokud musí XML vygenerované v souladu s oddílem 5 dokumentu konsorcia World World, (Simple Object Access Protocol 1,1), je nutné vytvořit XmlSerializer pomocí XmlTypeMapping . Pro další kontrolu kódovaného protokolu SOAP XML použijte atributy uvedené v atributech, které řídí serializaci kódovaných SOAP.

S nástrojem můžete využít XmlSerializer výhod práce se třídami se silnými typy a pořád mít flexibilitu v jazyce XML. Pomocí polí nebo vlastností typu XmlElement XmlAttribute nebo XmlNode ve vašich silně typových třídách můžete číst části dokumentu XML přímo do objektů XML.

Pokud pracujete s rozšiřitelnými schématy XML, můžete také použít XmlAnyElementAttribute XmlAnyAttributeAttribute atributy a k serializaci a deserializaci prvků nebo atributů, které se v původním schématu nenašly. Chcete-li použít objekty, použijte XmlAnyElementAttribute pro pole, které vrací pole XmlElement objektů, nebo použijte XmlAnyAttributeAttribute pro pole, které vrací pole XmlAttribute objektů.

Pokud vlastnost nebo pole vrátí komplexního objektu (například pole nebo instanci třídy), XmlSerializer převede ho na prvek vnořené hlavní dokument XML. Například první třída v následujícím kódu vrací instanci druhé třídy.

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

Serializovaný výstup XML vypadá takto:

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

Pokud schéma obsahuje prvek, který je nepovinný (minOccurs = ' 0 '), nebo pokud schéma obsahuje výchozí hodnotu, máte dvě možnosti. Jednu z možností je použít System.ComponentModel.DefaultValueAttribute k určení výchozí hodnoty, jak je znázorněno v následujícím kódu.

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

Další možností je použít speciální vzor k vytvoření logického pole rozpoznaného XmlSerializer a pro použití v XmlIgnoreAttribute poli. Vzor je vytvořen ve formě propertyNameSpecified . Například pokud je pole s názvem "MyFirstName", vytvoříte také pole s názvem "MyFirstNameSpecified", které instruuje, XmlSerializer zda má být generován element XML s názvem "MyFirstName". To je ukázáno v následujícím příkladu.

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

Přepsání výchozí serializace

Můžete také přepsat serializaci jakékoli sady objektů a jejich polí a vlastností tak, že vytvoříte jeden z odpovídajících atributů a přidáte ho do instance XmlAttributes třídy. Přepsání serializace tímto způsobem má dvě použití: nejprve můžete řídit a rozšířit serializaci objektů nalezených v knihovně DLL, a to i v případě, že nemáte přístup ke zdroji; za druhé můžete vytvořit jednu sadu serializovatelných tříd, ale serializovat objekty vícenásobnými způsoby. Další podrobnosti naleznete v tématu XmlAttributeOverrides Třída a Postupy: řízení serializace odvozených tříd.

Chcete-li serializovat objekt, zavolejte Serialize metodu. Chcete-li objekt deserializovat, zavolejte Deserialize metodu.

Chcete-li přidat obory názvů XML do dokumentu XML, přečtěte si téma XmlSerializerNamespaces .

Poznámka

XmlSerializerPoskytuje speciální zacházení třídám, které implementují IEnumerable nebo ICollection . Třídu, která implementuje IEnumerable musí implementovat veřejné Add metodu, která přebírá jediný parametr. AddParametr metody musí být stejného typu, jako je vrácen z Current vlastnosti u hodnoty vrácené z GetEnumerator nebo některého z těchto typů. Třída, která implementuje ICollection (například CollectionBase ) Kromě toho IEnumerable musí mít veřejnou Item indexovanou vlastnost (indexer v jazyce C#), která přebírá celé číslo a musí mít veřejnou Count vlastnost typu Integer. Parametr Add metody musí být stejného typu, jako je vrácen z Item vlastnosti, nebo jeden z těchto typů základů. Pro třídy, které implementují ICollection , hodnoty, které mají být serializován, jsou načteny z indexované Item vlastnosti, nikoli voláním GetEnumerator .

K deserializaci objektu musíte mít oprávnění k zápisu do dočasného adresáře (jak je definováno proměnnou prostředí TEMP).

Dynamicky generovaná sestavení

Pro zvýšení výkonu infrastruktura serializace XML dynamicky generuje sestavení k serializaci a deserializaci určených typů. Infrastruktura tyto sestavení vyhledá a znovu použije. K tomuto chování dochází pouze při použití následujících konstruktorů:

XmlSerializer.XmlSerializer(Type)

XmlSerializer.XmlSerializer(Type, String)

Použijete-li některý z ostatních konstruktorů, jsou vygenerovány a nikdy uvolněny vícenásobné verze stejného sestavení, což vede k nevracení paměti a špatnému výkonu. Nejjednodušším řešením je použití jednoho z dříve uvedených dvou konstruktorů. V opačném případě je nutné sestavení ukládat do mezipaměti v Hashtable , jak je znázorněno v následujícím příkladu.

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.

Serializace a obecný seznam

XmlSerializerNelze serializovat nebo deserializovat následující:

Serializace výčtů bez znaménka Long

XmlSerializerNelze vytvořit instanci pro serializaci výčtu, pokud jsou splněny následující podmínky: výčet je typu Long bez znaménka ( ulong v jazyce C#) a výčet obsahuje libovolného člena s hodnotou větší než 9 223 372 036 854 775 807. Následující nelze například serializovat.

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

Objekty označené nezastaralým atributem již nejsou serializovány.

v .NET Framework 3,5 XmlSerializer třída již neserializace objekty, které jsou označeny jako [Obsolete] .

Konstruktory

XmlSerializer()

Inicializuje novou instanci XmlSerializer třídy.

XmlSerializer(Type)

Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty zadaného typu do dokumentů XML a deserializovat dokumenty XML do objektů zadaného typu.

XmlSerializer(Type, String)

Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty zadaného typu do dokumentů XML a deserializovat dokumenty XML do objektů zadaného typu. Určuje výchozí obor názvů pro všechny elementy XML.

XmlSerializer(Type, Type[])

Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty zadaného typu do dokumentů XML a deserializovat dokumenty XML do objektu zadaného typu. Pokud vlastnost nebo pole vrátí pole, extraTypes parametr určí objekty, které mohou být vloženy do pole.

XmlSerializer(Type, XmlAttributeOverrides)

Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty zadaného typu do dokumentů XML a deserializovat dokumenty XML do objektů zadaného typu. Každý objekt, který má být serializován, může obsahovat instance tříd, které toto přetížení může přepsat jinými třídami.

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

Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty typu Object do instancí dokumentů XML a deserializovat instance dokumentů XML do objektů typu Object . Každý objekt, který má být serializován, může obsahovat instance tříd, které toto přetížení Přepisuje s jinými třídami. Toto přetížení také určuje výchozí obor názvů pro všechny elementy XML a třídu, která se má použít jako kořenový prvek XML.

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

Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty typu Object do instancí dokumentů XML a deserializovat instance dokumentů XML do objektů typu Object . Každý objekt, který má být serializován, může obsahovat instance tříd, které toto přetížení Přepisuje s jinými třídami. Toto přetížení také určuje výchozí obor názvů pro všechny elementy XML a třídu, která se má použít jako kořenový prvek XML.

XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String, Evidence)
Zastaralé.

Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty zadaného typu do instancí dokumentů XML a deserializovat instance dokumentů XML do objektů zadaného typu. Toto přetížení umožňuje zadat jiné typy, které mohou být zjištěny během serializace nebo deserializace, a také výchozí obor názvů pro všechny elementy XML, třída, která se má použít jako kořenový element XML, jeho umístění a přihlašovací údaje požadované pro přístup.

XmlSerializer(Type, XmlRootAttribute)

Inicializuje novou instanci XmlSerializer třídy, která může serializovat objekty zadaného typu do dokumentů XML a deserializovat dokument XML do objektu zadaného typu. Určuje také třídu, která bude použita jako kořenový prvek XML.

XmlSerializer(XmlTypeMapping)

Inicializuje instanci XmlSerializer třídy pomocí objektu, který mapuje jeden typ na jiný.

Metody

CanDeserialize(XmlReader)

Získá hodnotu, která označuje, zda XmlSerializer může toto zrušit serializaci zadaného dokumentu XML.

CreateReader()

Vrátí objekt použitý ke čtení dokumentu XML k serializaci.

CreateWriter()

Při přepsání v odvozené třídě vrátí zapisovač, který slouží k serializaci objektu.

Deserialize(Stream)

Deserializace dokument XML obsažený v zadaném Stream .

Deserialize(TextReader)

Deserializace dokument XML obsažený v zadaném TextReader .

Deserialize(XmlReader)

Deserializace dokument XML obsažený v zadaném XmlReader .

Deserialize(XmlReader, String)

Deserializace dokument XML, který je obsažený ve XmlReader stylu zadaného a kódování.

Deserialize(XmlReader, String, XmlDeserializationEvents)

Deserializace objektu pomocí dat obsažených v zadaném XmlReader .

Deserialize(XmlReader, XmlDeserializationEvents)

Deserializace dokument XML obsažený v zadaném XmlReader a umožňuje přepis událostí, ke kterým dojde během deserializace.

Deserialize(XmlSerializationReader)

Deserializace dokument XML obsažený v zadaném XmlSerializationReader .

Equals(Object)

Určí, zda se zadaný objekt rovná aktuálnímu objektu.

(Zděděno od Object)
FromMappings(XmlMapping[])

Vrátí pole XmlSerializer objektů vytvořených z pole XmlTypeMapping objektů.

FromMappings(XmlMapping[], Evidence)
Zastaralé.

Vrátí instanci XmlSerializer třídy vytvořené z mapování jednoho typu XML na jiný.

FromMappings(XmlMapping[], Type)

Vrátí instanci XmlSerializer třídy ze zadaného mapování.

FromTypes(Type[])

Vrátí pole XmlSerializer objektů vytvořených z pole typů.

GenerateSerializer(Type[], XmlMapping[])

Vrátí sestavení, které obsahuje uživatelsky definované serializace používané k serializaci nebo deserializaci zadaného typu nebo typů pomocí zadaných mapování.

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

Vrátí sestavení, které obsahuje uživatelsky definované serializace používané k serializaci nebo deserializaci zadaného typu nebo typů pomocí zadaných mapování a nastavení kompilátoru a možností.

GetHashCode()

Slouží jako výchozí funkce hash.

(Zděděno od Object)
GetType()

Získá Type aktuální instanci.

(Zděděno od Object)
GetXmlSerializerAssemblyName(Type)

Vrátí název sestavení, které obsahuje jednu nebo více verzí, které byly XmlSerializer vytvořeny hlavně pro serializaci nebo deserializaci zadaného typu.

GetXmlSerializerAssemblyName(Type, String)

Vrátí název sestavení, které obsahuje serializátor pro zadaný typ v určeném oboru názvů.

MemberwiseClone()

Vytvoří kopii aktuálního seznamu Object .

(Zděděno od Object)
Serialize(Object, XmlSerializationWriter)

Provede serializaci zadaného Object a zapíše dokument XML do souboru pomocí zadaného XmlSerializationWriter .

Serialize(Stream, Object)

Provede serializaci zadaného Object a zapíše dokument XML do souboru pomocí zadaného Stream .

Serialize(Stream, Object, XmlSerializerNamespaces)

Provede serializaci zadaného Object a zapisuje dokument XML do souboru pomocí zadaného Stream , který odkazuje na zadané obory názvů.

Serialize(TextWriter, Object)

Provede serializaci zadaného Object a zapíše dokument XML do souboru pomocí zadaného TextWriter .

Serialize(TextWriter, Object, XmlSerializerNamespaces)

Provede serializaci zadaného Object a zapíše dokument XML do souboru pomocí zadaného TextWriter a odkazuje na zadané obory názvů.

Serialize(XmlWriter, Object)

Provede serializaci zadaného Object a zapíše dokument XML do souboru pomocí zadaného XmlWriter .

Serialize(XmlWriter, Object, XmlSerializerNamespaces)

Provede serializaci zadaného Object a zapíše dokument XML do souboru pomocí zadaného XmlWriter a odkazuje na zadané obory názvů.

Serialize(XmlWriter, Object, XmlSerializerNamespaces, String)

Provede serializaci zadaného objektu a zapíše dokument XML do souboru pomocí zadaného XmlWriter a odkazuje na zadané obory názvů a styl kódování.

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

Provede serializaci zadaného Object a zapisuje dokument XML do souboru pomocí zadaných XmlWriter , oborů názvů XML a kódování.

ToString()

Vrátí řetězec, který představuje aktuální objekt.

(Zděděno od Object)

Události

UnknownAttribute

XmlSerializerNastane, když narazí atribut XML neznámého typu během deserializace.

UnknownElement

Vyvolá se XmlSerializer v případě, že při deserializaci narazí na prvek XML neznámého typu.

UnknownNode

XmlSerializerNastane, když narazí na uzel XML neznámého typu během deserializace.

UnreferencedObject

Vyvolá se během deserializace xml streamu zakódovaného v protokolu SOAP, když zjistí rozpoznaný typ, který není použit nebo XmlSerializer je neodkazován.

Platí pro

Bezpečný přístup z více vláken

Tento typ je bezpečný pro přístup z více vláken.

Viz také