Klasse System.Xml.Serialization.XmlSerializer

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

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

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

Gegenereerde XML controleren

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

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

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

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

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

Public Class MyClass
    Public MyObjectProperty As MyObject
End Class

Public Class MyObject
    Public ObjectName As String
End Class

public class MyClass
{
    public MyObject MyObjectProperty;
}
public class MyObject
{
    public string ObjectName;
}

De geserialiseerde XML-uitvoer ziet er als volgt uit:

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

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

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

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

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

Public Class OptionalOrder
    ' This field's value should not be serialized
    ' if it is uninitialized.
    Public FirstOrder As String

    ' Use the XmlIgnoreAttribute to ignore the
    ' special field named "FirstOrderSpecified".
    <System.Xml.Serialization.XmlIgnoreAttribute> _
    Public FirstOrderSpecified As Boolean
End Class

public class OptionalOrder
{
    // This field should not be serialized
    // if it is uninitialized.
    public string FirstOrder;

    // Use the XmlIgnoreAttribute to ignore the
    // special field named "FirstOrderSpecified".
    [System.Xml.Serialization.XmlIgnoreAttribute]
    public bool FirstOrderSpecified;
}

Standaardserialisatie overschrijven

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

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

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

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

Dynamisch gegenereerde assemblies

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

XmlSerializer.XmlSerializer(Type)

XmlSerializer.XmlSerializer(Type, String)

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

Hashtable serializers = new Hashtable();

// Use the constructor that takes a type and XmlRootAttribute.
XmlSerializer s = new XmlSerializer(typeof(MyClass), myRoot);

// Implement a method named GenerateKey that creates unique keys
// for each instance of the XmlSerializer. The code should take
// into account all parameters passed to the XmlSerializer
// constructor.
object key = GenerateKey(typeof(MyClass), myRoot);

// Check the local cache for a matching serializer.
XmlSerializer ser = (XmlSerializer)serializers[key];
if (ser == null)
{
    ser = new XmlSerializer(typeof(MyClass), myRoot);
    // Cache the serializer.
    serializers[key] = ser;
}

// Use the serializer to serialize or deserialize.

Dim serializers As New Hashtable()

' Use the constructor that takes a type and XmlRootAttribute.
Dim s As New XmlSerializer(GetType([MyClass]), myRoot)

' Implement a method named GenerateKey that creates unique keys
' for each instance of the XmlSerializer. The code should take
' into account all parameters passed to the XmlSerializer
' constructor.
Dim key As Object = GenerateKey(GetType([MyClass]), myRoot)

' Check the local cache for a matching serializer.
Dim ser As XmlSerializer = CType(serializers(key), XmlSerializer)

If ser Is Nothing Then
    ser = New XmlSerializer(GetType([MyClass]), myRoot)
    ' Cache the serializer.
    serializers(key) = ser
End If

' Use the serializer to serialize or deserialize.

Serialisatie van matrixlijst en algemene lijst

Het XmlSerializer kan het volgende niet serialiseren of deserialiseren:

• Matrices van ArrayList
• Matrices van List<T>

Serialisatie van opsommingen van niet-ondertekende Long

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

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

Verouderde typen

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