JAVA SAX Parser Beispiel/Tutorial

Posted: Juli 16th, 2010 | Filed under: Internet, Programmieren, Tutorials | Tags: , , , , , | 20 Comments »

„Simple Api for XML“ (SAX) ist eine API zum Parsen(analysieren) von XML-Dateien. Ursprünglich wurde SAX in Java geschrieben ist mittlerweile aber auch in anderen Sprachen verfügbar.

Ich möchte hier ein kleines Beispiel geben um euch zu zeigen wie ihr, in der Praxis, den SAX-Parser benutzen könnt.

Angenommen ihr bekommt eine XML-Datei vorgelegt und sollt alle Personen in einer ArrayList abspeichern. In der XML-Datei befindet sich folgender Inhalt.

XML-Beispiel-Datei

personen.xml

Person.java

Das Personen Objekt repräsentiert eine Person in der XML-Beispiel Datei und dient lediglich als Datenhaltung für die Informationen.

package parser;

import java.util.Date;

public class Person {

  private int id;
  private String name;
  private String vorname;
  private Date geburtsdatum;
  private String postleitzahl;
  private String ort;

  public Person() {

  }

  public int getId() {
    return id;
  }

  public void setId(int id) {
    this.id = id;
  }

  public String getName() {
    return name;
  }

  public void setName(String name) {
    this.name = name;
  }

  public String getVorname() {
    return vorname;
  }

  public void setVorname(String vorname) {
    this.vorname = vorname;
  }

  public Date getGeburtsdatum() {
    return geburtsdatum;
  }

  public void setGeburtsdatum(Date geburtsdatum) {
    this.geburtsdatum = geburtsdatum;
  }

  public String getPostleitzahl() {
    return postleitzahl;
  }

  public void setPostleitzahl(String postleitzahl) {
    this.postleitzahl = postleitzahl;
  }

  public String getOrt() {
    return ort;
  }

  public void setOrt(String ort) {
    this.ort = ort;
  }

  @Override
  public String toString() {
    return "[[" this.id + "] ["this.name + "] [" this.vorname + "]" " [" this.ort
        "] [" this.postleitzahl + "] [" this.geburtsdatum + " ]]";
  }
}

Main.java

Im Folgenden sieht man sehr gut wie man einen XMLReader initialisieren muss. Es besteht sogar die Möglichkeit dem SAX Parser eine DTD zu übergeben. Dies wurde aber in meinem Beispiel einfachheitshalber auskommentiert. Die eigentliche implementierung der SAX Parser Logik steckt jedoch im ContentHandler, dieser folgt anschließend.


package parser;
import java.io.FileNotFoundException;
import java.io.FileReader;
import java.io.IOException;

import org.xml.sax.InputSource;
import org.xml.sax.SAXException;
import org.xml.sax.XMLReader;
import org.xml.sax.helpers.XMLReaderFactory;

public class Main {
  public static void main(String[] args) {
    try {
      // XMLReader erzeugen
      XMLReader xmlReader = XMLReaderFactory.createXMLReader();
      
      // Pfad zur XML Datei
      FileReader reader = new FileReader("X:\\personen.xml");
      InputSource inputSource = new InputSource(reader);

      // DTD kann optional übergeben werden
      // inputSource.setSystemId("X:\\personen.dtd");

      // PersonenContentHandler wird übergeben
      xmlReader.setContentHandler(new PersonenContentHandler());

      // Parsen wird gestartet
      xmlReader.parse(inputSource);
    catch (FileNotFoundException e) {
      e.printStackTrace();
    catch (IOException e) {
      e.printStackTrace();
    catch (SAXException e) {
      e.printStackTrace();
    }
  }
}

PersonenContentHandler.java

Beim Parsen der XML-Datei werden die jeweiligen ContentHandler Funktionen aufgerufen.


package parser;
import java.text.ParseException;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.Date;

import org.xml.sax.Attributes;
import org.xml.sax.ContentHandler;
import org.xml.sax.Locator;
import org.xml.sax.SAXException;

public class PersonenContentHandler implements ContentHandler {

  private ArrayList<Person> allePersonen = new ArrayList<Person>();
  private String currentValue;
  private Person person;

  // Aktuelle Zeichen die gelesen werden, werden in eine Zwischenvariable
  // gespeichert
  public void characters(char[] ch, int start, int length)
      throws SAXException {
    currentValue = new String(ch, start, length);
  }

  // Methode wird aufgerufen wenn der Parser zu einem Start-Tag kommt
  public void startElement(String uri, String localName, String qName,
      Attributes attsthrows SAXException {
    if (localName.equals("person")) {
      // Neue Person erzeugen
      person = new Person();

      // Attribut id wird in einen Integer umgewandelt und dann zu der
      // jeweiligen Person gesetzt
      person.setId(Integer.parseInt(atts.getValue("id")));
    }
  }

  // Methode wird aufgerufen wenn der Parser zu einem End-Tag kommt
  public void endElement(String uri, String localName, String qName)
      throws SAXException {

    // Name setzen
    if (localName.equals("name")) {
      person.setName(currentValue);
    }

    // Vorname setzen
    if (localName.equals("vorname")) {
      person.setVorname(currentValue);
    }

    // Datum parsen und setzen
    if (localName.equals("geburtsdatum")) {
      SimpleDateFormat datumsformat = new SimpleDateFormat("dd.MM.yyyy");
      try {
        Date date = datumsformat.parse(currentValue);
        person.setGeburtsdatum(date);
      catch (ParseException e) {
        e.printStackTrace();
      }
    }

    // Postleitzahl setzen
    if (localName.equals("postleitzahl")) {
      person.setPostleitzahl(currentValue);
    }

    // Ort setzen
    if (localName.equals("ort")) {
      person.setOrt(currentValue);
    }

    // Person in Personenliste abspeichern falls Person End-Tag erreicht
    // wurde.
    if (localName.equals("person")) {
      allePersonen.add(person);
      System.out.println(person);
    }
  }

  public void endDocument() throws SAXException {}
  public void endPrefixMapping(String prefixthrows SAXException {}
  public void ignorableWhitespace(char[] ch, int start, int length)
      throws SAXException {}
  public void processingInstruction(String target, String data)
      throws SAXException {}
  public void setDocumentLocator(Locator locator) {  }
  public void skippedEntity(String namethrows SAXException {}
  public void startDocument() throws SAXException {}
  public void startPrefixMapping(String prefix, String uri)
    throws SAXException {}
}

Ausgabe

Nach dem durchlaufen des SAX Parsers befinden sich nun alle Personen in der ArrayList allePersonen.
[[1] [Mustermann] [Max] [Bierdorf] [54321] [Fri Nov 25 00:00:00 CET 1983 ]]
[[2] [Müller] [Petra] [Bierdorf] [76543] [Fri Apr 13 00:00:00 CEST 1990 ]]

Personen Liste