Versionstolerante Serialisierungsrückrufe

Artikel
02/27/2011

Die von den Klassen BinaryFormatter und SoapFormatter unterstützten Methoden für versionstolerante Serialisierungsrückrufe werden vom Datenvertrags-Programmiermodell vollständig unterstützt.

Versionstolerante Attribute

Es gibt vier Rückrufattribute. Jedes Attribut kann für eine Methode angewendet werden, die das Serialisierungs-/Deserialisierungmodul zu verschiedenen Zeiten aufruft. In der folgenden Tabelle wird erläutert, wann die einzelnen Attribute verwendet werden.

Attribut	Beim Aufruf der entsprechenden Methode
OnSerializingAttribute	Der Aufruf erfolgt vor dem Serialisieren des Typs.
OnSerializedAttribute	Der Aufruf erfolgt nach dem Serialisieren des Typs.
OnDeserializingAttribute	Der Aufruf erfolgt vor dem Deserialisieren des Typs.
OnDeserializedAttribute	Der Aufruf erfolgt nach dem Deserialisieren des Typs.

Diese Methode muss einen StreamingContext-Parameter akzeptieren.

Diese Methoden sind in erster Linie für die Verwendung mit der Versionsverwaltung oder der Initialisierung bestimmt. Während der Deserialisierung werden keine Konstruktoren aufgerufen. Datenmember werden deshalb möglicherweise nicht ordnungsgemäß initialisiert (auf beabsichtigte Standardwerte), falls die Daten für diese Member im eingehenden Stream fehlen. Das kann z. B. der Fall sein, wenn die Daten aus einer früheren Version eines Typs stammen, bei dem einige Datenmember fehlen. Verwenden Sie die mit OnDeserializingAttribute gekennzeichnete Methode, wie im folgenden Beispiel dargestellt, um dieses Problem zu beheben.

Mit jedem der oben aufgeführten Rückrufattribute kann nur eine Methode pro Typ gekennzeichnet werden.

Beispiel

' The following Data Contract is version 2 of an earlier data 
' contract.
<DataContract()>  _
Public Class Address
    <DataMember()>  _
    Public Street As String
    <DataMember()>  _
    Public State As String
    
    ' This data member was added in version 2, and thus may be missing 
    ' in the incoming data if the data conforms to version 1 of the 
    ' Data Contract.
    <DataMember(Order := 2)>  _
    Public CountryRegion As String
    
    ' This method is used as a kind of constructor to initialize
    ' a default value for the CountryRegion data member before 
    ' deserialization.
    <OnDeserializing()>  _
    Private Sub setDefaultCountryRegion(ByVal c As StreamingContext) 
        CountryRegion = "Japan"
    End Sub 
End Class

// The following Data Contract is version 2 of an earlier data 
// contract.
[DataContract]
public class Address
{
    [DataMember]
    public string Street;

    [DataMember]
    public string State;

    // This data member was added in version 2, and thus may be missing 
    // in the incoming data if the data conforms to version 1 of the 
    // Data Contract. Use the callback to add a default for this case.
    [DataMember(Order=2)]
    public string CountryRegion;

    // This method is used as a kind of constructor to initialize
    // a default value for the CountryRegion data member before 
    // deserialization.
    [OnDeserializing]
    private void setDefaultCountryRegion(StreamingContext c)
    {
        CountryRegion = "Japan";
    }
}

Siehe auch

Verweis

OnSerializingAttribute
OnSerializedAttribute
OnDeserializingAttribute
OnDeserializedAttribute
StreamingContext

Weitere Ressourcen

Version-Tolerant Serialization

Freigeben über