XmlSerializer Klasse

Definition

Serialisiert und deserialisiert Objekte in und aus XML-Dokumenten. Mit XmlSerializer können Sie steuern, wie Objekte in XML codiert werden.

public ref class XmlSerializer
public class XmlSerializer
type XmlSerializer = class
Public Class XmlSerializer
Vererbung
XmlSerializer

Beispiele

Das folgende Beispiel enthält zwei Hauptklassen: PurchaseOrder und Test. Die PurchaseOrder Klasse enthält Informationen zu einem einzelnen Kauf. Die Test Klasse enthält die Methoden, die die Bestellung erstellen und die die erstellte Bestellung lesen.

#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

Hinweise

Die XML-Serialisierung ist die Konvertierung der öffentlichen Eigenschaften und Felder eines Objekts in ein serielles Format (in diesem Fall XML) zum Zweck der Speicherung und Übermittlung. Die Deserialisierung erstellt das Objekt in seinem ursprünglichen Zustand aus der XML-Ausgabe neu. Sie können sich die Serialisierung als Möglichkeit vorstellen, den Zustand eines Objekts in einem Datenstrom oder Puffer zu speichern. Beispielsweise verwendet ASP.NET die Klasse zum Codieren von XmlSerializer XML-Webdienstnachrichten.

Die Daten des Objekts werden durch Konstrukte der Programmiersprache beschrieben, z. B. Klassen, Felder, Eigenschaften, primitive Typen, Arrays oder auch eingebettetes XML in Form von XmlElement-Objekten oder XmlAttribute-Objekten. Sie haben die Möglichkeit, eigene Klassen zu erstellen, mit Attributen versehen oder das XML-Schemadefinitionstool (Xsd.exe) zu verwenden, um die Klassen basierend auf einem vorhandenen XML-Schemadefinitionsdokument (XSD)-Dokument zu generieren. Wenn Sie über ein XML-Schema verfügen, können Sie die Xsd.exe ausführen, um eine Reihe von Klassen zu erstellen, die stark in das Schema eingegeben und mit Attributen versehen werden, die beim Serialisieren des Schemas beachtet werden sollen.

Zum Übertragen von Daten zwischen Objekten und XML ist eine Zuordnung aus den Programmiersprachenkonstrukten zum XML-Schema und vom XML-Schema bis zu den Programmiersprachenkonstrukten erforderlich. Die XmlSerializer und verwandten Tools wie Xsd.exe bieten die Brücke zwischen diesen beiden Technologien sowohl zur Entwurfszeit als auch zur Laufzeit. Verwenden Sie zur Entwurfszeit die Xsd.exe, um ein XML-Schemadokument (XSD) aus Ihren benutzerdefinierten Klassen zu erstellen oder Klassen aus einem bestimmten Schema zu erstellen. In beiden Fällen werden die Klassen mit benutzerdefinierten Attributen kommentiert, um die XmlSerializer Zuordnung zwischen dem XML-Schemasystem und der Gemeinsamen Sprachlaufzeit zu ermöglichen. Zur Laufzeit können Instanzen der Klassen in XML-Dokumente serialisiert werden, die dem angegebenen Schema folgen. Ebenso können diese XML-Dokumente in Laufzeitobjekte deserialisiert werden. Beachten Sie, dass das XML-Schema optional ist und nicht zur Entwurfszeit oder Laufzeit erforderlich ist.

Steuern generierter XML-Daten

Um das generierte XML zu steuern, können Sie spezielle Attribute auf Klassen und Member anwenden. Wenn Sie beispielsweise einen anderen XML-Elementnamen angeben möchten, wenden Sie ein XmlElementAttribute öffentliches Feld oder eine Eigenschaft an, und legen Sie die ElementName Eigenschaft fest. Eine vollständige Liste ähnlicher Attribute finden Sie unter "Attribute That Control XML Serialization". Sie können die IXmlSerializable Schnittstelle auch implementieren, um die XML-Ausgabe zu steuern.

Wenn der generierte XML-Code den Abschnitt 5 des World Wide Consortium-Dokuments entsprechen muss, müssen Sie das XmlSerializer Dokument mit dem XmlTypeMappingSimple Object Access Protocol (SOAP) 1.1 erstellen. Um die codierte SOAP-XML weiter zu steuern, verwenden Sie die in Attributen aufgeführten Attribute, die die codierte SOAP-Serialisierung steuern.

Mit dem XmlSerializer Vorteil, dass Sie mit stark typierten Klassen arbeiten können und dennoch die Flexibilität von XML haben. Mithilfe von Feldern oder Eigenschaften des Typs XmlElementXmlAttribute oder XmlNode in Ihren stark typierten Klassen können Sie Teile des XML-Dokuments direkt in XML-Objekte lesen.

Wenn Sie mit erweiterbaren XML-Schemas arbeiten, können Sie auch die XmlAnyElementAttribute XmlAnyAttributeAttribute Attribute verwenden, um Elemente oder Attribute zu serialisieren und zu deserialisieren, die im ursprünglichen Schema nicht gefunden werden. Wenn Sie die Objekte verwenden möchten, wenden Sie ein XmlAnyElementAttribute Feld an, das ein Array von XmlElement Objekten zurückgibt, oder wenden Sie ein XmlAnyAttributeAttribute Feld an, das ein Array von XmlAttribute Objekten zurückgibt.

Wenn eine Eigenschaft oder ein Feld ein komplexes Objekt zurückgibt (z. B. ein Array oder eine Klasseninstanz), wird dieses von XmlSerializer in ein Element konvertiert, das innerhalb des XML-Hauptdokuments geschachtelt ist. Die erste Klasse im folgenden Code gibt beispielsweise eine Instanz der zweiten Klasse zurück.

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

Die serialisierte XML-Ausgabe sieht wie folgt aus:

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

Wenn ein Schema ein Element enthält, das optional ist (minOccurs = '0'), oder wenn das Schema einen Standardwert enthält, haben Sie zwei Optionen. Eine Option besteht darin, System.ComponentModel.DefaultValueAttribute den Standardwert anzugeben, wie im folgenden Code gezeigt.

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

Eine weitere Option besteht darin, ein spezielles Muster zum Erstellen eines vom XmlSerializerBooleschen Feld erkannten Felds zu verwenden und das XmlIgnoreAttribute Feld anzuwenden. Das Muster wird in Form von propertyNameSpecified. Wenn beispielsweise ein Feld namens "MyFirstName" vorhanden ist, erstellen Sie auch ein Feld namens "MyFirstNameSpecified", das angibt XmlSerializer , ob das XML-Element mit dem Namen "MyFirstName" generiert werden soll. Dies wird im folgenden Beispiel gezeigt.

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

Überschreiben der Standard serialisierung

Sie können auch die Serialisierung beliebiger Objekte und deren Felder und Eigenschaften außer Kraft setzen, indem Sie eines der entsprechenden Attribute erstellen und sie einer Instanz der XmlAttributes Klasse hinzufügen. Überschreiben der Serialisierung auf diese Weise verfügt über zwei Verwendungen: Zuerst können Sie die Serialisierung von Objekten steuern und erweitern, die in einer DLL gefunden werden, auch wenn Sie keinen Zugriff auf die Quelle haben; Zweitens können Sie eine Reihe serialisierbarer Klassen erstellen, aber die Objekte auf mehrere Arten serialisieren. Weitere Informationen finden Sie in der Klasse und vorgehensweise: Steuern der XmlAttributeOverrides Serialisierung abgeleiteter Klassen.

Rufen Sie die Serialize Methode auf, um ein Objekt zu serialisieren. Rufen Sie die Deserialize Methode auf, um ein Objekt zu deserialisieren.

Informationen zum Hinzufügen von XML-Namespaces zu einem XML-Dokument finden Sie unter XmlSerializerNamespaces.

Hinweis

Die XmlSerializer spezielle Behandlung von Klassen, die implementieren oder ICollection.IEnumerable Eine Klasse, die IEnumerable implementiert, muss eine öffentliche Add-Methode mit einem einzigen Parameter implementieren. Der Add Parameter der Methode muss denselben Typ aufweisen, der von der Eigenschaft für den Current zurückgegebenen GetEnumeratorWert oder die Basis dieses Typs zurückgegeben wird. Eine Klasse, die zusätzlich IEnumerable zu einer öffentlichen indizierten Eigenschaft (Indexer in C#) implementiert ICollection wird , CollectionBasedie eine ganze Zahl verwendet, und sie muss über eine öffentliche Item Count Eigenschaft vom Typ integer verfügen. Der Parameter für die Add Methode muss denselben Typ aufweisen, der von der Item Eigenschaft oder einer der Basen dieses Typs zurückgegeben wird. Für Klassen, die implementieren ICollection, werden Werte, die serialisiert werden sollen, aus der indizierten Item Eigenschaft abgerufen, nicht durch Aufrufen GetEnumerator.

Sie müssen über die Berechtigung zum Schreiben in das temporäre Verzeichnis (wie durch die TEMP-Umgebungsvariable definiert) verfügen, um ein Objekt zu deserialisieren.

Dynamisch generierte Assemblys

Um die Leistung zu erhöhen, generiert die XML-Serialisierungsinfrastruktur dynamisch Assemblys zum Serialisieren und Deserialisieren der angegebenen Typen. Die Infrastruktur findet und wiederverwendet diese Assemblys. Dieses Verhalten tritt nur bei Verwendung der folgenden Konstruktoren auf:

XmlSerializer.XmlSerializer(Type)

XmlSerializer.XmlSerializer(Type, String)

Wenn Sie einen der anderen Konstruktoren verwenden, werden mehrere Versionen derselben Assembly generiert und nie entladen, was zu einem Speicherverlust und einer schlechten Leistung führt. Die einfachste Lösung besteht darin, einen der zuvor erwähnten beiden Konstruktoren zu verwenden. Andernfalls müssen Sie die Assemblys in einem Hashtable, wie im folgenden Beispiel gezeigt, zwischenspeichern.

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.

Serialisierung von ArrayList und generischer Liste

Die XmlSerializer folgende Serialisierung oder Deerialisierung ist nicht möglich:

Serialisierung von Enumerationen von nicht signierten Long

Die XmlSerializer Instanziierung einer Enumeration kann nicht instanziiert werden, wenn die folgenden Bedingungen erfüllt sind: Die Enumeration ist vom Typ "nicht signiert" (ulong in C#) und die Enumeration enthält ein Element mit einem Wert, der größer als 9.223.372.036.854.775.807 ist. Beispielsweise kann folgendes nicht serialisiert werden.

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

Objekte, die mit dem veralteten Attribut gekennzeichnet sind, werden nicht mehr serialisiert

In der .NET Framework 3.5 serialisiert die XmlSerializer Klasse keine Objekte mehr, die als [Obsolete]gekennzeichnet sind.

Konstruktoren

XmlSerializer()

Initialisiert eine neue Instanz der XmlSerializer-Klasse.

XmlSerializer(Type)

Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in XML-Dokumente serialisieren und XML-Dokumente in Objekte des angegebenen Typs deserialisieren kann.

XmlSerializer(Type, String)

Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in XML-Dokumente serialisieren und XML-Dokumente in Objekte des angegebenen Typs deserialisieren kann. Gibt den Standardnamespace für alle XML-Elemente an.

XmlSerializer(Type, Type[])

Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in XML-Dokumente serialisieren und XML-Dokumente in ein Objekt eines angegebenen Typs deserialisieren kann. Wenn eine Eigenschaft oder ein Feld ein Array zurückgibt, werden durch den extraTypes-Parameter die Objekte angegeben, die in das Array eingefügt werden können.

XmlSerializer(Type, XmlAttributeOverrides)

Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in XML-Dokumente serialisieren und XML-Dokumente in Objekte des angegebenen Typs deserialisieren kann. Jedes zu serialisierende Objekt kann selbst Instanzen von Klassen enthalten, die von dieser Überladung durch andere Klassen überschrieben werden können.

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

Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte vom Typ Object in Instanzen eines XML-Dokuments serialisieren und Instanzen eines XML-Dokuments in Objekte vom Typ Object deserialisieren kann. Jedes zu serialisierende Objekt kann selbst Instanzen von Klassen enthalten, die von dieser Überladung durch andere Klassen überschrieben werden können. Diese Überladung gibt außerdem den Standardnamespace für alle XML-Elemente sowie die als XML-Stammelement zu verwendende Klasse an.

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

Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte vom Typ Object in Instanzen eines XML-Dokuments serialisieren und Instanzen eines XML-Dokuments in Objekte vom Typ Object deserialisieren kann. Jedes zu serialisierende Objekt kann selbst Instanzen von Klassen enthalten, die von dieser Überladung durch andere Klassen überschrieben werden können. Diese Überladung gibt außerdem den Standardnamespace für alle XML-Elemente sowie die als XML-Stammelement zu verwendende Klasse an.

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

Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in Instanzen von XML-Dokumenten serialisieren und Instanzen von XML-Dokumenten in Objekte des angegebenen Typs deserialisieren kann. Diese Überladung ermöglicht das Bereitstellen anderer Typen, die bei der Serialisierung oder Deserialisierung gefunden werden könnten, sowie eines Standardnamespaces für alle XML-Elemente, der Klasse, die als XML-Stammelement verwendet werden soll, ihres Speicherorts und der für den Zugriff erforderlichen Anmeldeinformationen.

XmlSerializer(Type, XmlRootAttribute)

Initialisiert eine neue Instanz der XmlSerializer-Klasse, die Objekte des angegebenen Typs in XML-Dokumente serialisieren und ein XML-Dokument in ein Objekt des angegebenen Typs deserialisieren kann. Außerdem wird die als XML-Stammelement zu verwendende Klasse angegeben.

XmlSerializer(XmlTypeMapping)

Initialisiert eine Instanz der XmlSerializer-Klasse mithilfe eines Objekts, das einen Typ einem anderen zuweist.

Methoden

CanDeserialize(XmlReader)

Ruft einen Wert ab, der angibt, ob dieser XmlSerializer ein angegebenes XML-Dokument deserialisieren kann.

CreateReader()

Gibt ein Objekt zurück, das zum Lesen des zu serialisierenden XML-Dokuments verwendet wird.

CreateWriter()

Gibt beim Überschreiben in einer abgeleiteten Klasse einen Writer zurück, der zum Serialisieren des Objekts verwendet wird.

Deserialize(Stream)

Deserialisiert das im angegebenen Stream enthaltene XML-Dokument.

Deserialize(TextReader)

Deserialisiert das im angegebenen TextReader enthaltene XML-Dokument.

Deserialize(XmlReader)

Deserialisiert das im angegebenen XmlReader enthaltene XML-Dokument.

Deserialize(XmlReader, String)

Deserialisiert das im angegebenen XmlReader enthaltene XML-Dokument anhand des angegebenen Codierungsstils.

Deserialize(XmlReader, String, XmlDeserializationEvents)

Deserialisiert das Objekt mit den im angegebenen XmlReader enthaltenen Daten.

Deserialize(XmlReader, XmlDeserializationEvents)

Deserialisiert ein im XmlReader enthaltenes XML-Dokument und ermöglicht das Überschreiben der Ereignisse, die während der Deserialisierung eintreten.

Deserialize(XmlSerializationReader)

Deserialisiert das im angegebenen XmlSerializationReader enthaltene XML-Dokument.

Equals(Object)

Bestimmt, ob das angegebene Objekt gleich dem aktuellen Objekt ist.

(Geerbt von Object)
FromMappings(XmlMapping[])

Gibt ein Array von XmlSerializer-Objekten zurück, das aus einem Array von XmlTypeMapping-Objekten erstellt wurde.

FromMappings(XmlMapping[], Evidence)
Veraltet.

Gibt eine Instanz der XmlSerializer-Klasse zurück, die aus Zuordnungen eines XML-Typs zu einem anderen erstellt wurde.

FromMappings(XmlMapping[], Type)

Gibt eine Instanz der XmlSerializer-Klasse aus den angegebenen Zuordnungen zurück.

FromTypes(Type[])

Gibt ein Array von XmlSerializer-Objekten zurück, das aus einem Array von Typen erstellt wurde.

GenerateSerializer(Type[], XmlMapping[])

Gibt eine Assembly mit benutzerdefinierten Serialisierungsprogrammen zurück, die zum Serialisieren oder Deserialisieren des angegebenen Typs oder der angegebenen Typen unter Verwendung der angegebenen Zuordnungen verwendet werden.

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

Gibt eine Assembly mit benutzerdefinierten Serialisierungsprogrammen zurück, die zum Serialisieren oder Deserialisieren des angegebenen Typs oder der angegebenen Typen unter Verwendung der angegebenen Zuordnungen und der Compilereinstellungen und -optionen verwendet werden.

GetHashCode()

Fungiert als Standardhashfunktion.

(Geerbt von Object)
GetType()

Ruft den Type der aktuellen Instanz ab.

(Geerbt von Object)
GetXmlSerializerAssemblyName(Type)

Gibt den Namen der Assembly zurück, die eine oder mehrere Versionen des XmlSerializer enthält, die für das Serialisieren oder Deserialisieren des angegebenen Typs erstellt wurden.

GetXmlSerializerAssemblyName(Type, String)

Gibt den Namen der Assembly zurück, die das Serialisierungsprogramm für den angegebenen Typ im angegebenen Namespace enthält.

MemberwiseClone()

Erstellt eine flache Kopie des aktuellen Object.

(Geerbt von Object)
Serialize(Object, XmlSerializationWriter)

Serialisiert das angegebene Object und schreibt das XML-Dokument über den angegebenen XmlSerializationWriter in eine Datei.

Serialize(Stream, Object)

Serialisiert das angegebene Object und schreibt das XML-Dokument über den angegebenen Stream in eine Datei.

Serialize(Stream, Object, XmlSerializerNamespaces)

Serialisiert das angegebene Object und schreibt das XML-Dokument unter Verwendung des angegebenen Stream in eine Datei, wobei auf die angegebenen Namespaces verwiesen wird.

Serialize(TextWriter, Object)

Serialisiert das angegebene Object und schreibt das XML-Dokument über den angegebenen TextWriter in eine Datei.

Serialize(TextWriter, Object, XmlSerializerNamespaces)

Serialisiert das angegebene Object und schreibt das XML-Dokument unter Verwendung des angegebenen TextWriter in eine Datei, wobei auf die angegebenen Namespaces verwiesen wird.

Serialize(XmlWriter, Object)

Serialisiert das angegebene Object und schreibt das XML-Dokument über den angegebenen XmlWriter in eine Datei.

Serialize(XmlWriter, Object, XmlSerializerNamespaces)

Serialisiert das angegebene Object und schreibt das XML-Dokument unter Verwendung des angegebenen XmlWriter in eine Datei, wobei auf die angegebenen Namespaces verwiesen wird.

Serialize(XmlWriter, Object, XmlSerializerNamespaces, String)

Serialisiert das angegebene Objekt und schreibt das XML-Dokument unter Verwendung des angegebenen XmlWriter in eine Datei, wobei auf die angegebenen Namespaces und den Codierungsstil verwiesen wird.

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

Serialisiert das angegebene Object und schreibt das XML-Dokument unter Verwendung des angegebenen XmlWriter, des angegebenen XML-Namespaces und der angegebenen Codierung in eine Datei.

ToString()

Gibt eine Zeichenfolge zurück, die das aktuelle Objekt darstellt.

(Geerbt von Object)

Ereignisse

UnknownAttribute

Tritt ein, wenn XmlSerializer während der Deserialisierung auf ein XML-Attribut von unbekanntem Typ stößt.

UnknownElement

Tritt ein, wenn XmlSerializer während der Deserialisierung auf ein XML-Element von unbekanntem Typ stößt.

UnknownNode

Tritt ein, wenn XmlSerializer während der Deserialisierung auf einen XML-Knoten von unbekanntem Typ stößt.

UnreferencedObject

Tritt während der Deserialisierung eines SOAP-codierten XML-Streams ein, wenn XmlSerializer auf einen bekannten Typ stößt, der nicht verwendet wird oder auf den nicht verwiesen wird.

Gilt für:

Threadsicherheit

Dieser Typ ist threadsicher.

Siehe auch