XmlSerializer Klas

Definitie

public ref class XmlSerializer

public class XmlSerializer

type XmlSerializer = class

Public Class XmlSerializer

Overname

Object

XmlSerializer

Voorbeelden

Het volgende voorbeeld bevat twee hoofdklassen: PurchaseOrder en Test. De PurchaseOrder klasse bevat informatie over één aankoop. De Test klasse bevat de methoden waarmee de inkooporder wordt gemaakt en die de gemaakte inkooporder lezen.

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

Opmerkingen

XML-serialisatie is het proces van het converteren van de openbare eigenschappen en velden van een object naar een seriële indeling (in dit geval XML) voor opslag of transport. Met de deserialisatie wordt het object opnieuw gemaakt in de oorspronkelijke staat van de XML-uitvoer. U kunt serialisatie beschouwen als een manier om de status van een object op te slaan in een stroom of buffer. ASP.NET gebruikt bijvoorbeeld de XmlSerializer klasse om XML-webserviceberichten te coderen.

De gegevens in uw objecten worden beschreven met behulp van programmeertaalconstructies zoals klassen, velden, eigenschappen, primitieve typen, matrices en zelfs ingesloten XML in de vorm van XmlElement of XmlAttribute objecten. U kunt uw eigen klassen maken, aantekeningen maken met kenmerken of het XML Schema Definition Tool (Xsd.exe) gebruiken om de klassen te genereren op basis van een bestaand XSD-document (XML-schemadefinitie). Als u een XML-schema hebt, kunt u de Xsd.exe uitvoeren om een set klassen te produceren die sterk zijn getypt in het schema en geannoteerd met kenmerken die voldoen aan het schema wanneer ze worden geserialiseerd.

Voor het overdragen van gegevens tussen objecten en XML is een toewijzing van de programmeertaalconstructies naar het XML-schema en van het XML-schema naar de programmeertaalconstructies vereist. De XmlSerializer en gerelateerde hulpprogramma's zoals Xsd.exe bieden de brug tussen deze twee technologieën tijdens zowel ontwerptijd als runtime. Gebruik tijdens het ontwerp de Xsd.exe om een XML-schemadocument (.xsd) te produceren uit uw aangepaste klassen of om klassen uit een bepaald schema te produceren. In beide situaties worden de klassen geannoteerd met aangepaste kenmerken om de XmlSerializer te instrueren hoe de toewijzing tussen het XML-schemasysteem en de Common Language Runtime moet worden uitgevoerd. Tijdens runtime kunnen exemplaren van de klassen worden geserialiseerd in XML-documenten die het opgegeven schema volgen. Op dezelfde manier kunnen deze XML-documenten worden gedeserialiseerd in runtimeobjecten. Houd er rekening mee dat het XML-schema optioneel is en niet vereist is tijdens de ontwerptijd of runtime.

Gegenereerde XML controleren

Als u de gegenereerde XML wilt beheren, kunt u speciale kenmerken toepassen op klassen en leden. Als u bijvoorbeeld een andere XML-elementnaam wilt opgeven, past u een XmlElementAttribute toe op een openbaar veld of een openbare eigenschap en stelt u de ElementName eigenschap in. Zie Kenmerken die XML-serialisatie regelen voor een volledige lijst met vergelijkbare kenmerken. U kunt de IXmlSerializable interface ook implementeren om de XML-uitvoer te beheren.

Als de gegenereerde XML moet voldoen aan sectie 5 van het World Wide Consortium-document, SOAP (Simple Object Access Protocol) 1.1, moet u het XmlSerializer maken met een XmlTypeMapping. Als u de gecodeerde SOAP XML verder wilt beheren, gebruikt u de kenmerken die worden vermeld in Attributes That Control Encoded SOAP Serialization.

Met de XmlSerializer kun je profiteren van werken met sterk getype klassen en tegelijkertijd de flexibiliteit van XML behouden. Met behulp van velden of eigenschappen van het type XmlElement, XmlAttribute of XmlNode in uw sterk getypte klassen, kunt u delen van het XML-document rechtstreeks in XML-objecten lezen.

Als u met uitbreidbare XML-schema's werkt, kunt u ook de XmlAnyElementAttribute en XmlAnyAttributeAttribute kenmerken gebruiken om elementen of kenmerken die niet in het oorspronkelijke schema worden gevonden, te serialiseren en deserialiseren. Als u de objecten wilt gebruiken, past u een XmlAnyElementAttribute toe op een veld dat een matrix met XmlElement objecten retourneert of past u een XmlAnyAttributeAttribute toe op een veld dat een matrix met XmlAttribute objecten retourneert.

Als een eigenschap of veld een complex object retourneert (zoals een matrix of een klasse-exemplaar), wordt dit XmlSerializer geconverteerd naar een element dat is genest in het hoofd-XML-document. De eerste klasse in de volgende code retourneert bijvoorbeeld een exemplaar van de tweede klasse.

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

De geserialiseerde XML-uitvoer ziet er als volgt uit:

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

Als een schema een element bevat dat optioneel is (minOccurs = '0'), of als het schema een standaardwaarde bevat, hebt u twee opties. Een optie is om de standaardwaarde op te System.ComponentModel.DefaultValueAttribute geven, zoals wordt weergegeven in de volgende code.

Public Class PurchaseOrder
    <System.ComponentModel.DefaultValueAttribute ("2002")> _
    Public Year As String
End Class

public class PurchaseOrder
{
    [System.ComponentModel.DefaultValueAttribute ("2002")]
    public string Year;
}

Een andere optie is om een speciaal patroon te gebruiken om een Booleaanse veld te maken dat wordt herkend door het XmlSerializerveld en het XmlIgnoreAttribute toe te passen op het veld. Het patroon wordt gemaakt in de vorm van propertyNameSpecified. Als er bijvoorbeeld een veld met de naam 'MyFirstName' is, maakt u ook een veld met de naam 'MyFirstNameSpecified', waarin wordt aangegeven of het XML-element met de XmlSerializer naam 'MyFirstName' moet worden gegenereerd. Dit wordt weergegeven in het volgende voorbeeld.

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

Standaardserialisatie overschrijven

U kunt ook de serialisatie van een set objecten en de bijbehorende velden en eigenschappen overschrijven door een van de juiste kenmerken te maken en deze toe te voegen aan een exemplaar van de XmlAttributes klasse. Het overschrijven van serialisatie op deze manier heeft twee toepassingen: eerst kunt u de serialisatie van objecten in een DLL beheren en uitbreiden, zelfs als u geen toegang hebt tot de bron; Ten tweede kunt u één set serialiseerbare klassen maken, maar de objecten op meerdere manieren serialiseren. Zie de XmlAttributeOverrides-klasse en Hoe: Serialisatie van Afgeleide Klassen Controleren voor meer details.

Als u een object wilt serialiseren, roept u de Serialize methode aan. Als u een object wilt deserialiseren, roept u de Deserialize methode aan.

Als u XML-naamruimten aan een XML-document wilt toevoegen, raadpleegt u XmlSerializerNamespaces.

U moet gemachtigd zijn om naar de tijdelijke map te schrijven (zoals gedefinieerd door de temp-omgevingsvariabele) om een object te deserialiseren.

Dynamisch gegenereerde assemblies

Om de prestaties te verbeteren, genereert de XML-serialisatie-infrastructuur dynamisch assembly's om opgegeven typen te serialiseren en deserialiseren. De infrastructuur vindt en hergebruikt die onderdelen. Dit gedrag treedt alleen op wanneer u de volgende constructors gebruikt:

XmlSerializer.XmlSerializer(Type)

XmlSerializer.XmlSerializer(Type, String)

Als u een van de andere constructors gebruikt, worden meerdere versies van dezelfde assembly gegenereerd en nooit uitgeladen, wat resulteert in een geheugenlek en slechte prestaties. De eenvoudigste oplossing is het gebruik van een van de eerder genoemde twee constructors. Anders moet u de assembly's in een Hashtablecache opslaan, zoals wordt weergegeven in het volgende voorbeeld.

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.

Serialisatie van matrixlijst en algemene lijst

Het XmlSerializer kan het volgende niet serialiseren of deserialiseren:

• Matrices van ArrayList
• Matrices van List<T>

Serialisatie van opsommingen van niet-ondertekende Long

Het XmlSerializer kan niet worden geïnstantieerd om een opsomming te serialiseren als aan de volgende voorwaarden wordt voldaan: De opsomming is van het type niet-ondertekend lang (ulong in C#) en de opsomming bevat een lid met een waarde die groter is dan 9.223.372.036.854.775.807. Het volgende kan bijvoorbeeld niet worden geserialiseerd.

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

Verouderde typen

De XmlSerializer klasse serialiseert geen objecten die zijn gemarkeerd als [Obsolete].

Veiligheid thread

Dit type is thread veilig.

Zie ook

• XmlAttributeOverrides
• XmlAttributes
• XmlText
• Inleiding tot XML-serialisatie
• Procedure: Geef een alternatieve elementnaam op voor een XML-stream
• XML-serialisatie beheren met behulp van kenmerken
• Voorbeelden van XML-serialisatie
• Xml Schema Definition Tool (Xsd.exe)
• Procedure: Serialisatie van afgeleide klassen beheren
• <dateTimeSerialization-element>
• <XmlSerializer-element>