HowTo: XML erstellen mit XmlAttributes

Es gibt viele Möglichkeiten ein XML mit .NET zu erstellen. Eine sehr praktische und schnelle Möglichkeit ist die XmlAttributes-Variante zu verwenden.
Oft hat man schon ein Objektmodell das man als XML ausgeben oder eine XML Datei die man in sein Objektmodell einlesen möchte. Für diese Aufgaben ist der XmlSerializer ideal.

Ein einfaches Schreiben:

 XmlSerializer _xmlGen = new XmlSerializer(typeof(string));
            _xmlGen.Serialize(Console.Out,"www.code-inside.de");

Erklärung: Wir serializieren hier einfach den String www.code-inside.de auf der Console und schauen uns an was passiert:

So wird es auf der Kommandozeile ausgegeben.

Ein einfaches Lesen:

XmlSerializer _xmlGen = new XmlSerializer(typeof(string));
            Console.WriteLine(
                _xmlGen.Deserialize(
                       new StringReader("<string>www.Code-Inside.de</string>")));

Erklärung: Diesmal wollen wir einfach unser XmlTag (mit dem Code-Inside.de), was rein theoretisch z.B. in einer Datei stehen könnte) wieder lesen.

Da ist wieder unser ursprünglicher String ;)

Man kann natürlich nicht nur Strings serialisieren, sondern auch komplexere Objekte.
Wichtig: Diese Klassen müssen dann "public" sein und einen leeren Konstruktor haben.

Wenn man Objekte serialisiert dann werden die Elemente im XML nach dem Variablennamen oder dem Datentypen des serialisierten Objektes benannt, weil dies aber nur selten sinnvoll ist, gibt es die Möglichkeit die Ausgabe über Attribute zu steuern.
Eine Liste der XmlAttribute findet sich natürlich auf der MSDN.

Klassenstruktur für unser Beispielprojekt:

(auch wenn Oliver, welcher den Artikel vorbereitet & zum großen Teil geschrieben hat, das alles in die Program.cs mit reinschreiben wollte ;) )

Der Code ist einfach gehalten. Über den einzelnen Eigenschaften wurde, wie z.B. beim Title des BlogEntry, das XmlAttribute gesetzt:

        [XmlElement("title")]
        public string Title
        {
            get { return _title; }
            set { _title = value; }
        }

Sowie über den Klassennamen des BlogEntrys das XmlRootAttribute:

[XmlRootAttribute("BlogEntry")]
    public class BlogEntry

Das Schreiben wurde ähnlich Implementiert wie bei dem simplen Beispiel:

 BlogEntry _myBlogEntry = new BlogEntry();
      _myBlogEntry._title = "XML erstellen mit XmlAttributes";
      _myBlogEntry._content = "Es gibt viele Möglichkeiten...";
      for (int i = 0; i < 2; i++)
      {
         _myBlogEntry._comments.Add(new BlogComment("Paul","Cooole Sache"));
         _myBlogEntry._comments[i]._comments.Add(new BlogComment("Tim", "Finde ich auch Paul")); 
      }      
      _xmlGen.Serialize(Console.Out, _myBlogEntry);

Wir erstellen ein Blogeintrag und hängen noch ein paar Blogkommentare dran und schreiben das auf die Konsole. In unserer Demoanwendung später, werden wir dies allerdings in eine Datei speichern, welche im bin Verzeichnis zu finden ist..

Das resultierende Xml daraus:

<?xml version="1.0" encoding="UTF-8"?>
<BlogEntry xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http ://www.w3.org/2001/XMLSchema">
  <Title>XML erstellen mit XmlAttributes</Title>
  <content>Es gibt viele Möglichkeiten...</content>
  <comments name="Paul">
    <content>Cooole Sache</content>
    <comments name="Tim">
      <content>Finde ich auch Paul</content>
    </comments>
  </comments>
  <comments name="Paul">
    <content>Cooole Sache</content>
    <comments name="Tim">
      <content>Finde ich auch Paul</content>
    </comments>
  </comments>
</BlogEntry>

Das Lesen erfolgt ähnlich wie bereits oben erwähnt. In der Demoanwendung sieht das Ergebniss beim Ausführen so aus:

Fazit: MIt dem XmlSerializer und XmlAttributes lassen sich auch komplexe XML Dateien sehr schnell, einfach und übersichtlich lesen und schreiben, besonders bei rekursiven Strukturen zeigen sich deutliche Vorteile gegenüber dem XmlTextWriter.

[ Download Democode ]