Android解析XML之SAX解析器

SAX(Simple API for XML)解析器是一种基于事件的解析器，它的核心是事件处理模式，主要是围绕着事件源以及事件处理器来工作的。当事件源产生事件后，调用事件处理器相应的处理方法，一个事件就可以得到处理。在事件源调用事件处理器中特定方法的时候，还要传递给事件处理器相应事件的状态信息，这样事件处理器才能够根据提供的事件信息来决定自己的行为。

SAX解析器的优点是解析速度快，占用内存少。非常适合在Android移动设备中使用。

SAX相关类及API

DefaultHandler：是一个事件处理器，可以接收解析器报告的所有事件，处理所发现的数据。它实现了EntityResolver接口、DTDHandler接口、ErrorHandler接口和ContentHandler接口。这几个接口代表不同类型的事件处理器。

利用SAX解析XML，实际上只需要继承DefaultHandler类，然后重写几个关键性方法即可。一般我们需要重写的方法是startDocument、startElement、characters、endElement和endDocument方法。

API解释：

import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;

public class MyParser extends DefaultHandler{
    
    /**
     * 当文档开始解析时此函数被调用
     * 
     * 通常我们需要在这里面做一些初始化的工作，比如分配某些资源
     */
    @Override
    public void startDocument() throws SAXException {
        super.startDocument();
    }
    
    /**
     *  当扫描到文档元素节点起始标志时被调用
     *  
     *  通常我们需要做一下标记，或者分配节点资源。
     */
    @Override
    public void startElement(String uri, String localName, String qName,
            Attributes attributes) throws SAXException {
        super.startElement(uri, localName, qName, attributes);
    }
    
    /**
     *  扫描到元素节点中的字符串内容时调用此函数
     *  @param ch  代表元素内容的字符数组(实测时候并不完全表示元素内容，不过这不影响)
     *  @param start 能够使用的起始位置
     *  @param length 能够使用的数组长度
     */
    @Override
    public void characters(char[] ch, int start, int length)
            throws SAXException {
        super.characters(ch, start, length);
    }
    
    
    /**
     * 扫描到元素节点结束标志时调用
     * 
     * 应该是最重要的一个方法。需要判断节点名作相应的数据解析。
     * @param localName  节点名字
     * @param qName 含限定符的节点名字
     */
    @Override
    public void endElement(String uri, String localName, String qName)
            throws SAXException {
        super.endElement(uri, localName, qName);
    }
    
    /**
     * 扫描文档结束后调用
     * 
     *  如果有些资源需要释放的话，就在这里做好了。
     */
    @Override
    public void endDocument() throws SAXException {
        super.endDocument();
    }
    
}

实例

需要解析的persons.xml文件内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<persons>
    <person id="1" group="1">
        <name>张三</name>
        <age>24</age>
    </person>
    <person id="2" group="2">
        <name>李四</name>
        <age>25</age>
    </person>
    <person id="3" group="1">
        <name>王五</name>
        <age>26</age>
    </person>
</persons>

定义Person实体类：

/**
 * Created by Shane on 2015/4/24.
 */
public class Person {
    private int id;
    private int group;
    private String name;
    private int age;

    public int getId() {
        return id;
    }

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

    public int getGroup() {
        return group;
    }

    public void setGroup(int group) {
        this.group = group;
    }

    public String getName() {
        return name;
    }

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

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }

    @Override
    public String toString() {
        StringBuilder sb = new StringBuilder();

        sb.append("name: " + name);
        sb.append(", age: " + age);
        sb.append(", id: " + id);
        sb.append(", group: " + group);

        return sb.toString();
    }
}

 

定义用于解析XML文件的解析器PersonSAXHandler 类如下：

/**
 * Created by Shane on 2015/4/24.
 */
public class PersonSAXHandler extends DefaultHandler{

    private static final String TAG_PERSON = "person";
    private static final String TAG_NAME = "name";
    private static final String TAG_AGE = "age";

    private List<Person> persons;
    private Person person;

    private StringBuffer stringBuffer;

    public List<Person> getPersons() {
        return persons;
    }

    @Override
    public void startDocument() throws SAXException {
        super.startDocument();

        persons = new ArrayList<>();
        stringBuffer = new StringBuffer();
    }

    @Override
    public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
        super.startElement(uri, localName, qName, attributes);

        if (localName.equals(TAG_PERSON)) {
            person = new Person();
            person.setId(Integer.parseInt(attributes.getValue(0)));
            person.setGroup(Integer.parseInt(attributes.getValue(1)));
        }
        stringBuffer.setLength(0);  // start a new string buffer.
    }

    @Override
    public void characters(char[] ch, int start, int length) throws SAXException {
        super.characters(ch, start, length);

        stringBuffer.append(ch, start, length);
    }

    @Override
    public void endElement(String uri, String localName, String qName) throws SAXException {
        super.endElement(uri, localName, qName);

        if (localName.equals(TAG_PERSON)) {
            persons.add(person);
        } else if (localName.equals(TAG_NAME)) {
            person.setName(stringBuffer.toString().trim());
        } else if (localName.equals(TAG_AGE)) {
            person.setAge(Integer.parseInt(stringBuffer.toString().trim()));
        }

    }

    @Override
    public void endDocument() throws SAXException {
        super.endDocument();
    }
}

 

包装上述PersonSAXHandler类，定义PersonSAXParser类进行解析：

/**
 * Created by Shane on 2015/4/24.
 */
public class PersonSAXParser implements PersonParser{

    @Override
    public List<Person> parse(InputStream inputStream) {
        List<Person> persons = new ArrayList<>();
        try {
            SAXParser saxParser = SAXParserFactory.newInstance().newSAXParser();
            PersonSAXHandler personSAXHandler = new PersonSAXHandler();
            saxParser.parse(inputStream, personSAXHandler);
            persons = personSAXHandler.getPersons();
        } catch (ParserConfigurationException e) {
            e.printStackTrace();
        } catch (SAXException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        } finally {
            if (inputStream != null) {
                try {
                    inputStream.close();
                } catch (IOException e) {}
            }
        }
        return persons;
    }
}

PersonParser接口定义如下：

/**
 * Created by Shane on 2015/4/24.
 */
public interface PersonParser {

    public List<Person> parse(InputStream inputStream);

}