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:

image

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.

image

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:

image

(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:

image

 

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 ]

Wenn dir der Blogpost gefallen hat, dann hinterlasse doch einen Kommentar. Wenn du auf dem Laufenden bleiben willst, abonniere unseren RSS Feed oder folge uns auf Twitter.

About the author

Written by

Hi, ich bin Robert Mühsig und bin Webentwickler und beschäftige mich mit Web-Frameworks auf dem Microsoft Web Stack und scheue mich auch nicht vor Javascript. Der Blog begann als "Problemsammelstelle und Lösungshilfe" und seitdem schreibe ich hier alles auf. Seit 2008 bin ich Microsoft MVP für ASP.NET. Treffen kann man mich online via Twitter (@robert0muehsig) oder hier.

One Response

Comment on this post

Letzte Posts

  • image_thumb.png
    NuGet Package Restore & Build Server wie z.B. AppVeyor

    NuGet ist ja mittlerweile weit verbreitet, aber eine Frage stellt sich natürlich immer noch: Checkt man die NuGet Packages ein oder nicht? In meinem kleinen Side-Projekt, welches auf GitHub liegt und ich über AppVeyor auch bauen lasse nutze ich das Package Restore Feature von NuGet, d.h. in meinem Repository befindet sich kein NuGet Package mehr, […]

  • image.png
    Microsoft Account Login via ASP.NET Identity

    Der Microsoft Account ist die zentrale Identifikationsstelle in der “Consumer-Microsoft-Welt”, allerdings ist das Einbinden eben dieser in die eigene Applikation eher schwierig. Das “Live SDK” ist nun unter dem OneDrive Dev Center zu finden und ganz professionell wurden auch alle Links zum alten Live SDK damit unbrauchbar gemacht. Beim Microsoft Account ist es auch unmöglich […]

  • image.png
    Zeitgesteuerte Azure WebJobs – so einfach kann Azure sein

    Das noch in Entwicklung befindliche Azure WebJob SDK bietet einige coole Features zum Verarbeiten und Bereitstellen von Daten. Bekanntes Beispiel ist das Sample welches auf eine Azure Queue lauscht und sobald ein Item da vorhanden ist anfängt dies zu verarbeiten. Szenario: Zeitgesteuerte Aktivitäten – ohne Queue und co. Mein Szenario war allerdings wesentlich trivialer: Ich […]

  • image.png
    Get Involved in OSS! Ja, aber wie geht das denn mit GitHub?

    Auch im .NET Lager gibt es Bewegung im OSS Bereich und es gibt verschiedene Arten wie man bei einem Open Source Projekt “Contributed”. Was zählt alles zu “Contribution”? Unter “Contribution” läuft eigentlich alles – ob es Fragen/Probleme zu dem Projekt via Issues ist oder Dokumentation nachreicht oder ob man darüber bloggt oder das Projekt vorstellt. […]

  • HowTo: Web.config samt eigener ConfigSection zur Laufzeit ändern

    In dem HowTo geht es darum wie man die Web.config zur Laufzeit ändert und was es dabei zu beachten gilt. Das ganze klappt auch mit komplexeren ConfigSections. Eigene ConfigSection? Vor einer ganzen Weile habe ich mal über das Erstellen einer eigenen ConfigSection geschrieben – im Grunde nutzen wir jetzt fast dieselbe Config. Zur Laufzeit? Startet […]

Amazon Shop

Facebook