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) Holger@Schwichtenberg.de
' ============================
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) Holger@Schwichtenberg.de
' ============================
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.


 

Querverweise

 Liste aller Codebeispiele  Definition '.NET Framework Class Library'  Verfügbarkeit der Klasse 'System.Xml.Serialization.XmlSerializer'  Übersicht über den FCL-Namensraum 'System.Xml.Serialization'  .NET & Visual Studio Community Portal

Buchtipp

Buchcover PowerShell 7 und Windows PowerShell 5 – das Praxishandbuch (5. Auflage Oktober 2022 (9. Auflage Gesamtreihe)) PowerShell 7 und Windows PowerShell 5 – das Praxishandbuch
Autoren: Dr. Holger Schwichtenberg
erschienen 10/2022, 1426 Seiten
ISBN: 3446472967

Beratung & Support

Schulungen zu diesem Thema

 Visual Basic .NET - Aufbauwissen
 Grundlagen der objektorientierten Programmierung anhand von C# oder Visual Basic .NET
 Unit Testing / Testgetriebene Entwicklung / Test Driven Development (TDD) von .NET-Anwendungen (C# oder Visual Basic .NET)
 Visual Basic 6.0 (VB6.0)
 Objektorientierte Entwurfsmuster (Design-Pattern/Architektur-Pattern) mit .NET (C#, Visual Basic .NET)
 Visual Basic .NET - Basiswissen
 Windows Modern Apps/Windows Universal Apps entwickeln mit der Windows Runtime (WinRT), XAML und .NET/C#/Visual Basic
 Visual Basic Script (VBScript/VBS) - Sprachsyntax und Praxiseinsatz
 Word-Programmierung mit Visual Basic for Applications (VBA)
 Visual Studio Tools for Microsoft Office (VSTO) - Microsoft Office-Programmierung mit .NET und C# oder Visual Basic in Visual Studio
 Multi-Threading in .NET mit C#/Visual Basic .NET und/oder C++ und C++/CLI
 C# für Umsteiger von Visual Basic .NET
 Objektorientierte Programmierung (OOP) mit C#, Java, C++, Visual Basic.NET o.ä.
 Excel-Programmierung mit Visual Basic for Applications (VBA)
 Visual Basic .NET für Umsteiger von VBA/VB 4/5/6
 Visual Basic 2005 (Visual Basic 8.0)
 .NET und C# für Umsteiger von klassischem Visual Basic/COM
 Outlook-Programmierung mit Visual Basic for Applications (VBA)
 Das Component Object Model - für Script- und Visual Basic-Entwickler
 C#-Basiswissen (Grundlagen der Programmiersprache C#)
 .NET Akademie: Unit Testing und Test Driven Development (TDD) mit .NET/C# (3-Tages-Agenda des öffentlichen Seminars)
 Neuerungen in C# 7.0/7.1/7.2/7.3
 Task Parallel Library (TPL) - Parallelprogrammierung/Multi-Threading in .NET/C#
 Event Driven Design (mit .NET/C# oder Java)
 Neuerung in der CLR 2.0 und C# 2005
 Neuerungen in C# 6.0
 .NET Akademie: Blazor-Hands-On: Echte Single-Page-Web-Apps mit .NET und C# entwickeln (3-Tages-Agenda des öffentlichen Seminars)
 Neuerungen in C# 3.0 (Visual C# 2008)
 Refactoring von Programmcode in C, C++, C#, Java, Kotlin, JavaScript, TypeScript, Python, Go oder Rust
 Windows 8/Windows 8.1 für Entwickler: Programmierung mit der Windows Runtime (WinRT) - Erstellen von Windows Apps mit C#/XAML und/oder JavaScript/HTML
 Anfrage für eine individuelle Schulung zum Thema Visual Basic C#  Gesamter Schulungsthemenkatalog

Bücher zu diesem Thema

  Blazor 8.0: Moderne Webanwendungen und hybride Cross-Platform-Apps mit .NET 8.0, C# 12.0 und Visual Studio 2022
  C# 12.0 Crashkurs
  C# 11.0 Crashkurs
  C# 10.0 Crashkurs
  C# 9.0 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET 5.0, .NET Core und Xamarin
  ASP.NET Core Blazor 3.1/3.2: Blazor Server und Blazor Webassembly - Moderne Single-Page-Web-Applications mit .NET, C# und Visual Studio
  ASP.NET Core Blazor 3.0/3.1: Blazor Server und Blazor Webassembly - Moderne Single-Page-Web-Applications mit .NET, C# und Visual Studio
  C# 8.0 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin
  C# 7.3 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin
  Modern Data Access with Entity Framework Core: Database Programming Using .NET, .NET Core, UWP, and Xamarin with C#
  C# 7.2 Crashkurs: Die Syntax der Programmiersprache C# für die Softwareentwicklung in .NET Framework, .NET Core und Xamarin
  Effizienter Datenzugriff mit Entity Framework Core: Datenbankprogrammierung mit C# für .NET Framework, .NET Core und Xamarin
  Windows Store Apps entwickeln mit C# und XAML - Crashkurs
  Microsoft ASP.NET 4.0 mit C# 2010 - Entwicklerbuch
  Microsoft Viusal C# 2010
  Visual Basic 2010: Grundlagen, ADO.NET, Windows Presentation Foundation
  ASP.NET 4.0 mit Visual C# 2010
  Visual Basic 2010
  Microsoft ASP.NET 3.5 mit Visual Basic 2008 - Entwicklerbuch
 Alle unsere aktuellen Fachbücher  E-Book-Abo für ab 99 Euro im Jahr