XmlSerializer-Klasse
Serialisiert und deserialisiert Objekte in und aus XML-Dokumenten. Mit XmlSerializer können Sie steuern, wie Objekte in XML codiert werden.
Namespace: System.Xml.Serialization
Assembly: System.Xml (in system.xml.dll)
Syntax
'Declaration
Public Class XmlSerializer
'Usage
Dim instance As XmlSerializer
public class XmlSerializer
public ref class XmlSerializer
public class XmlSerializer
public class XmlSerializer
Hinweise
Die XML-Serialisierung ist die Konvertierung der öffentlichen Eigenschaften und Felder eines Objekts in ein serielles Format (in diesem Fall XML) zum Zweck der Speicherung und Übermittlung. Die Deserialisierung erstellt das Objekt aus der XML-Ausgabe in seinem ursprünglichen Zustand erneut. Die Serialisierung kann daher als eine Möglichkeit zum Speichern des Zustands eines Objekts in einen Stream oder Puffer aufgefasst werden. Beispielsweise verwendet ASP.NET die XmlSerializer-Klasse zum Codieren von XML-Webdienstmeldungen.
Die Daten in den Objekten werden durch Konstrukte der Programmiersprache beschrieben, z. B. Klassen, Felder, Eigenschaften, primitive Typen, Arrays oder auch eingebettetes XML in Form von XmlElement-Objekten oder XmlAttribute-Objekten. Sie können eigene, mit Attributen versehene Klassen erstellen oder Klassen anhand eines vorhandenen XSD (XML Schema Definition)-Dokuments mit XML Schema Definition-Tool (Xsd.exe) generieren. Wenn Sie über ein XML-Schema verfügen, können Sie die Xsd.exe ausführen und so eine Reihe von Klassen erstellen, die für dieses Schema streng typisiert und mit Attributen versehen sind, sodass sie nach der Serialisierung dem Schema entsprechen.
Für das Übertragen von Daten zwischen Objekten und XML ist eine Zuordnung der Konstrukte der Programmiersprache zum XML-Schema und vom XML-Schema zu den Konstrukten der Programmiersprache erforderlich. Der XmlSerializer und verwandte Tools wie Xsd.exe stellen sowohl zur Entwurfszeit als auch zur Laufzeit einen Übergang zwischen diesen beiden Technologien bereit. Zur Entwurfszeit können Sie mit der Xsd.exe aus den benutzerdefinierten Klassen ein XML-Schemadokument (.xsd) erstellen oder Klassen aus einem angegebenen Schema generieren. In beiden Fällen sind die Klassen mit benutzerdefinierten Attributen versehen, um XmlSerializer anzuweisen, wie die Zuordnung zwischen dem XML-Schemasystem und der Common Language Runtime vorzunehmen ist. Zur Laufzeit können Instanzen der Klassen in XML-Dokumente serialisiert werden, die dem angegebenen Schema entsprechen. Ebenso können diese XML-Dokumente wieder in Laufzeitobjekte deserialisiert werden. Beachten Sie, dass das XML-Schema optional ist und weder zur Entwurfszeit noch zur Laufzeit erforderlich ist.
Kontrollieren von generiertem XML-Code
Zum Steuern des generierten XML können Sie spezielle Attribute auf Klassen und Member anwenden. Um z. B. einen anderen XML-Elementnamen anzugeben, weisen Sie XmlElementAttribute einem öffentlichen Feld oder einer Eigenschaft zu und legen die ElementName-Eigenschaft fest. Eine vollständige Liste ähnlicher Attribute finden Sie unter Attribute für die Steuerung der XML-Serialisierung. Sie können auch die IXmlSerializable-Schnittstelle implementieren, um die XML-Ausgabe zu kontrollieren.
Wenn das generierte XML Abschnitt 5 des Dokuments "Simple Object Access Protocol (SOAP) 1.1" des World Wide Web Consortium (www.w3.org) entspricht, müssen Sie den XmlSerializer mit XmlTypeMapping erstellen. Um das codierte SOAP-XML weiter zu steuern, verwenden Sie die in Attribute für die Steuerung der Serialisierung von codiertem SOAP aufgeführten Attribute.
Mit XmlSerializer können Sie die Vorteile der Arbeit mit stark typisierten Klassen nutzen, ohne auf die Flexibilität von XML verzichten zu müssen. Wenn Sie in den stark typisierten Klassen Felder oder Eigenschaften vom Typ XmlElement, XmlAttribute oder XmlNode verwenden, können Sie Teile des XML-Dokuments direkt in XML-Objekte einlesen.
Wenn Sie mit umfangreichen XML-Schemas arbeiten, können Sie auch mit den Attributen XmlAnyElementAttribute und XmlAnyAttributeAttribute Elemente oder Attribute serialisieren bzw. deserialisieren, die nicht im ursprünglichen Schema gefunden wurden. Zum Verwenden des Objekts wenden Sie XmlAnyElementAttribute auf ein Feld an, das ein Array von XmlElement-Objekten zurückgibt, oder wenden Sie XmlAnyAttributeAttribute auf ein Feld an, das ein Array von XmlAttribute-Objekten zurückgibt.
Wenn eine Eigenschaft oder ein Feld ein komplexes Objekt zurückgibt (z. B. ein Array oder eine Klasseninstanz), wird dieses von XmlSerializer in ein Element konvertiert, das innerhalb des XML-Hauptdokuments geschachtelt ist. Die erste Klasse im folgenden Code gibt beispielsweise eine Instanz der zweiten Klasse zurück.
Public Class MyClass
Public MyObjectProperty As MyObject
End Class
Public Class MyObject
Public ObjectName As String
End Class
public class MyClass
{
public MyObject MyObjectProperty;
}
public class MyObject
{
public string ObjectName;
}
Die serialisierte XML-Ausgabe lautet wie folgt:
<MyClass>
<MyObjectProperty>
<ObjectName>My String</ObjectName>
</MyObjectProperty>
</MyClass>
Wenn ein Schema ein optionales Element (minOccurs = '0') oder einen Standardwert enthält, stehen zwei Optionen zur Verfügung. Die eine Option ist es, mit System.ComponentModel.DefaultValueAttribute den Standardwert anzugeben, wie im folgenden Code dargestellt.
Public Class PurchaseOrder
<System.ComponentModel.DefaultValueAttribute ("2002")> _
Public Year As String
End Class
public class PurchaseOrder
{
[System.ComponentModel.DefaultValueAttribute ("2002")]
public string Year;
}
Eine weitere Option ist es, mithilfe eines speziellen Musters ein boolesches Feld zu erstellen, das vom XmlSerializer erkannt wird, und XmlIgnoreAttribute auf dieses Feld anzuwenden. Das Muster wird im Format propertyNameSpecified erstellt. Wenn beispielsweise eine Feld "MyFirstName" vorhanden ist, würden Sie außerdem ein Feld "MyFirstNameSpecified" erstellen, das den XmlSerializer anweist, ein XML-Element mit der Bezeichnung "MyFirstName" zu generieren bzw. nicht zu generieren. Dies wird im folgenden Beispiel gezeigt.
Public Class OptionalOrder
' This field's value should not be serialized
' if it is uninitialized.
Public FirstOrder As String
' Use the XmlIgnoreAttribute to ignore the
' special field named "FirstOrderSpecified".
<System.Xml.Serialization.XmlIgnoreAttribute> _
Public FirstOrderSpecified As Boolean
End Class
public class OptionalOrder
{
// This field should not be serialized
// if it is uninitialized.
public string FirstOrder;
// Use the XmlIgnoreAttribute to ignore the
// special field named "FirstOrderSpecified".
[System.Xml.Serialization.XmlIgnoreAttribute]
public bool FirstOrderSpecified;
}
Überschreiben der Standardserialisierung
Sie können die Serialisierung einer beliebigen Gruppe von Objekten und der zugehörigen Felder und Eigenschaften überschreiben, indem Sie eines der entsprechenden Attribute erstellen und dieses einer Instanz der XmlAttributes-Klasse hinzufügen. Die Serialisierung auf diese Weise zu überschreiben, bietet zweierlei Nutzen: Erstens können Sie die Serialisierung von Objekten in einer DLL steuern und erweitern, auch wenn Sie nicht auf den Quellcode zugreifen können. Zweitens können Sie eine einzige Gruppe von serialisierbaren Klassen erstellen, deren Objekte jedoch auf verschiedene Art serialisiert werden können. Weitere Informationen finden Sie unter der XmlAttributeOverrides-Klasse und unter Gewusst wie: Steuern der Serialisierung abgeleiteter Klassen.
Rufen Sie die Serialize-Methode auf, um ein Objekt zu serialisieren. Rufen Sie die Deserialize-Methode auf, um ein Objekt zu deserialisieren.
Informationen über das Hinzufügen von XML-Namespaces zu einem XML-Dokument finden Sie unter XmlSerializerNamespaces.
Hinweis
Klassen, die IEnumerable oder ICollection implementieren, werden von XmlSerializer besonders behandelt. Eine Klasse, die IEnumerable implementiert, muss eine öffentliche Add-Methode mit einem einzigen Parameter implementieren. Der Parameter der Add-Methode muss von demselben Typ sein, den die Current-Eigenschaft für den von GetEnumerator zurückgegebenen Wert zurückgibt, oder muss ein Basistyp dieses Typs sein. Eine Klasse, die ICollection zusätzlich zu IEnumerable implementiert, z. B. CollectionBase, muss eine öffentliche und mit Item indizierte (Indexer in C#) Eigenschaft mit einer ganzen Zahl sowie eine öffentliche Count-Eigenschaft vom Typ Integer aufweisen. Der Parameter der Add-Methode muss von demselben Typ sein, den die Item-Eigenschaft zurückgibt, oder muss ein Basistyp dieses Typs sein. Bei Klassen, die ICollection implementieren, werden die zu serialisierenden Werte nicht durch einen Aufruf von GetEnumerator, sondern über die indizierte Item-Eigenschaft abgerufen.
Sie müssen über die Berechtigung zum Schreiben im temporären Verzeichnis (das durch die Umgebungsvariable TEMP definiert wird) verfügen, um ein Objekt deserialisieren zu können.
Dynamisch generierte Assemblys
Zum Verbessern der Leistung generiert die XML-Serialisierungsinfrastruktur dynamisch Assemblys für das Serialisieren und Deserialisieren der angegebenen Typen. Die Infrastruktur sucht diese Assemblys und verwendet sie wieder. Dieses Verhalten tritt nur bei der Verwendung der folgenden Konstruktoren auf:
System.Xml.Serialization.XmlSerializer(Type)
System.Xml.Serialization.XmlSerializer(Type,String)
Wenn Sie einen anderen Konstruktor verwenden, werden mehrere Versionen derselben Assembly generiert und niemals entladen, was zu Speicherverlusten und einer eingeschränkten Leistung führen kann. Die einfachste Lösung ist es, einen der beiden oben genannten Konstruktoren zu verwenden. Andernfalls müssen Sie die Assemblys in einer Hashtable zwischenspeichern, wie im folgenden Beispiel dargestellt.
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;
}
else
{
// 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
Else
' Use the serializer to serialize, or deserialize.
End If
Serialisierung von ArrayList und generischer Liste
Der XmlSerializer kann die folgenden Elemente weder serialisieren noch deserialisieren:
Beispiel
Das folgende Beispiel enthält zwei Hauptklassen: PurchaseOrder und Test. Die PurchaseOrder-Klasse enthält Informationen über eine einzelne Bestellung. Die Test-Klasse enthält die Methoden, mit denen der Bestellauftrag erstellt und ein erstellter Bestellauftrag gelesen wird.
Imports System
Imports System.Xml
Imports System.Xml.Serialization
Imports System.IO
Imports Microsoft.VisualBasic
' 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 'PurchaseOrder
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 'Address
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 'Calculate
End Class 'OrderedItem
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 'Main
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 'CreatePO
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 'ReadPO
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 'ReadAddress
Private Sub serializer_UnknownNode(sender As Object, e As XmlNodeEventArgs)
Console.WriteLine(("Unknown Node:" & e.Name & ControlChars.Tab & e.Text))
End Sub 'serializer_UnknownNode
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 'serializer_UnknownAttribute
End Class 'Test
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 + "'");
}
}
#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();
}
import System.*;
import System.Xml.*;
import System.Xml.Serialization.*;
import 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. */
/** @attribute 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". */
/** @attribute XmlArrayAttribute("Items")
*/
public OrderedItem orderedItems[];
public System.Decimal subTotal;
public System.Decimal shipCost;
public System.Decimal totalCost;
} //PurchaseOrder
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). */
/** @attribute 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. */
/** @attribute XmlElementAttribute(IsNullable = false)
*/
public String city;
public String state;
public String zip;
} //Address
public class OrderedItem
{
public String itemName;
public String description;
public System.Decimal unitPrice;
public int quantity;
public System.Decimal lineTotal;
/* Calculate is a custom method that calculates the price per item,
and stores the value in a field. */
public void Calculate()
{
lineTotal = Decimal.Multiply(unitPrice, Convert.ToDecimal(quantity));
} //Calculate
} //OrderedItem
public class Test
{
public static void main(String[] args)
{
// Read and write purchase orders.
Test t = new Test();
t.CreatePO("po.xml");
t.ReadPO("po.xml");
} //main
private void CreatePO(String fileName)
{
// Create an instance of the XmlSerializer class;
// specify the type of object to serialize.
XmlSerializer serializer =
new XmlSerializer(PurchaseOrder.class.ToType());
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.get_Now().ToLongDateString();
// Create an OrderedItem object.
OrderedItem i1 = new OrderedItem();
i1.itemName = "Widget S";
i1.description = "Small widget";
i1.unitPrice = Convert.ToDecimal(5.23);
i1.quantity = 3;
i1.Calculate();
// Insert the item into the array.
OrderedItem items[] = { i1 };
po.orderedItems = items;
// Calculate the total cost.
System.Decimal subTotal = new System.Decimal();
for (int iCtr = 0; iCtr < items.length; iCtr++) {
OrderedItem oi = items[iCtr];
subTotal = Decimal.Add(subTotal, oi.lineTotal);
}
po.subTotal = subTotal;
po.shipCost = Convert.ToDecimal(12.51);
po.totalCost = Decimal.Add(po.subTotal, po.shipCost);
// Serialize the purchase order, and close the TextWriter.
serializer.Serialize(writer, po);
writer.Close();
} //CreatePO
protected void ReadPO(String fileName)
{
// Create an instance of the XmlSerializer class;
// specify the type of object to be deserialized.
XmlSerializer serializer =
new XmlSerializer(PurchaseOrder.class.ToType());
/* If the XML document has been altered with unknown
nodes or attributes, handle them with the
UnknownNode and UnknownAttribute events.*/
serializer.add_UnknownNode(
new XmlNodeEventHandler(Serializer_UnknownNode));
serializer.add_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:");
for (int iCtr = 0; iCtr < items.length; iCtr++) {
OrderedItem oi = items[iCtr];
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);
} //ReadPO
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();
} //ReadAddress
private void Serializer_UnknownNode(Object sender, XmlNodeEventArgs e)
{
Console.WriteLine("Unknown Node:" + e.get_Name() + "\t" + e.get_Text());
} //Serializer_UnknownNode
private void Serializer_UnknownAttribute(Object sender,
XmlAttributeEventArgs e)
{
System.Xml.XmlAttribute attr = e.get_Attr();
Console.WriteLine("Unknown attribute " + attr.get_Name() + "='"
+ attr.get_Value() + "'");
} //Serializer_UnknownAttribute
} //Test
Vererbungshierarchie
System.Object
System.Xml.Serialization.XmlSerializer
Threadsicherheit
Dieser Typ ist bezüglich Multithreadoperationen sicher.
Plattformen
Windows 98, Windows 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile für Pocket PC, Windows Mobile für Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition
.NET Framework unterstützt nicht alle Versionen sämtlicher Plattformen. Eine Liste der unterstützten Versionen finden Sie unter Systemanforderungen.
Versionsinformationen
.NET Framework
Unterstützt in: 2.0, 1.1, 1.0
.NET Compact Framework
Unterstützt in: 2.0
Siehe auch
Referenz
XmlSerializer-Member
System.Xml.Serialization-Namespace
XmlAttributeOverrides-Klasse
XmlAttributes-Klasse
XmlSerializer-Klasse
XmlAttributes.XmlText-Eigenschaft
XmlAttributes-Klasse
Weitere Ressourcen
Einführung in die XML-Serialisierung
Gewusst wie: Angeben eines alternativen Elementnamens für einen XML-Stream
Steuern der XML-Serialisierung mit Attributen
Beispiele für die XML-Serialisierung
XML Schema Definition-Tool (Xsd.exe)
Gewusst wie: Steuern der Serialisierung abgeleiteter Klassen
<dateTimeSerialization> (Element)
<XmlSerializer> (Element)