Apache Groovy #14 – XML Strukturen

In diesem Beitrag möchte ich dir zeigen, wie du in Apache Groovy XML Strukturen verarbeitest.

In meinem letzten Beitrag Apache Groovy #13 – JSON Daten verarbeiten habe ich dir bereits das Datenformat JSON gezeigt, hier soll es nun um die XML Strukturen gehen.

Quellenangabe

Für diesen Beitrag verwende ich die Seite Processing XML aus der offiziellen, englischen Dokumentation als Grundlage. Solltest du also weitergehende Informationen zu diesem Thema suchen, so empfehle ich dir einen Blick in diese.

Eine Beispiel XML Struktur

Für die nachfolgenden Beispiele benötigen wir eine XML Struktur, hier nun ein kleines Beispiel.

<person>
   <vorname>Stefan</vorname>
   <nachname>Draeger</nachname>
   <alter>42</alter>
</person>

Parsen einer XML Struktur

Zunächst wollen wir die obige XML Struktur parsen. Dazu importieren wir den XmlSlurper und rufen von diesem die Funktion „parseText“ mit unserem XML Daten auf.

Als Rückgabewert der Funktion „parseText“ erhalten wir ein GPathResult durch welches wir gem. unserer XML Struktur durch Steppen können.

import groovy.xml.XmlSlurper

def xml = '''
    <person>
        <vorname>Stefan</vorname>
        <nachname>Draeger</nachname>
        <alter>42</alter>
    </person>
'''

def xmlData = new XmlSlurper().parseText(xml) 

assert xmlData instanceof groovy.xml.slurpersupport.GPathResult 
assert xmlData.vorname == 'Stefan'
assert xmlData.nachname == 'Draeger'
assert xmlData.alter == 42

Ausgabe in der GroovyConsole:

groovy> import groovy.xml.XmlSlurper 
groovy> def xml = ''' 
groovy>     <person> 
groovy>         <vorname>Stefan</vorname> 
groovy>         <nachname>Draeger</nachname> 
groovy>         <alter>42</alter> 
groovy>     </person> 
groovy> ''' 
groovy> def xmlData = new XmlSlurper().parseText(xml)  
groovy> assert xmlData instanceof groovy.xml.slurpersupport.GPathResult  
groovy> assert xmlData.vorname == 'Stefan' 
groovy> assert xmlData.nachname == 'Draeger' 
groovy> assert xmlData.alter == 42 

XML Strukturen erstellen

Im ersten Schritt haben wir die XML Struktur zerlegt und nun möchte ich dir zeigen, wie diese per Groovy erstellt werden kann.

Der einfache Weg ist über einen MarkupBuilder, hier können wir Attribute an ein XML Objekt hängen. Dabei muss dieses Objekt nicht einmal real existieren.

import groovy.xml.MarkupBuilder

def xmlWriter = new StringWriter()
def xmlMarkup = new MarkupBuilder(xmlWriter)

xmlMarkup.person(vorname: "Stefan", nachname:"Draeger", alter:42) 

println(xmlWriter.toString())

Ausgabe in der GroovyConsole:

<person vorname='Stefan' nachname='Draeger' alter='42' />

Erzeugen komplexer XML Strukturen

Bisher haben wir nur einen XML Tag mit ein paar Attributen erzeugt, jedoch müssen wir manchmal auch komplexe Strukturen erstellen, hierzu verwenden wir den Stream.

Hier ein kleines Beispiel, wie man eine Liste mit Personen erzeugen kann.

import groovy.xml.*

def xml = new StreamingMarkupBuilder().bind { 
    records {
        person(vorname: 'Stefan', nachname: 'Draeger', alter: 42) {hobbies('programmieren')}
        person(vorname: 'Max', nachname: 'Mustermann', alter: 31) {hobbies('kochen')}
    }
}

def records = new XmlSlurper().parseText(xml.toString()) 

assert records.person.size() == 2

Wir haben jetzt zwei Personen in ein XML Baum erstellt. In diesem können wir jetzt diverse Operationen ausführen, wie zbsp. das suchen nach einem bestimmten Element mit einem definierten Attribut.

assert records.person.find { it.@vorname == 'Stefan' }.hobbies.text() == 'programmieren'

Speichern der XML Daten

Die erzeugten XML Daten können wir mit Hilfe von XmlUtil recht einfach in eine Datei speichern.

XmlUtil.serialize(xml, new File("./output.xml").newPrintWriter("UTF-8"))

Wenn wir uns die erzeugte Datei einmal anschauen, dann sehen, wir das alle Daten sauber in XML Struktur gespeichert wurde:

<?xml version="1.0" encoding="UTF-8"?>
<records>
  <person vorname="Stefan" nachname="Draeger" alter="42">
    <hobbies>programmieren</hobbies>
  </person>
  <person vorname="Max" nachname="Mustermann" alter="31">
    <hobbies>kochen</hobbies>
  </person>
</records>