XmlSerializer Classe

Definizione

Serializza e deserializza oggetti in e da documenti XML. XmlSerializer consente di controllare le modalità di codifica degli oggetti in XML.

public class XmlSerializer
Ereditarietà
XmlSerializer

Esempio

L'esempio seguente contiene due classi principali: PurchaseOrder e Test. La PurchaseOrder classe contiene informazioni su un singolo acquisto. La Test classe contiene i metodi che creano l'ordine di acquisto e che leggeno l'ordine di acquisto creato.

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

Commenti

Per altre informazioni su questa API, vedere Osservazioni api supplementari per XmlSerializer.

Costruttori

XmlSerializer()

Inizializza una nuova istanza della classe XmlSerializer.

XmlSerializer(Type)

Inizializza una nuova istanza della classe XmlSerializer in grado di serializzare gli oggetti del tipo specificato in documenti XML e di deserializzare documenti XML in oggetti del tipo specificato.

XmlSerializer(Type, String)

Inizializza una nuova istanza della classe XmlSerializer in grado di serializzare gli oggetti del tipo specificato in documenti XML e di deserializzare documenti XML in oggetti del tipo specificato. Specifica lo spazio dei nomi predefinito per tutti gli elementi XML.

XmlSerializer(Type, Type[])

Inizializza una nuova istanza della classe XmlSerializer in grado di serializzare gli oggetti del tipo specificato in documenti XML e di deserializzare documenti XML in oggetti di un tipo specificato. Se una proprietà o un campo restituisce una matrice, il parametro extraTypes specifica gli oggetti che possono essere inseriti nella matrice.

XmlSerializer(Type, XmlAttributeOverrides)

Inizializza una nuova istanza della classe XmlSerializer in grado di serializzare gli oggetti del tipo specificato in documenti XML e di deserializzare documenti XML in oggetti del tipo specificato. Ciascun oggetto da serializzare può contenere istanze di classi e questo overload può eseguire l'override con altre classi.

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

Inizializza una nuova istanza della classe XmlSerializer in grado di serializzare oggetti di tipo Object in istanze di documento XML e di deserializzare istanze di documento XML in oggetti di tipo Object. Ciascun oggetto da serializzare può contenere istanze di classi e questo overload ne esegue l'override con altre classi. Questo overload specifica inoltre lo spazio dei nomi predefinito per tutti gli elementi XML e la classe da utilizzare come elemento XML di primo livello.

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

Inizializza una nuova istanza della classe XmlSerializer in grado di serializzare oggetti di tipo Object in istanze di documento XML e di deserializzare istanze di documento XML in oggetti di tipo Object. Ciascun oggetto da serializzare può contenere istanze di classi e questo overload ne esegue l'override con altre classi. Questo overload specifica inoltre lo spazio dei nomi predefinito per tutti gli elementi XML e la classe da utilizzare come elemento XML di primo livello.

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

Inizializza una nuova istanza della classe XmlSerializer in grado di serializzare gli oggetti del tipo specificato in istanze di documento XML e di deserializzare istanze di documento XML in oggetti del tipo specificato. Questo overload consente di fornire altri tipi rilevabili durante un'operazione di serializzazione o deserializzazione, nonché uno spazio dei nomi predefinito per tutti gli elementi XML, la classe da utilizzare come elemento XML di primo livello, la relativa posizione e le credenziali necessarie per l'accesso.

XmlSerializer(Type, XmlRootAttribute)

Inizializza una nuova istanza della classe XmlSerializer in grado di serializzare gli oggetti del tipo specificato in documenti XML e di deserializzare documenti XML in oggetti del tipo specificato. Specifica inoltre la classe da utilizzare come elemento XML di primo livello.

XmlSerializer(XmlTypeMapping)

Inizializza un'istanza della classe XmlSerializer tramite un oggetto che esegue il mapping di un tipo a un altro.

Metodi

CanDeserialize(XmlReader)

Ottiene un valore che indica se questo XmlSerializer può deserializzare un documento XML specificato.

CreateReader()

Restituisce un oggetto utilizzato per leggere il documento XML da serializzare.

CreateWriter()

Quando sottoposto a override in una classe derivata, restituisce un writer utilizzato per serializzare l'oggetto.

Deserialize(Stream)

Deserializza il documento XML contenuto dal Stream specificato.

Deserialize(TextReader)

Deserializza il documento XML contenuto dal TextReader specificato.

Deserialize(XmlReader)

Deserializza il documento XML contenuto dal XmlReader specificato.

Deserialize(XmlReader, String)

Deserializza il documento XML contenuto nel XmlReader specificato e lo stile di codifica.

Deserialize(XmlReader, String, XmlDeserializationEvents)

Deserializza l'oggetto utilizzando i dati contenuti nell'oggetto XmlReader specificato.

Deserialize(XmlReader, XmlDeserializationEvents)

Deserializza un documento XML contenuto nell'oggetto XmlReader specificato e consente l'override degli eventi che si verificano durante la deserializzazione.

Deserialize(XmlSerializationReader)

Deserializza il documento XML contenuto dal XmlSerializationReader specificato.

Equals(Object)

Determina se l'oggetto specificato è uguale all'oggetto corrente.

(Ereditato da Object)
FromMappings(XmlMapping[])

Restituisce una matrice di oggetti XmlSerializer creati da una matrice di oggetti XmlTypeMapping.

FromMappings(XmlMapping[], Evidence)
Obsoleti.

Restituisce un'istanza della classe XmlSerializer creata dai mapping di un tipo XML a un altro.

FromMappings(XmlMapping[], Type)

Restituisce un'istanza della classe XmlSerializer dai mapping specificati.

FromTypes(Type[])

Restituisce una matrice di oggetti XmlSerializer creati da una matrice di tipi.

GenerateSerializer(Type[], XmlMapping[])

Restituisce un assembly contenente serializzatori personalizzati utilizzati per serializzare o deserializzare i tipi specificati, mediante i mapping specificati.

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

Restituisce un assembly contenente serializzatori personalizzati utilizzati per serializzare o deserializzare i tipi specificati, mediante le impostazioni e opzioni del compilatore e i mapping specificati.

GetHashCode()

Funge da funzione hash predefinita.

(Ereditato da Object)
GetType()

Ottiene l'oggetto Type dell'istanza corrente.

(Ereditato da Object)
GetXmlSerializerAssemblyName(Type)

Restituisce il nome dell'assembly contenente una o più versioni di XmlSerializer appositamente create per serializzare o deserializzare il tipo specificato.

GetXmlSerializerAssemblyName(Type, String)

Restituisce il nome dell'assembly contenente il serializzatore per il tipo specificato nello spazio dei nomi specificato.

MemberwiseClone()

Crea una copia superficiale dell'oggetto Object corrente.

(Ereditato da Object)
Serialize(Object, XmlSerializationWriter)

Serializza l'Object specificato e scrive il documento XML in un file utilizzando il XmlSerializationWriter specificato.

Serialize(Stream, Object)

Serializza l'Object specificato e scrive il documento XML in un file utilizzando il Stream specificato.

Serialize(Stream, Object, XmlSerializerNamespaces)

Serializza l'oggetto Object specificato e scrive il documento XML in un file mediante l'oggetto Stream specificato, che fa riferimento agli spazi dei nomi specificati.

Serialize(TextWriter, Object)

Serializza l'Object specificato e scrive il documento XML in un file utilizzando il TextWriter specificato.

Serialize(TextWriter, Object, XmlSerializerNamespaces)

Serializza l'oggetto Object specificato e scrive il documento XML in un file mediante l'oggetto TextWriter specificato, facendo riferimento agli spazi dei nomi specificati.

Serialize(XmlWriter, Object)

Serializza l'Object specificato e scrive il documento XML in un file utilizzando il XmlWriter specificato.

Serialize(XmlWriter, Object, XmlSerializerNamespaces)

Serializza l'oggetto Object specificato e scrive il documento XML in un file mediante l'oggetto XmlWriter specificato, facendo riferimento agli spazi dei nomi specificati.

Serialize(XmlWriter, Object, XmlSerializerNamespaces, String)

Serializza l'oggetto specificato e scrive il documento XML in un file mediante l'oggetto XmlWriter specificato, facendo riferimento agli spazi dei nomi specificati.

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

Serializza l'oggetto Object specificato e scrive il documento XML in un file mediante l'oggetto XmlWriter, gli spazi dei nomi XML e la codifica specificati.

ToString()

Restituisce una stringa che rappresenta l'oggetto corrente.

(Ereditato da Object)

Eventi

UnknownAttribute

Si verifica quando XmlSerializer incontra un attributo XML di tipo sconosciuto durante la deserializzazione.

UnknownElement

Si verifica quando XmlSerializer incontra un elemento XML di tipo sconosciuto durante la deserializzazione.

UnknownNode

Si verifica quando XmlSerializer incontra un nodo XML di tipo sconosciuto durante la deserializzazione.

UnreferencedObject

Si verifica durante la deserializzazione di un flusso XML con codifica SOAP, quando XmlSerializer rileva un tipo riconosciuto che non viene utilizzato o a cui non viene fatto riferimento.

Si applica a

Prodotto Versioni
.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

Thread safety

Questo tipo è thread-safe.

Vedi anche