XmlSerializer Classe

Définition

Sérialise et désérialise des objets vers et depuis des documents XML. XmlSerializer permet de contrôler le mode d'encodage des objets en langage XML.

public ref class XmlSerializer
public class XmlSerializer
type XmlSerializer = class
Public Class XmlSerializer
Héritage
XmlSerializer

Exemples

L’exemple suivant contient deux classes principales : PurchaseOrder et Test . La PurchaseOrder classe contient des informations sur un seul achat. La Test classe contient les méthodes qui créent le bon de commande et qui lisent le bon de commande créé.

#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

Remarques

La sérialisation XML est le processus qui consiste à convertir des propriétés et champs publics d'un objet dans un format série (dans ce cas, XML) à des fins de stockage et de transport. La désérialisation recrée l’objet dans son état d’origine à partir de la sortie XML. Vous pouvez considérer la sérialisation comme un moyen d’enregistrer l’état d’un objet dans un flux ou une mémoire tampon. par exemple, ASP.NET utilise la XmlSerializer classe pour encoder des messages de service Web XML.

Les données de vos objets sont décrites à l'aide des constructions d'un langage de programmation, telles que les classes, les champs, les propriétés, les types primitifs, les tableaux voire du code XML incorporé sous forme d'objets XmlElement ou XmlAttribute. Vous avez la possibilité de créer vos propres classes, annotées avec des attributs, ou d’utiliser l' outil XML Schema Definition (Xsd.exe) pour générer les classes basées sur un document XSD (XML Schema Definition) existant. Si vous disposez d’un schéma XML, vous pouvez exécuter le Xsd.exe pour produire un ensemble de classes fortement typées dans le schéma et annotées avec des attributs pour adhérer au schéma lorsqu’il est sérialisé.

Pour transférer des données entre des objets et XML, vous devez disposer d’un mappage des constructions du langage de programmation au schéma XML et du schéma XML vers les constructions du langage de programmation. Le XmlSerializer et les outils associés comme Xsd.exe fournissent la passerelle entre ces deux technologies à la fois au moment de la conception et au moment de l’exécution. Au moment du design, utilisez la Xsd.exe pour générer un document de schéma XML (. xsd) à partir de vos classes personnalisées ou pour produire des classes à partir d’un schéma donné. Dans les deux cas, les classes sont annotées avec des attributs personnalisés pour indiquer à XmlSerializer comment mapper entre le système de schéma XML et le Common Language Runtime. Lors de l’exécution, les instances des classes peuvent être sérialisées en documents XML qui suivent le schéma donné. De même, ces documents XML peuvent être désérialisés en objets d’exécution. Notez que le schéma XML est facultatif et non requis au moment de la conception ou de l’exécution.

Contrôle du code XML généré

Pour contrôler le code XML généré, vous pouvez appliquer des attributs spéciaux aux classes et aux membres. Par exemple, pour spécifier un autre nom d’élément XML, appliquez un XmlElementAttribute à un champ public ou une propriété, puis définissez la ElementName propriété. Pour obtenir la liste complète des attributs similaires, consultez attributs qui contrôlent la SÉRIALISATION XML. Vous pouvez également implémenter l' IXmlSerializable interface pour contrôler la sortie XML.

Si le code XML généré doit se conformer à la section 5 du document du World global Consortium, SOAP (Simple Object Access Protocol) 1,1, vous devez construire le XmlSerializer avec un XmlTypeMapping . Pour mieux contrôler le code XML SOAP encodé, utilisez les attributs listés dans attributs qui contrôlent la sérialisation encodée selon le protocole SOAP.

Avec XmlSerializer , vous pouvez tirer parti de l’utilisation des classes fortement typées tout en gardant la flexibilité du langage XML. À l’aide de champs ou de propriétés de type XmlElement , XmlAttribute ou XmlNode dans vos classes fortement typées, vous pouvez lire des parties du document XML directement dans des objets XML.

Si vous utilisez des schémas XML extensibles, vous pouvez également utiliser les XmlAnyElementAttribute XmlAnyAttributeAttribute attributs et pour sérialiser et désérialiser des éléments ou des attributs qui sont introuvables dans le schéma d’origine. Pour utiliser les objets, appliquez XmlAnyElementAttribute à un champ qui retourne un tableau d' XmlElement objets ou appliquez un XmlAnyAttributeAttribute à un champ qui retourne un tableau d' XmlAttribute objets.

Si une propriété ou un champ retourne un objet complexe (tel qu'un tableau ou une instance de classe), XmlSerializer le convertit en élément imbriqué dans le document XML principal. Par exemple, la première classe dans le code suivant retourne une instance de la deuxième classe.

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

La sortie XML sérialisée ressemble à ceci :

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

Si un schéma contient un élément facultatif (minOccurs = ' 0 '), ou si le schéma contient une valeur par défaut, vous avez deux options. L’une des options consiste à utiliser System.ComponentModel.DefaultValueAttribute pour spécifier la valeur par défaut, comme indiqué dans le code suivant.

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

Une autre option consiste à utiliser un modèle spécial pour créer un champ booléen reconnu par le XmlSerializer et à appliquer au XmlIgnoreAttribute champ. Le modèle est créé sous la forme de propertyNameSpecified . Par exemple, s’il existe un champ nommé « MyFirstName », vous créez également un champ nommé « MyFirstNameSpecified » qui indique XmlSerializer si l’élément XML nommé « MyFirstName » doit être généré. Cela est illustré par l'exemple suivant.

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

Substitution de la sérialisation par défaut

Vous pouvez également substituer la sérialisation de n’importe quel jeu d’objets et de leurs champs et propriétés en créant l’un des attributs appropriés et en l’ajoutant à une instance de la XmlAttributes classe. La substitution de la sérialisation de cette manière a deux utilisations : tout d’abord, vous pouvez contrôler et augmenter la sérialisation des objets trouvés dans une DLL, même si vous n’avez pas accès à la source. Deuxièmement, vous pouvez créer un ensemble de classes sérialisables, mais sérialiser les objets de plusieurs façons. Pour plus d’informations, consultez la XmlAttributeOverrides classe et Comment : contrôler la sérialisation de classes dérivées.

Pour sérialiser un objet, appelez la Serialize méthode. Pour désérialiser un objet, appelez la Deserialize méthode.

Pour ajouter des espaces de noms XML à un document XML, consultez XmlSerializerNamespaces .

Notes

Le XmlSerializer offre un traitement spécial aux classes qui implémentent IEnumerable ou ICollection . Une classe qui implémente IEnumerable doit implémenter une méthode Add publique n'acceptant qu'un paramètre. Le Add paramètre de la méthode doit être du même type que celui retourné par la Current propriété sur la valeur retournée à partir de GetEnumerator ou de l’une des bases de ce type. Une classe qui implémente ICollection (comme CollectionBase ) en plus de IEnumerable doit avoir une Item propriété indexée publique (indexeur en C#) qui prend un entier et qui doit avoir une Count propriété publique de type entier. Le paramètre de la Add méthode doit être du même type que celui retourné par la Item propriété ou l’une des bases de ce type. Pour les classes qui implémentent ICollection , les valeurs à sérialiser sont récupérées à partir de la propriété indexée Item , et non en appelant GetEnumerator .

Vous devez avoir l’autorisation d’écrire dans le répertoire temporaire (tel que défini par la variable d’environnement TEMP) pour désérialiser un objet.

Assemblys générés dynamiquement

Pour améliorer les performances, l’infrastructure de sérialisation XML génère dynamiquement des assemblys pour sérialiser et désérialiser les types spécifiés. L’infrastructure recherche et réutilise ces assemblys. Ce comportement se produit uniquement lors de l’utilisation des constructeurs suivants :

XmlSerializer.XmlSerializer(Type)

XmlSerializer.XmlSerializer(Type, String)

Si vous utilisez l’un des autres constructeurs, plusieurs versions du même assembly sont générées et ne sont jamais déchargées, ce qui entraîne une fuite de mémoire et des performances médiocres. La solution la plus simple consiste à utiliser l’un des deux constructeurs mentionnés précédemment. Dans le cas contraire, vous devez mettre en cache les assemblys dans un Hashtable , comme indiqué dans l’exemple suivant.

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.

Sérialisation des listes ArrayList et Generic

Le XmlSerializer ne peut pas sérialiser ou désérialiser les éléments suivants :

Sérialisation des énumérations de unsigned long

XmlSerializerNe peut pas être instancié pour sérialiser une énumération si les conditions suivantes sont vraies : l’énumération est de type unsigned long ( ulong en C#) et l’énumération contient tout membre dont la valeur est supérieure à 9 223 372 036 854 775 807. Par exemple, les éléments suivants ne peuvent pas être sérialisés.

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

Les objets marqués avec l’attribut obsolète ne sont plus sérialisés

dans le .NET Framework 3,5, la XmlSerializer classe ne sérialise plus les objets marqués comme [Obsolete] .

Constructeurs

XmlSerializer()

Initialise une nouvelle instance de la classe XmlSerializer.

XmlSerializer(Type)

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié.

XmlSerializer(Type, String)

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié. Spécifie l'espace de noms par défaut de tous les éléments XML.

XmlSerializer(Type, Type[])

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié. Si une propriété ou un champ retourne un tableau, le paramètre extraTypes spécifie les objets pouvant être insérés dans ce tableau.

XmlSerializer(Type, XmlAttributeOverrides)

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié. Chaque objet à sérialiser peut lui-même contenir des instances de classes auxquelles cette surcharge peut substituer d'autres classes.

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

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type Object en documents XML et désérialiser, les documents XML en objets du type Object. Chaque objet à sérialiser peut lui-même contenir des instances de classes auxquelles cette surcharge peut substituer d'autres classes. Cette surcharge spécifie également l'espace de noms par défaut de tous les éléments XML ainsi que la classe à utiliser en tant qu'élément racine XML.

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

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type Object en documents XML et désérialiser, les documents XML en objets du type Object. Chaque objet à sérialiser peut lui-même contenir des instances de classes auxquelles cette surcharge peut substituer d'autres classes. Cette surcharge spécifie également l'espace de noms par défaut de tous les éléments XML ainsi que la classe à utiliser en tant qu'élément racine XML.

XmlSerializer(Type, XmlAttributeOverrides, Type[], XmlRootAttribute, String, String, Evidence)
Obsolète.

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié. Cette surcharge vous permet de fournir d'autres types qui peuvent être rencontrés pendant une sérialisation ou une désérialisation, ainsi qu'un espace de noms par défaut pour tous les éléments XML, la classe à utiliser comme élément racine XML, son emplacement et les informations d'identification requises pour y accéder.

XmlSerializer(Type, XmlRootAttribute)

Initialise une nouvelle instance de la classe XmlSerializer qui peut sérialiser les objets du type spécifié en documents XML et désérialiser les documents XML en objets du type spécifié. Spécifie également la classe à utiliser en tant qu'élément racine XML.

XmlSerializer(XmlTypeMapping)

Initialise une instance de la classe XmlSerializer à l'aide d'un objet qui établit une correspondance entre les types.

Méthodes

CanDeserialize(XmlReader)

Obtient une valeur qui indique si XmlSerializer peut désérialiser un document XML spécifié.

CreateReader()

Retourne un objet utilisé pour lire le document XML à sérialiser.

CreateWriter()

En cas de substitution dans une classe dérivée, retourne un writer utilisé pour sérialiser l'objet.

Deserialize(Stream)

Désérialise le document XML qui figure dans le Stream spécifié.

Deserialize(TextReader)

Désérialise le document XML qui figure dans le TextReader spécifié.

Deserialize(XmlReader)

Désérialise le document XML qui figure dans le XmlReader spécifié.

Deserialize(XmlReader, String)

Désérialise le document XML figurant dans le XmlReader spécifié et le style d'encodage.

Deserialize(XmlReader, String, XmlDeserializationEvents)

Désérialise l'objet à l'aide des données contenues dans le XmlReader spécifié.

Deserialize(XmlReader, XmlDeserializationEvents)

Désérialise un document XML contenu par le XmlReader spécifié et autorise la substitution des événements qui se produisent pendant désérialisation.

Deserialize(XmlSerializationReader)

Désérialise le document XML qui figure dans le XmlSerializationReader spécifié.

Equals(Object)

Détermine si l'objet spécifié est égal à l'objet actuel.

(Hérité de Object)
FromMappings(XmlMapping[])

Retourne un tableau d'objets XmlSerializer créés à partir d'un tableau d'objets XmlTypeMapping.

FromMappings(XmlMapping[], Evidence)
Obsolète.

Retourne une instance de la classe XmlSerializer créée à partir de mappages d'un type XML à un autre.

FromMappings(XmlMapping[], Type)

Retourne une instance de la classe XmlSerializer à partir des mappages spécifiés.

FromTypes(Type[])

Retourne un tableau d'objets XmlSerializer créés à partir d'un tableau de types.

GenerateSerializer(Type[], XmlMapping[])

Retourne un assembly qui contient des sérialiseurs faits sur commande et utilisés pour sérialiser ou désérialiser le ou les types spécifiés, à l'aide des mappages indiqués.

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

Retourne un assembly qui contient des sérialiseurs faits sur commande et utilisés pour sérialiser ou désérialiser le ou les types spécifiés, à l'aide des mappages et des paramètres et options de compilateur spécifiés.

GetHashCode()

Fait office de fonction de hachage par défaut.

(Hérité de Object)
GetType()

Obtient le Type de l'instance actuelle.

(Hérité de Object)
GetXmlSerializerAssemblyName(Type)

Retourne le nom de l'assembly qui contient une ou plusieurs versions du XmlSerializer créé spécialement pour sérialiser ou désérialiser le type spécifié.

GetXmlSerializerAssemblyName(Type, String)

Retourne le nom de l'assembly qui contient le sérialiseur pour le type spécifié dans l'espace de noms indiqué.

MemberwiseClone()

Crée une copie superficielle du Object actuel.

(Hérité de Object)
Serialize(Object, XmlSerializationWriter)

Sérialise le Object spécifié et écrit le document XML dans un fichier à l'aide du XmlSerializationWriter spécifié.

Serialize(Stream, Object)

Sérialise le Object spécifié et écrit le document XML dans un fichier à l'aide du Stream spécifié.

Serialize(Stream, Object, XmlSerializerNamespaces)

Sérialise l’objet Object spécifié et écrit le document XML dans un fichier à l’aide du Stream spécifié qui référence les espaces de noms spécifiés.

Serialize(TextWriter, Object)

Sérialise le Object spécifié et écrit le document XML dans un fichier à l'aide du TextWriter spécifié.

Serialize(TextWriter, Object, XmlSerializerNamespaces)

Sérialise le Object spécifié et écrit le document XML dans un fichier à l'aide du TextWriter spécifié qui référence les espaces de noms spécifiés.

Serialize(XmlWriter, Object)

Sérialise le Object spécifié et écrit le document XML dans un fichier à l'aide du XmlWriter spécifié.

Serialize(XmlWriter, Object, XmlSerializerNamespaces)

Sérialise le Object spécifié et écrit le document XML dans un fichier à l'aide du XmlWriter spécifié qui référence les espaces de noms spécifiés.

Serialize(XmlWriter, Object, XmlSerializerNamespaces, String)

Sérialise l'objet spécifié et écrit le document XML dans un fichier à l'aide du XmlWriter et référence les espaces de noms spécifiés et le style d'encodage.

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

Sérialise le Object spécifié et écrit le document XML dans un fichier à l'aide du XmlWriter, des espaces de noms et de l'encodage spécifiés.

ToString()

Retourne une chaîne qui représente l'objet actuel.

(Hérité de Object)

Événements

UnknownAttribute

Se produit lorsque, pendant la désérialisation, XmlSerializer rencontre un attribut XML de type inconnu.

UnknownElement

Se produit lorsque, pendant la désérialisation, XmlSerializer rencontre un élément XML de type inconnu.

UnknownNode

Se produit lorsque, pendant la désérialisation, XmlSerializer rencontre un nœud XML de type inconnu.

UnreferencedObject

Se produit lors de la désérialisation d'un flux XML encodé à l'aide de SOAP, lorsque XmlSerializer rencontre un type reconnu mais non utilisé ou non référencé.

S’applique à

Cohérence de thread

Ce type est thread-safe.

Voir aussi