Afficher en anglais

Partage via


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.

C#
public class XmlSerializer
Héritage
XmlSerializer

Exemples

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

C#
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 + "'");
   }
}

Remarques

Pour plus d’informations sur cette API, consultez Remarques supplémentaires sur l’API pour XmlSerializer.

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 à

Produit Versions
.NET Core 1.0, Core 1.1, Core 2.0, Core 2.1, Core 2.2, Core 3.0, Core 3.1, 5, 6, 7, 8, 9
.NET Framework 1.1, 2.0, 3.0, 3.5, 4.0, 4.5, 4.5.1, 4.5.2, 4.6, 4.6.1, 4.6.2, 4.7, 4.7.1, 4.7.2, 4.8, 4.8.1
.NET Standard 2.0, 2.1
UWP 10.0

Cohérence de thread

Ce type est thread-safe.

Voir aussi