Benutzerdefinierte binäre Serialisierung: Codebeispiel für Visual Basic .NET (VB.NET) und CSharp (C#)

Code-Beispiel

Benutzerdefinierte binäre Serialisierung

Ein Beispiel zum Einsatz der Klasse System.Runtime.Serialization.IDeserializationCallback aus der .NET-Klassenbibliothek.

Autor: Dr. Holger Schwichtenberg

Beschreibung

Eine zu serialisierende Klasse kann auch IDeserializationCallback implementieren. Diese Schnittstelle umfasst nur eine Methode, OnDeserialization(ByVal s As Object), die aufgerufen wird, wenn die Deserialisierung beendet ist. Diese Methode zu füllen macht Sinn, um Daten des Objekts zu vervollständigen, die nicht serialisiert wurden bzw. aus serialisierten Daten errechnet werden.

Beispiel

Das Beispiel zeigt die Klasse Person, die so implementiert ist, dass nur die Attribute Vorname, Name und Geb serialisiert werden. Die beiden Namen werden dabei in einem Feld serialisiert und bei der Deserialisierung wieder getrennt (dieses Vorgehen ist natürlich nicht zwingend notwendig – es dient hier nur zu Demonstrationszwecken). In dem Attribut Deserialisiert werden Datum und Uhrzeit am Ende der Deserialisierung erfasst.

Programmcodebeispiel in Visual Basic .NET (VB.NET)


    ' ============================

' .NET-Code-Beispiel in Visual Basic .NET

' Klasse für benutzerdefinierte Serialisierung

' (C) [email protected]

' ============================

Public Module SerialisierenBinaer_mitKontrolle



  <Serializable()> Public Class Person2

    Implements ISerializable, _

               IDeserializationCallback

    Public Name As String

    Public Vorname As String

    Public Geb As Date

    Public Geschlecht As Char

    Public Kinderanzahl As Byte

    Public Taetigkeiten As String()

    Public Deserialisiert As Date



    Public Sub New()

      out("Konstruktoraufruf!")

    End Sub



    ' --- Serialisierung ausgewählter Eigenschaften

    Public Sub GetObjectData( _

      ByVal info As SerializationInfo, _

      ByVal context As StreamingContext) _

      Implements ISerializable.GetObjectData

      out("Serialisierung des Typs: " & _

          info.FullTypeName.ToString)

      info.AddValue("kompletterName", Vorname & _

                    " " & Name)

      info.AddValue("Geb", Geb)

    End Sub



    ' Deserialisierung ausgewählter Eigenschaften

    Public Sub New( _

      ByVal info As SerializationInfo, _

      ByVal context As StreamingContext)

      Dim namen As String()

      namen = CType(info.GetValue( _

       "kompletterName", GetType(String)), _

       String).Split

      Vorname = namen(0)

      Name = namen(1)

      Geb = CDate(info.GetValue("Geb", _

                  GetType(Date)))

    End Sub



    ' wird am Ende der Deserialisierung aufgerufen

    Public Sub OnDeserialization( _

      ByVal s As Object) Implements _

      DeserializationCallback.OnDeserialization

      Deserialisiert = Now

      out("Deserialisierung komplett!")

    End Sub



  End Class



' ============================

' .NET-Code-Beispiel in Visual Basic .NET

' Benutzerdefinierte Serialisierung

' (C) [email protected]

' ============================

  Sub serialkontrolle1()

  Const DATEI = "h:\Data\person.bin"



    ' --- Objekt füllen

    Dim p As New Person2()

    p.Vorname = "Holger"

    p.Name = "Schwichtenberg"

    p.Geb = #8/1/1972#

    p.Geschlecht = "m"

    p.Kinderanzahl = 0

    p.Taetigkeiten = New String() {"Berater", _

      "Entwickler", "Journalist", "Dozent"}



    Dim form As New BinaryFormatter()

    Dim stream As FileStream



    ' --- Serialisieren

    stream = New FileStream(DATEI, _

      FileMode.Create, FileAccess.Write, _

      FileShare.None)

    form.Serialize(stream, p)

    stream.Close()

    out("Objekt wurde gespeichert!")

    p = Nothing



    ' --- Deserialisieren

    stream = New FileStream(DATEI, _

      FileMode.Open, FileAccess.Read, _

      FileShare.Read)

    p = form.Deserialize(stream)

    stream.Close()

    out("Objekt wurde geladen!")

    out(p.Vorname & " " & p.Name & " wurde am " _

        & p.Geb & " geboren!")



  End Sub

End Module

Weiteres Programmcodebeispiel in CSharp (C#)


           using System;

using System.Runtime.Serialization.Formatters.Binary;

using System.Runtime.Serialization;

using System.IO;

using System.Xml.Serialization;



using FCL_Buch;



namespace FCLBuch._System_RuntimeSerialization {



  [Serializable]

  public class Person2 : ISerializable, IDeserializationCallback {



    // Klasse für benutzerdefinierte Serialisierung

    public String Name; 

    public String Vorname;

    public DateTime Geb;

    public char Geschlecht;

    public byte Kinderanzahl;

    public string[] Taetigkeiten;

    [NonSerialized] public DateTime Deserialisiert;



    public Person2() {



      // Konstruktor

      FclOutput.PrintOut("Konstruktoraufruf!");

    }





    public Person2(SerializationInfo info, StreamingContext context) {



      // Deserialisierung ausgewählter Eigenschaften

      string[] namen = info.GetValue("kompletterName", typeof(System.String)).ToString().Split();

      this.Vorname = namen[0];

      this.Name = namen[1];

      this.Geb = (DateTime)info.GetValue("Geb", typeof(System.DateTime)); 

    }

region ISerializable Member
    void ISerializable.GetObjectData(SerializationInfo info, StreamingContext context) {



      // Serialisierung ausgewählter Eigenschaften

      FclOutput.PrintOut("Serialisierung des Typs: " + info.FullTypeName.ToString());

      info.AddValue("kompletterName", Vorname + " " + Name);

      info.AddValue("Geb", Geb);

    }

endregion
region IDeserializationCallback Member
    void IDeserializationCallback.OnDeserialization(object sender) {

      // TODO:  Implementierung von Person2.System.Runtime.Serialization.IDeserializationCallback.OnDeserialization hinzufügen

      Deserialisiert = DateTime.Now;

      FclOutput.PrintOut("Deserialisierung komplett!");

    }

endregion

} } using System; using System.Runtime.Serialization.Formatters.Binary; using System.Runtime.Serialization; using System.IO; using System.Xml.Serialization; using FCL_Buch; namespace FCLBuch._System_RuntimeSerialization { public class SamplesKontrolliertesSerialisieren { public void SerialKontrolle1() { // Benutzerdefinierte Serialisierung string datei = @"..\_daten\person.bin"; // Objekt füllen Person2 p = new Person2(); p.Vorname = "Holger"; p.Name = "Schwichtenberg"; p.Geb = DateTime.Parse("08/01/1972"); p.Geschlecht = 'm'; p.Kinderanzahl = 0; p.Taetigkeiten = new String[] {"Berater", "Entwickler", "Journalist", "Dozent"}; BinaryFormatter form = new BinaryFormatter(); // Serialisieren FileStream stream = new FileStream(datei, FileMode.Create, FileAccess.Write, FileShare.None); form.Serialize(stream, p); stream.Close(); FclOutput.PrintOut("Objekt wurde gespeichert!"); p = null; // Deserialisieren stream = new FileStream(datei, FileMode.Open, FileAccess.Read, FileShare.Read); p = (Person2)form.Deserialize(stream); stream.Close(); FclOutput.PrintOut("Objekt wurde geladen!"); FclOutput.PrintOut(p.Vorname + " " + p.Name + " hat am " + p.Geb + " Geburtstag!"); } } }

Hinweise

Ausgaben werden in den Beispielen durch Hilfsroutinen wie out() und PrintOut() erzeugt. Diese sind hier nicht angegeben, da deren Implementierung von der jeweiligen Umgebung abhängt. Für Konsolenanwendungen können hier z.B. Console.WriteLine() einsetzen.