Wie man XML mit dem SAX-Parser analysiert

So dass Sie bauen wollen, ein XML-parser zum Parsen eines RSS-Feeds wie dieser.

<rss version="0.92">
<channel>
    <title>MyTitle</title>
    <link>http://myurl.com</link>
    <description>MyDescription</description>
    <lastBuildDate>SomeDate</lastBuildDate>
    <docs>http://someurl.com</docs>
    <language>SomeLanguage</language>

    <item>
        <title>TitleOne</title>
        <description><![CDATA[Some text.]]></description>
        <link>http://linktoarticle.com</link>
    </item>

    <item>
        <title>TitleTwo</title>
        <description><![CDATA[Some other text.]]></description>
        <link>http://linktoanotherarticle.com</link>
    </item>

</channel>
</rss>

Nun haben Sie zwei SAX-Implementierungen, mit dem Sie arbeiten können. Entweder Sie nutzen die org.xml.sax oder die android.sax Umsetzung. Ich werde erklären, die pro 's und con' s der beiden nach der Veröffentlichung einer short-hander Beispiel.

android.sax-Implementierung

Beginnen wir mit der android.sax Umsetzung.

Müssen Sie zuerst definieren Sie die XML-Struktur mit der RootElement und Element Objekte.

In jedem Fall würde ich das arbeiten mit POJOs (Plain Old Java Objects), die Ihre Daten aufnehmen. Hier wäre die POJOs benötigt.

Channel.java

public class Channel implements Serializable {

    private Items items;
    private String title;
    private String link;
    private String description;
    private String lastBuildDate;
    private String docs;
    private String language;

    public Channel() {
        setItems(null);
        setTitle(null);
        //set every field to null in the constructor
    }

    public void setItems(Items items) {
        this.items = items;
    }

    public Items getItems() {
        return items;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getTitle() {
        return title;
    }
    //rest of the class looks similar so just setters and getters
}

Diese Klasse implementiert die Serializable - Schnittstelle, so können Sie es in eine Bundle und tun etwas mit ihm.

Nun brauchen wir eine Klasse unserer Produkte. In diesem Fall bin ich einfach nur zu erweitern, die ArrayList Klasse.

Items.java

public class Items extends ArrayList<Item> {

    public Items() {
        super();
    }

}

War es für unsere Einzelteile-container. Wir brauchen jetzt eine Klasse zu halten, die Daten für jedes einzelne Element.

Item.java

public class Item implements Serializable {

    private String title;
    private String description;
    private String link;

    public Item() {
        setTitle(null);
        setDescription(null);
        setLink(null);
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getTitle() {
        return title;
    }

    //same as above.

}

Beispiel:

public class Example extends DefaultHandler {

    private Channel channel;
    private Items items;
    private Item item;

    public Example() {
        items = new Items();
    }

    public Channel parse(InputStream is) {
        RootElement root = new RootElement("rss");
        Element chanElement = root.getChild("channel");
        Element chanTitle = chanElement.getChild("title");
        Element chanLink = chanElement.getChild("link");
        Element chanDescription = chanElement.getChild("description");
        Element chanLastBuildDate = chanElement.getChild("lastBuildDate");
        Element chanDocs = chanElement.getChild("docs");
        Element chanLanguage = chanElement.getChild("language");

        Element chanItem = chanElement.getChild("item");
        Element itemTitle = chanItem.getChild("title");
        Element itemDescription = chanItem.getChild("description");
        Element itemLink = chanItem.getChild("link");

        chanElement.setStartElementListener(new StartElementListener() {
            public void start(Attributes attributes) {
                channel = new Channel();
            }
        });

        //Listen for the end of a text element and set the text as our
        //channel's title.
        chanTitle.setEndTextElementListener(new EndTextElementListener() {
            public void end(String body) {
                channel.setTitle(body);
            }
        });

        //Same thing happens for the other elements of channel ex.

        //On every <item> tag occurrence we create a new Item object.
        chanItem.setStartElementListener(new StartElementListener() {
            public void start(Attributes attributes) {
                item = new Item();
            }
        });

        //On every </item> tag occurrence we add the current Item object
        //to the Items container.
        chanItem.setEndElementListener(new EndElementListener() {
            public void end() {
                items.add(item);
            }
        });

        itemTitle.setEndTextElementListener(new EndTextElementListener() {
            public void end(String body) {
                item.setTitle(body);
            }
        });

        //and so on

        //here we actually parse the InputStream and return the resulting
        //Channel object.
        try {
            Xml.parse(is, Xml.Encoding.UTF_8, root.getContentHandler());
            return channel;
        } catch (SAXException e) {
            //handle the exception
        } catch (IOException e) {
            //handle the exception
        }

        return null;
    }

}

Dass war jetzt ein sehr kurzes Beispiel wie man sehen kann. Der große Vorteil der Verwendung der android.sax SAX-Implementierung ist, dass Sie definieren die Struktur der XML-Datei, die Sie analysieren und dann einfach fügen Sie einen Ereignis-listener für die entsprechenden Elemente. Der Nachteil ist, dass der code Recht zu wiederholen und zu aufgebläht.

org.xml.sax-Implementierung

Den org.xml.sax SAX-handler-implementation ist ein wenig anders.

Hier müssen Sie nicht angeben, oder deklarieren Sie die XML-Struktur, sondern nur das hören für Veranstaltungen. Die am häufigsten verwendeten sind folgende Veranstaltungen:

• Dokument Starten
• Dokument Ende
• Element Beginnen
• Element Ende
• Zeichen Element zwischen Start-und Element-Ende

Beispiel-handler-Implementierung mit dem Channel-Objekt sieht wie folgt aus.

Beispiel

public class ExampleHandler extends DefaultHandler {

    private Channel channel;
    private Items items;
    private Item item;
    private boolean inItem = false;

    private StringBuilder content;

    public ExampleHandler() {
        items = new Items();
        content = new StringBuilder();
    }

    public void startElement(String uri, String localName, String qName, 
            Attributes atts) throws SAXException {
        content = new StringBuilder();
        if(localName.equalsIgnoreCase("channel")) {
            channel = new Channel();
        } else if(localName.equalsIgnoreCase("item")) {
            inItem = true;
            item = new Item();
        }
    }

    public void endElement(String uri, String localName, String qName) 
            throws SAXException {
        if(localName.equalsIgnoreCase("title")) {
            if(inItem) {
                item.setTitle(content.toString());
            } else {
                channel.setTitle(content.toString());
            }
        } else if(localName.equalsIgnoreCase("link")) {
            if(inItem) {
                item.setLink(content.toString());
            } else {
                channel.setLink(content.toString());
            }
        } else if(localName.equalsIgnoreCase("description")) {
            if(inItem) {
                item.setDescription(content.toString());
            } else {
                channel.setDescription(content.toString());
            }
        } else if(localName.equalsIgnoreCase("lastBuildDate")) {
            channel.setLastBuildDate(content.toString());
        } else if(localName.equalsIgnoreCase("docs")) {
            channel.setDocs(content.toString());
        } else if(localName.equalsIgnoreCase("language")) {
            channel.setLanguage(content.toString());
        } else if(localName.equalsIgnoreCase("item")) {
            inItem = false;
            items.add(item);
        } else if(localName.equalsIgnoreCase("channel")) {
            channel.setItems(items);
        }
    }

    public void characters(char[] ch, int start, int length) 
            throws SAXException {
        content.append(ch, start, length);
    }

    public void endDocument() throws SAXException {
        //you can do something here for example send
        //the Channel object somewhere or whatever.
    }

}

Nun, um ehrlich zu sein kann ich nicht wirklich sagen, keinen echten Vorteil dieser handler-Implementierung in den android.sax. Aber ich kann Ihnen sagen, der Nachteil, das sollte ziemlich offensichtlich. Werfen Sie einen Blick auf die else if-Anweisung in der startElement Methode. Aufgrund der Tatsache, dass wir die tags <title>link und description wir haben zu verfolgen, gibt es in der XML-Struktur, die wir im Augenblick sind. Das ist, wenn wir begegnen, ein <item> Start-tag setzen wir die inItem Flagge zu true um sicherzustellen, dass wir die Karte die richtigen Daten zum richtigen Objekt und in der endElement Methode setzen wir das flag auf false wenn wir auch eine </item> tag. Zu signalisieren, dass wir fertig sind mit dieser item-tag.

In diesem Beispiel ist es ziemlich einfach zu verwalten, aber mit zu Parsen einer komplexeren Struktur mit Hilfe von tags in verschiedenen Ebenen erweist sich als schwierig. Da müsstest du entweder Enums zum Beispiel, um den aktuellen Zustand und eine Menge von switch/case statemenets zu überprüfen, wo Sie sind, oder eine elegantere Lösung wäre eine Art tag-tracker mit ein-tag-stack.

InformationsquelleAutor der Antwort Octavian Damiean