Mit ‘XML’ getaggte Artikel

 

XStream: Object -> XML -> Object

Donnerstag, 19. November 2009

Mit der Bibliothek XStream lassen sich auf einfache Weise Java Objekte in XML zu serialisieren und wieder zurück.
Das kann z.B. dazu dienen, Datensätze als Textdatei abzuspeichern oder XML für Unit-Tests zu erzeugen.
Vorteile von XStream sind die sehr einfache Anwendung und die gute Performance. Neuere Versionen von XStream bieten zudem die Möglichkeit auch JSON zu erzeugen oder die Integration in andere XML APIs.

Nun ein paar Beispiele zur Verwendung von XStream.

XStream verwendet per default die Pull-Parser Implementierung XPP3. Das entsprechende JAR muss hierzu separat heruntergeladen und im Classpath hinzugefügt werden. (Die XPP3 Implementierung am Besten über eine Suchmaschine im Internet suchen.)

Anmerkung:
Wir verwenden hier Aliase für Klassennamen. Das hat den Vorteil, dass das XML lesbarer wird und vor allem eine Deserialisierung auch nach einem Umbenennen oder Verschieben der Klasse funktioniert.

Objekt nach XML serialisieren

  final XStream xstream = new XStream();
  // set alias for the MyData class 
  xstream.alias("my-data", MyData.class);
  // MyData myData = new MyData(....);
  final String xml = xstream.toXML(myData);

Objekt aus XML deserialisieren

  final XStream xstream = new XStream();
  // set alias for the MyData class 
  xstream.alias("my-data", MyData.class);
  // String xml = 
  MyData myData = (MyData) xstream.fromXML(xml);

Interaktion mit dom4J

Mit XStream lassen sich auch Objekte in ein bestehendes XML Document einfügen. In diesem Beispiel wird ein dom4j Element ermittelt und an die Methode addToElement() übergeben, welche das Objekt myData in das Element serialisiert:

  public void addToElement(final MyData myData, final org.dom4j.Element element) {
    final XStream xstream = new XStream();
    xstream.alias("my-data", MyData.class);
    // create new com.thoughtworks.xstream.io.xml.Dom4JWriter
    final Dom4JWriter writer = new Dom4JWriter(element);
    xstream.marshal(myData, writer);
    writer.close();
  }

Natürlich ist der Weg zurück zum Objekt aus dem XML genauso einfach:

  public MyData getFromElement(final org.dom4j.Element element) {
    final XStream xstream = new XStream();
    xstream.alias("my-data", MyData.class);
    final Dom4JReader reader = new Dom4JReader(element);
    return (MyData) xstream.unmarshal(reader);
  }

Viel Spaß und Erfolg beim Ausprobieren und Anwenden.


Christof Aenderl

Tags:, , ,
Abgelegt in Java, XML | Keine Kommentare »

XML <=> Objekt mit JAXB

Donnerstag, 12. Februar 2009

Gründe warum man Objekte direkt in XML umwandeln will (oder anders herum) gibt es viele. Mit JAXB steht im Java SDK 1.6 jetzt eine besonders einfache Möglichkeit zur Verfügung.

Für die Umwandlung eines einfachen Objektes reicht bereits eine Annotation an der Klasse sowie der Aufruf des JAXB Marschallers.

Eine einfache Klasse mit der @XmlRootElement annotation:

@XmlRootElement
public class Person {
    private String firstname;
    private String name;
 
    public Person() {
    }
 
    public String getFirstname() {
        return firstname;
    }
 
    public void setFirstname(final String firstname) {
        this.firstname = firstname;
    }
 
    public String getName() {
        return name;
    }
 
    public void setName(final String name) {
        this.name = name;
    }
}

Mit dem Marshaller wird aus einem Objekt eine XML Datei.

public class Test {
    public static void main(final String[] args) throws Exception {
        final Person person = new Person();
        person.setFirstname("Max");
        person.setName("Mustermann");
 
        //  JAXBContext erstellen mit
        final JAXBContext jc = JAXBContext.newInstance(Person.class);
 
        // Marshaller erstellen
        final Marshaller marshaller = jc.createMarshaller();
 
        // person objekt nach XML wandeln und in eine Datei schreiben.
        marshaller.marshal(person,new File("person.xml"));
    }
}

Unmarshalling einer XML Datei in ein Objekt:

public class Test {
    public static void main(final String[] args) throws Exception {
        //  JAXBContext erstellen mit
	final JAXBContext jc = JAXBContext.newInstance(Person.class);
 
        // Marshaller erstellen
        final Unmarshaller unmarshaller = jc.createUnmarshaller();
 
        // XML auslesen und person Objekt befuellen
        final Person person = (Person) unmarshaller.unmarshal(new File("person.xml"));
        System.out.println(person.getFirstname());
        System.out.println(person.getName());
    }
}

Um Einfluss auf die Struktur des erzeugten XMLs zu nehmen bietet sich ein Blick in das Paket javax.xml.bind.annotation an. Mit Hilfe dieser Annotations kann die Struktur des erstellten XML beeinflusst werden, bzw. die Klasse kann an ein bestehendes XML angepasst werden.

Wenn große XML Dateien eingelesen werden sollen, so ist dies in den seltensten Fällen mit einer passenden Klasse erledigt. Wenn aber viele kleine Klassen erstellt werden, muss man dem JAXBContext beim erstellen sehr viele Klassen bekannt machen. Einfacher ist es in das Paket neben die Klassen für die XML Umwandlung eine Datei jaxb.index zu legen. In dieser Datei werden alle Klassen aufgeführt werden die dem JAXBContext bekannt gemacht werden sollen. Beim erzeugen des JAXBContext brauchen nun keine Klassennamen mehr übergeben werden.


Felix Breske

Tags:,
Abgelegt in Java, XML | Keine Kommentare »