Android中使用sax解析xml文件的方法

sax是一个解析速度快并且占用内存少的xml解析器，非常适合用于android等移动设备。 sax解析xml文件采用的是事件驱动，也就是说，它并不需要解析完整个文档，在按内容顺序解析文档的过程中，sax会判断当前读到的字符是否合法xml 语法中的某部分，如果符合就会触发事件。所谓事件，其实就是一些回调（callback）方法，这些方法(事件)定义在contenthandler接口。下面是一些contenthandler接口常用的方法：

startdocument()：当遇到文档的开头的时候，调用这个方法，可以在其中做一些预处理的工作。

enddocument()：和上面的方法相对应，当文档结束的时候，调用这个方法，可以在其中做一些善后的工作。

startelement(string namespaceuri, string localname, string qname, attributes atts)

当读到一个开始标签的时候，会触发这个方法。 namespaceuri就是命名空间，localname是不带命名空间前缀的标签名，qname是带命名空间前缀的标签名。通过atts可以得到所有的属性名和相应的值。要注意的是sax中一个重要的特点就是它的流式处理，当遇到一个标签的时候，它并不会纪录下以前所碰到的标签，也就是说，在 startelement()方法中，所有你所知道的信息，就是标签的名字和属性，至于标签的嵌套结构，上层标签的名字，是否有子元属等等其它与结构相关的信息，都是不得而知的，都需要你的程序来完成。这使得sax在编程处理上没有dom来得那么方便。

endelement(string uri, string localname, string name)：这个方法和上面的方法相对应，在遇到结束标签的时候，调用这个方法。

characters(char[] ch, int start, int length) ：这个方法用来处理在xml文件中读到的内容，第一个参数为文件的字符串内容，后面两个参数是读到的字符串在这个数组中的起始位置和长度，使用new string(ch,start,length)就可以获取内容。

注意：一个标签之间的字符比较多时，或者字符串中包含有”\n”等特殊字符时，就会出现字符丢失的现象。遇到这种问题不要怀疑sax不能解析标签中含有”\n”或字符比较多的xml。实际上是我们写的handler是有问题的。sax在解析xml时，当遇到一个标签中的内容比较多时，就会多次调用characters。所以我们在写handler时要考虑到这种情况。就不会丢字符了。以下是一种解决方案：新建一个临时变量temp，在调用characters方法中用temp接收数据，在endelement方法中把临时变量temp赋值给目标变量，并给临时变量temp清空，避免出现脏数据，这样就可以解决sax读取xml时不能读取换行符号后面的内容的问题。

ljq.xml 文件

<?xml version="1.0" encoding="utf-8"?>
<persons>
    <person id="23">
        <name>李明</name>
        <age>30</age>
    </person>
    <person id="20">
        <name>李向梅</name>
        <age>25</age>
    </person>
</persons>

实体类

package com.ljq.entity;

import java.io.serializable;

/**
 * 实体类
 *
 * @author jiqinlin
 *
 */
@suppresswarnings("serial")
public class person implements serializable{
    private integer id;
    private string name;
    private short age;

    public person() {
    }

    public person(string name, short age) {
        super();
        this.name = name;
        this.age = age;
    }

    public integer getid() {
        return id;
    }

    public void setid(integer id) {
        this.id = id;
    }

    public string getname() {
        return name;
    }

    public void setname(string name) {
        this.name = name;
    }

    public short getage() {
        return age;
    }

    public void setage(short age) {
        this.age = age;
    }

}

handle类

package com.ljq.service;

import java.util.arraylist;
import java.util.list;

import org.xml.sax.attributes;
import org.xml.sax.saxexception;
import org.xml.sax.helpers.defaulthandler;

import com.ljq.entity.person;

public class xmlcontenthandler extends defaulthandler {
    //临时变量，解决sax读取xml时不能读取换行符号后面的内容的问题；注意temp=""不能写成temp或temp=null，避免脏数据
    private string temp="";
    private string pretag;
    private person person;
    private list<person> persons;

    @override
    public void startdocument() throws saxexception {
        persons = new arraylist<person>();
    }

    @override
    public void characters(char[] ch, int start, int length) throws saxexception {
        if (person!=null){
            string date = new string(ch,start,length);
            if ("name".equals(pretag)) {
                temp+=date;
            }else if ("age".equals(pretag)) {
                temp+=date;
            }
        }
    }

    @override
    public void startelement(string uri, string localname, string name, attributes attributes) throws saxexception {
        if ("person".equals(localname)) {
            person= new person();
            person.setid(attributes.getindex("id"));
        }
        pretag = localname;
    }

    @override
    public void endelement(string uri, string localname, string name) throws saxexception {
        if (person !=null && "name".equals(localname)) {
            person.setname(temp);
            temp="";
        }else if (person !=null && "age".equals(localname)) {
            person.setage(new short(temp));
            temp="";
        }else if (person !=null && "person".equals(localname)) {
            persons.add(person);
            person = null;
        }
        pretag = null;
    }

    //getter...
    public list<person> getpersons() {
        return persons;
    }

}

package com.ljq.service;

import java.io.inputstream;
import java.util.list;

import javax.xml.parsers.saxparser;
import javax.xml.parsers.saxparserfactory;

import com.ljq.entity.person;

/**
 * sax解析工厂
 *
 * @author jiqinlin
 *
 */
public class saxpersonservice {
    // 业务层要对外抛出
    public static list<person> readxml(inputstream instream) throws exception {
        saxparserfactory spf = saxparserfactory.newinstance();
        saxparser saxparser = spf.newsaxparser(); // 创建解析器
        // 设置解析器的相关特性，http://xml.org/sax/features/namespaces = true
        // 表示开启命名空间特性
        // saxparser.setproperty("http://xml.org/sax/features/namespaces",true);
        xmlcontenthandler handler = new xmlcontenthandler();
        saxparser.parse(instream, handler);
        instream.close();
        return handler.getpersons();
    }

}

测试类

package com.ljq.test;

import java.io.inputstream;
import java.util.list;

import com.ljq.entity.person;
import com.ljq.service.saxpersonservice;

import android.test.androidtestcase;
import android.util.log;

public class saxpersonservicetest extends androidtestcase{
    private final string tag = "saxpersonservicetest";
    public void testreadxml() throws exception{
        //ljq.xml放在src目录下
        inputstream inputstream = saxpersonservicetest.class.getclassloader().getresourceasstream("ljq.xml");
        list<person> persons = saxpersonservice.readxml(inputstream);
        for(person person : persons){
           log.i(tag, person.getid() + " : " + person.getname() + " : " + person.getage());
        }
    }
}

运行结果

在android模拟器中，如果是中文字符会出现乱码，在真机上就不会出现这种情况