13.2 Serialisierung mit »BinaryFormatter«

Ein Objekt unter .NET binär serialisieren zu können, ist genial einfach gelöst. Allerdings muss man sich schon bei der Entwicklung einer Klasse darüber klar sein, dass Objekte der Klasse dem Serialisierungsprozess zugeführt werden sollen. Dazu wird die Klasse nur mit dem Attribut Serializable markiert:

[Serializable()] 
public class Person {
  [...]
}

Listing 13.1 Attribut »Serializable«, um eine Klasse binär zu serialisieren

Fehlt das Attribut, wird die Ausnahme SerializationException ausgelöst. Alle Felder der Klasse Person, unabhängig davon, ob sie privat oder öffentlich deklariert sind, werden damit von der Serialisierung erfasst. Es gibt aber auch eine Einschränkung: Lokale Variablen und statische Klassendaten nehmen nicht an einem Serialisierungsprozess teil.

Wir wollen nun die Klassendefinition komplettieren, um anhand eines einfachen Beispiels zu sehen, wie die Serialisierung angestoßen und später das serialisierte Objekt rekonstruiert wird. Dazu implementieren wir in der Klasse Person ein privates und ein öffentliches Feld. Beide Felder werden über einen parametrisierten Konstruktor initialisiert.

[Serializable()] 
class Person {
  public string Name {get; set;}
  private int _Alter;
  // ----- Konstruktor -----
  public Person(int alter, string name) {
    _Alter = alter;
    Name = name;
  }
  public int Alter {
    get { return _Alter; }
  }
}

Bei der Serialisierung greift der Prozess den Inhalt von Alter und Name und speichert ihn entweder in einer Datei, im Netzwerk oder in einer Datenbank.

Der Code, der ein Objekt vom Typ der Klasse Person serialisiert, könnte folgendermaßen aussehen:

using System.Runtime.Serialization.Formatters.Binary;
class Program {
  static void Main(string[] args) {
    [...]
    Person pers = new Person(56, "Schmidt");
    FileStream stream; 
    stream = new FileStream(@"D:\MyPerson.dat", FileMode.Create);
    BinaryFormatter formatter = new BinaryFormatter();
    formatter.Serialize(stream, pers);
    stream.Close();
    [...]
  }
}

Listing 13.2 Serialisierung eines Objekts

Im Code wird ein FileStream generiert, der die binäre Datei MyPerson.dat anlegt oder, falls eine Datei dieses Namens bereits existiert, die alte überschreibt. Anschließend erzeugen wir ein Objekt vom Typ BinaryFormatter, dessen Methode Serialize wir aufrufen. Dabei übergeben wir das Stream-Objekt und die zu serialisierende Objektreferenz.

Felder als nichtserialisierbar kennzeichnen

Mit dem Attribut Serializable werden alle Felder einer Klasse, sowohl public als auch private definierte, serialisiert. Das mag im Einzelfall aber nicht immer wünschenswert sein. Eigenschaften, die der Serialisierungsprozess nicht erfassen soll, können durch das Setzen des Attributs NonSerialized vor der Deklaration ausgeschlossen werden.

[Serializable()] 
class Person {
  public string Name {get; set;}
  // das Feld Alter wird nicht serialisiert
  [NonSerialized()]
   private int _Alter;
   [...]
}

Das Codefragment enthält die Klassendefinition der Felder Name und Alter. Beide würden normalerweise während der Serialisierung abgegriffen. Die Deklaration der privaten Variablen Alter ist allerdings als NonSerialized markiert und entzieht das Feld dem Serialisierungsprozess.

Serialisierung in einer abgeleiteten Klasse

Das Serializable-Attribut wird nicht vererbt. Wenn Sie also beispielsweise unserer Klasse Circle das Serializable-Attribut spendieren, erbt die abgeleitete Klasse GraphicCircle das Attribut nicht. Soll auch ein Objekt vom Typ GraphicCircle serialisierbar sein, muss diese Klasse ebenfalls mit Serializable verknüpft werden. Ansonsten gilt die abgeleitete Klasse als nicht serialisierbar.

13.2.1 Die Deserialisierung

Die Deserialisierung des gespeicherten Objekts ist genauso einfach. Beachtet werden muss dabei nur, dass der Rückgabewert vom Typ Object ist und deshalb noch in den richtigen Typ konvertiert werden muss:

[...]
Person pers;
BinaryFormatter formatter = new BinaryFormatter();
FileStream stream = new FileStream(@"D:\MyPerson.dat", FileMode.Open);
pers = (Person)formatter.Deserialize(stream);
stream.Close();
[...]

Listing 13.3 Deserialisierung eines Objekts

Fassen wir nun den Code in einem Beispielprogramm zusammen. Serialisierung und Deserialisierung werden in je einer eigenen Methode behandelt, die aus Main heraus aufgerufen wird. Nach der Serialisierung des Objekts pers wird der neuen Objektvariablen oldPerson der Rückgabewert der Deserialisierung zugewiesen. Zum Schluss werden die rekonstruierten Objektdaten an der Konsole ausgegeben.

Beispiel: ..\Kapitel 13\BinaryFormatterSample
using System.IO;
using System.Runtime.Serialization.Formatters.Binary;
class Program {
  static BinaryFormatter formatter;
  static FileStream stream;
  static void Main(string[] args) {
    formatter = new BinaryFormatter();
    Person pers = new Person(67, "Fischer");
    SerializeObject(pers);
    Person oldPerson = DeserializeObject();
    Console.WriteLine("Ergebnis der Deserialisierung:");
    Console.WriteLine(oldPerson.Alter);
    Console.WriteLine(oldPerson.Name);
  }
  // Objekt serialisieren  
  public static void SerializeObject(Object obj) {
    stream = new FileStream(@"D:\MyObject.dat", FileMode.Create);
    formatter.Serialize(stream, obj);
    stream.Close();
  }
  // Objekt deserialisieren
  public static Person DeserializeObject() {
    FileStream stream = new FileStream(@"D:\MyObject.dat", FileMode.Open);
    return (Person)formatter.Deserialize(stream);
  }
}
// binär serialisierbare Klasse
[Serializable()] 
class Person {
  private int _Alter;
  public string Name {get; set;}
  // Konstruktor
  public Person(int alter, string name) {
    Name = name;
    _Alter = alter;
  }
  public int Alter {
    get { return _Alter; }
  }
}

Listing 13.4 Beispielprogramm zur binären Serialisierung

13.2.2 Serialisierung mehrerer Objekte

Natürlich können mit einem Serialisierungsprozess auch beliebig viele, auch typunterschiedliche Objekte serialisiert werden. Dazu muss man für jedes Objekt Serialize auf demselben Stream-Objekt aufrufen. Die formatierten Daten werden entsprechend der Aufrufreihenfolge serialisiert.

Die Deserialisierung erfolgt in gleicher Weise: Es wird auf demselben Stream-Objekt so lange Deserialize aufgerufen, bis der Datenstrom versiegt. Das Lesen über das Ende des Datenstroms hinaus hat eine Ausnahme zur Folge. Dabei muss natürlich die Reihenfolge beachtet werden, in der die Objekte serialisiert worden sind, denn die Deserialisierung mehrerer Objekte folgt dem FIFO-Prinzip: Das zuerst serialisierte Objekt muss auch als Erstes wieder deserialisiert werden.

Für jedes einzelne Objekt Serialize aufzurufen, kann sehr arbeitsaufwendig sein. Außerdem muss die Anzahl der zu serialisierenden Objekte bekannt sein. Ist die Anzahl nicht vorhersehbar, muss ein anderer Weg beschritten werden. Es bietet sich dann an, alle Objekte in einer Objektauflistung zu verwalten und mit einem einzigen Serialize-Aufruf die gesamte Collection in den Datenstrom zu schreiben. Im folgenden Beispielprogramm wird das an vier Objekten demonstriert.

Sehen wir uns jedoch zuerst den Programmcode an. Dazu werden einer Auflistung vom Typ List<GeometricObject> insgesamt vier Circle- und Rectangle-Objekte hinzugeführt. Anschließend wird die Liste serialisiert und zur Probe auch deserialisiert.

Vorher müssen die Klassen GeometricObject, Circle, GraphicCircle, Rectangle, GraphicRectangle und natürlich auch die Struktur Point mit dem Serializable-Attribut verknüpft werden. Die Klasse List<T> hat natürlich dieses Attribut.

// Beispiel: ...\Kapitel 13\GeometricObjectsSolution_12
class Program {
  static void Main(string[] args) {
    List<GeometricObject> liste = new List<GeometricObject>();
    liste.Add(new Circle(100, -50, 75));
    liste.Add(new Rectangle(120, 46, 310, 210));
    liste.Add(new Circle(69, 70, -200));
    liste.Add(new Rectangle(58, 45, -10, -20));
    // Liste serialisieren
    SaveList(liste);
    // Liste deserialisieren
    List<GeometricObject> newList = GetListObjects();
    foreach (var item in newList)
    {
      Circle circle = item as Circle;
      if (circle != null)
        Console.WriteLine("Circle: Radius = {0,-5}X={1,-5}Y={2}", 
                 circle.Radius, circle.XCoordinate, circle.XCoordinate);
      else
      {
        Rectangle rect = item as Rectangle;
        Console.WriteLine("Rectangle: Length ={0,-5}Width={1,-5}
                           X={2,-5}Y={3}", rect.Length, rect.Width, 
                           rect.XCoordinate, rect.XCoordinate);
      }
    }
    Console.ReadLine();
  }
  public static void SaveList(IList<GeometricObject> elements) {
    FileStream stream = new FileStream(@"D:\GeoObjects.dat", 
                                         FileMode.Create);
    BinaryFormatter binFormatter = new BinaryFormatter();
    binFormatter.Serialize(stream, elements);
    stream.Close();
  }
  public static List<GeometricObject> GetListObjects() {
    FileStream stream = new FileStream(@"D:\GeoObjects.dat", FileMode.Open);
    List<GeometricObject> oldList = null;
    try
    {
      BinaryFormatter formatter = new BinaryFormatter();
      oldList = (List<GeometricObject>)formatter.Deserialize(stream);
    }
    catch (SerializationException e)
    {
      // die Datei kann nicht serialisiert werden
      Console.WriteLine(e.Message);
    }
    catch (IOException e)
    {
      // Beim Versuch, die Datei zu öffnen, ist ein Fehler aufgetreten
      Console.WriteLine(e.Message);
    }
    return oldList;
  }
}

Listing 13.5 Serialisierung geometrischer Objekte

Die Entscheidung für eine Auflistung hat einen entscheidenden Vorteil: Wir brauchen nicht jedes Mitgliedsobjekt der Auflistung einzeln zu serialisieren, sondern können mit einem einzigen Aufruf von Serialize unter Übergabe der List<T>-Referenz automatisch jedes Objekt in den Datenstrom schreiben. Das geschieht in der Methode SaveList, der im Parameter elements die Referenz auf ein Objekt vom Typ List<GeometricObject> übergeben wird.

In der Methode GetListObjects ist nur ein Deserialize-Aufruf notwendig, um die Daten aller von der Collection verwalteten Objekte wiederzuerhalten. Der Rückgabewert vom Typ List<GeometricObject> liefert die vollständig deserialisierte Liste als Referenz an den Aufrufer zurück.

Im Hauptprogramm wird nach der Deserialisierung die von der Methode GetListObjects zurückgegebene Liste in einer foreach-Schleife durchlaufen. Um auch die typspezifischen Member Radius, Length und Width abrufen zu können, ist eine Typkonvertierung notwendig. Im Beispiel wird das mit dem as-Operator durchgeführt.

Ihre Meinung

Wie hat Ihnen das Openbook gefallen? Wir freuen uns immer über Ihre Rückmeldung. Schreiben Sie uns gerne Ihr Feedback als E-Mail an kommunikation@rheinwerk-verlag.de.