Beispiel zur Serialisierung/Deserialisierung einer Objekthierarchie sowohl mit dem binären als auch dem XML-Serialisierer: Codebeispiel für Visual Basic .NET (VB.NET) und CSharp (C#)

Code-Beispiel

Beispiel zur Serialisierung/Deserialisierung einer Objekthierarchie sowohl mit dem binären als auch dem XML-Serialisierer

Ein Beispiel zum Einsatz der Klasse System.Xml.Serialization.XmlSerializer aus der .NET-Klassenbibliothek.

Autor: Dr. Holger Schwichtenberg

Beschreibung

Im folgenden Beispiel wird die Serialisierung/Deserialisierung an einem kleinen Objektmodell demonstriert: Ein Autor-Objekt besitzt eine Objektmenge vom Typ ArrayList, in der seine Bücher (Typ Buch) aufgelistet sind.

Für den XML-Serialisierer ist es wichtig, dass er weiß, welcher Objekttyp ihn in der ArrayList erwartet. Daher muss mit dem Meta-Attribut <XmlInclude(GetType(Buch))> definiert werden, dass diese Klasse Objekte vom Typ Buch zurückliefern kann.

Hauptroutine

In der Hauptroutine werden zunächst ein Autor-Objekt und zwei Buch-Objekte erzeugt. Das Attribut Autor in der Klasse Buch wird dabei mit Absicht nicht verwendet, damit es zunächst keine zirkuläre Referenz gibt. Die Unterroutine autorinfo() gibt Informationen über einen Autor und seine Bücher aus. Das Objektmodell wird zunächst in eine Binärdatei, danach in eine XML-Datei serialisiert.

Im zweiten Teil wird die zirkuläre Referenz hinzugefügt: Dadurch kommt es im XML-Serialisierer zu einer Fehlermeldung, die abgefangen und ausgegeben wird.

' --- Anlegen einer zirkulären Referenz
b1.Autor = a
b2.autor = a

Danach funktioniert das binäre Serialisieren weiterhin, der XML-Serialisierer bricht jedoch mit einem Fehler ab.

Programmcodebeispiele Visual Basic .NET (VB.NET)


    <Serializable()> Class Buch

  Public Titel As String

  Public Autor As Autor

  Public Auflage As Integer



  Function get_auflage() As Integer

    Return (Auflage)

  End Function



  Sub set_auflage(ByVal a As Integer)

    Auflage = a

  End Sub

End Class



<Serializable(), XmlInclude(GetType(Buch))> _

  Class autor

  Public name As String

  Public geb As Date

  Public buecher As New ArrayList()

End Class



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

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

' Beispiele für binäres und XML-Serialisieren

' (C) [email protected]

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

Sub OModell_Serialisieren()



  ' --- Objektmodell aufbauen

  Dim a As New autor()

  a.name = "Holger Schwichtenberg"

  a.geb = #8/1/1972#



  Dim b1 As New Buch()

  b1.titel = "Windows Scripting"

  b1.set_auflage(5000)

  a.buecher.Add(b1)



  Dim b2 = New Buch()

  b2.titel = "COM-Komponenten-Handbuch"

  b2.set_auflage(4000)

  a.buecher.Add(b2)



  ' --- Objektmodell ausgeben

  autorinfo(a)



  Dim o As Object ' Objekt für Deserialisierung



  ' --- Serialisierungsziele

  Const DATEI = "h:\data\buch.bin"

  Const DATEIXML = "h:\data\buch.xml"



  ' --- binäres Serialisieren

  out("Binäre Serialisierung...")

  bin_serialize(a, DATEI)

  o = bin_deserialize(DATEI)

  autorinfo(o)



  ' --- XML-Serialisieren

  out("XML Serialisierung...")

  xml_serialize(a, DATEIXML)

  o = xml_deserialize(GetType(autor), DATEIXML)

  autorinfo(o)



  ' --- Anlegen einer zirkulären Referenz

  b1.Autor = a

  b2.autor = a



  ' --- binäres Serialisieren

  out("Binäre Serialisierung...")

  bin_serialize(a, DATEI)

  a = bin_deserialize(DATEI)

  autorinfo(a)



  ' --- XML-Serialisieren

  out("XML Serialisierung...")

  Try

    xml_serialize(a, DATEIXML)

    a = xml_deserialize(GetType(autor), DATEIXML)

    autorinfo(a)

  Catch e As Exception

    out("Serialisierung nicht möglich: " & _

        e.ToString)

  End Try

End Sub



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

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

' Ausgabe des Objektmodells

' (C) [email protected]

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

Sub autorinfo(ByVal a As autor)

  Dim b As Buch

  out("Autor: " & a.name & ", " & _

    a.buecher.Count & " Bücher")

  For Each b In a.buecher

    out("Buch: " & b.titel & ": " & _

        b.get_auflage & " Exemplare")

    If Not b.Autor Is Nothing Then 

      out("von " & b.Autor.name)

    End If

  Next

End Sub

Programmcodebeispiele CSharp (C#)


		using System;

using System.Runtime.Serialization.Formatters.Binary;

using System.Runtime.Serialization;

using System.IO;

using System.Xml.Serialization;



namespace FCLBuch._System_RuntimeSerialization {



  [Serializable(), XmlRoot("blubber")]

  public class Buch {



    // Definitionen für Objektmodell

    public string Titel;

    public Autor Autor;

    public int Auflage;

    public int Jahr;

    [NonSerialized()] public DateTime Deserialisiert;



    public int Get_auflage() {



      // Liefert aktuelle Auflage

      return this.Auflage;

    }



    public void Set_auflage(int value) {



      // Setzt aktuelle Auflage

      this.Auflage = value;

    }

  }

}



using System;



namespace FCLBuch._System_RuntimeSerialization {



  public class Samples_Serialisieren {

public void OModell_Serialisieren() {



      // Beispiele für Binäres und XML serialisieren

      // Objektmodell aufbauen

      Autor a = new Autor();

      a.Name = "Holger Schwichtenberg";

      a.Geb = DateTime.Parse("08/01/1972");



      Buch b1 = new Buch();

      b1.Titel = "Windows Scripting";

      b1.Set_auflage(5000);

      a.Buecher.Add(b1);



      Buch b2 = new Buch();

      b2.Titel = "COM-Komponenten-Handbuch";

      b2.Set_auflage(4000);

      a.Buecher.Add(b2);



      // Variante: zweifacher Verweis auf ein Objekt

      //a.b1 = b1

      //a.b2 = b1



      // Objektmodell ausgeben

      AutorInfo(a);



      object o; // Objekt für Deserialisierung



      // Serialisierungsziele

      string datei = @"..\_daten\buch.bin";

      string dateiSoap = @"..\_daten\buch.soap.xml";

      string dateiXml = @"..\_daten\buch.xml";



      // binäre Serialisieren

      FclOutput.PrintOut("Binäre Serialisierung...");

      SerializationHelper.Bin_Serialize(a, datei);

      o = SerializationHelper.Bin_Deserialize(datei);

      AutorInfo(o);



      // binäre Serialisieren

      FclOutput.PrintOut("Binäre Serialisierung...");

      SerializationHelper.Soap_Serialize(a, dateiSoap);

      o = SerializationHelper.Soap_Deserialize(dateiSoap);

      AutorInfo(o);



      // XML-Serialisieren

      FclOutput.PrintOut("XML Serialisierung...");

      SerializationHelper.Xml_Serialize(a, dateiXml);

      o = SerializationHelper.Xml_Deserialize(typeof(Autor), dateiXml);

      AutorInfo(o);



      // Anlegen einer zirkulären Referenz

      b1.Autor = a;

      b2.Autor = a;



      // binäre Serialisieren

      FclOutput.PrintOut("Binäre Serialisierung...");

      SerializationHelper.Bin_Serialize(a, datei);

      a = (Autor)SerializationHelper.Bin_Deserialize(datei);

      AutorInfo(a);



      //// XML-Serialisieren

      //FclOutput.PrintOut("XML Serialisierung...");

      //try {

      //  SerializationHelper.Xml_Serialize(a, dateiXml);

      //  a = SerializationHelper.Xml_Deserialize(GetType(Autor), dateiXml);

      //  AutorInfo(a);

      //} catch ( Exception e ) {

      //  FclOutput.PrintOut("Serialisierung nicht möglich: " + e.ToString);

      //}

    }



    // Ausgabe des Objektmodells

    public void AutorInfo(object o) {



      Autor a;

      if ( o is Autor )

        a = (Autor)o;

      else

        return;



      FclOutput.PrintOut("Autor: " + a.Name + ", " + a.Buecher.Count + " Bücher");



      foreach (Buch b in a.Buecher) {

        FclOutput.PrintOut("Buch: " + b.Titel + ": " + b.Get_auflage().ToString() + " Exemplare");

        if (b.Autor != null)

          FclOutput.PrintOut("von " + b.Autor.Name);

      }

    }

  }

}

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.