android xml解析之SAX

在Android平台上可以使用Simple API for XML(SAX) 、 Document Object Model(DOM)和Android附带的pull解析器解析XML文件。 下面是本例子要解析的XML文件：

文件名称：itcast.xml
<?xml version="1.0" encoding="UTF-8"?>
<persons>
 <person id="23">
  <name>liming</name>
  <age>30</age>
 </person>
 <person id="20">
  <name>lixiangmei</name>
  <age>25</age>
 </person>
</persons>

例子定义了一个javabean用于存放上面解析出来的xml内容， 这个javabean为Person。javaBean在MVC设计模型中是model，又称模型层，在一般的程序中，我们称它为数据层，就是用来设置数据的属性和一些行为，然后我会提供获取属性和设置属性的get/set方法

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)就可以获取内容。

只要为SAX提供实现ContentHandler接口的类，那么该类就可以得到通知事件（实际上就是SAX调用了该类中的回调方法）。因为ContentHandler是一个接口，在使用的时候可能会有些不方便，因此，SAX还为其制定了一个Helper类：DefaultHandler，它实现了ContentHandler接口，但是其所有的方法体都为空，在实现的时候，你只需要继承这个类，然后重写相应的方法即可。

下面来看具体的实例：

首先建一个itcast.xml文件在src目录下，然后新建一个cn.itcast.domain包，在包下新建一个person类，主要用于存放上面解析出来的xml内容，javaBean在MVC设计模型中是model，又称模型层，在一般的程序中，我们称它为数据层，就是用来设置数据的属性和一些行为，然后我会提供获取属性和设置属性的get/set方法

具体代码如下：

package cn.itcast.domain;

public class Person {
    private Integer id;
    private String name;
    private Short age;
    
    public Person(){}
    
    public Person(Integer id, String name, Short age) {
        this.id = id;
        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;
    }
    @Override
    public String toString() {
        return "Person [age=" + age + ", id=" + id + ", name=" + name + "]";
    }
    
}

第二步：新建一个package cn.itcast.service包，在包下新建一个SAXPersonService类，这个就是MVC里的M，业务类，主要代码如下

package cn.itcast.service;

import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler;

import cn.itcast.domain.Person;
/**
 * 采用SAX解析XML内容
 */
public class SAXPersonService {
    
    public List<Person> getPersons(InputStream inStream) throws Throwable{
        //得到一个Sax解析器工厂
        SAXParserFactory factory = SAXParserFactory.newInstance();
        //得到解析器
        SAXParser parser = factory.newSAXParser();
        //new出一个PersonParser对象出来。把这个对象传到下面语句中
        PersonParser personParser = new PersonParser();
        //对得到的输入流Sax进行解析，第一个参数是要进行解析的xml内容，第二个参数是给 SAX DefaultHandler使用（回调函数）
        parser.parse(inStream, personParser);
        inStream.close();
        //返回得到的getPersons
        return personParser.getPersons();
    }

    private final class PersonParser extends DefaultHandler{
        //把解析到的数据都放到集合里面去
        private List<Person> persons = null;
        //记录当前所解析到的元素节点名称
        private String tag = null;
        private Person person = null;
        //提供一个getpersons方法，主要是为主程序使用
        public List<Person> getPersons() {
            return persons;
        }

        @Override
        public void startDocument() throws SAXException {
            //初始化
            persons = new ArrayList<Person>();
        }
        
        @Override
        public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
            //判断是不是我们要解析的元素节点
            if("person".equals(localName)){
                person = new Person();//new出person对象，把要解析的内容传给person的Id属性
                person.setId(new Integer(attributes.getValue(0)));
            }
            //存放节点名称到成员变量里面
            tag = localName;
        }
        
        @Override
        public void characters(char[] ch, int start, int length)
                throws SAXException {
            //首先判断节点名称是否为空，然后在判断节点名称是否为name
            if(tag!=null){
                String data = new String(ch, start, length);//获取文本节点的数据
                if("name".equals(tag)){//判断节点名称是否为name
                    person.setName(data);//把要解析的内容传给person的name属性
                }else if("age".equals(tag)){//判断节点名称是否为age
                    person.setAge(new Short(data));
                }
            }
        }

        @Override
        public void endElement(String uri, String localName, String qName)
                throws SAXException {
            if("person".equals(localName)){//当跟末节点为person时
                persons.add(person);//把person放到集合persons里面
                person = null;//把当前person设为空
            }
            //遇到结束元素就把记录设为空
            tag = null;
        }
    }
}

第三步：在主包下新建一个PersonServiceTest类，这个类相当与mvc中的c（控制层），主要是对SAXPersonService这个类进行单元测试

public class PersonServiceTest extends AndroidTestCase {
    private static final String TAG = "PersonServiceTest";

    public void testSAXGetPersons() throws Throwable{
        //new出一个业务对象
        SAXPersonService service = new SAXPersonService();
        //通过类加载器加载要解析的文件
        InputStream inStream = getClass().getClassLoader().getResourceAsStream("itcast.xml");
        List<Person> persons = service.getPersons(inStream);
        for(Person person : persons){
            Log.i(TAG, person.toString());    
        }
    }
｝

AndroidMainFest文件代码，这里主要是用到了单元测试，需要加几句代码

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
      package="cn.itcast.xml"
      android:versionCode="1"
      android:versionName="1.0">
    <application android:icon="@drawable/icon" android:label="@string/app_name">
         <uses-library android:name="android.test.runner" />
        <activity android:name=".MainActivity"
                  android:label="@string/app_name">
            <intent-filter>
                <action android:name="android.intent.action.MAIN" />
                <category android:name="android.intent.category.LAUNCHER" />
            </intent-filter>
        </activity>

    </application>
    <uses-sdk android:minSdkVersion="8" />
<instrumentation android:name="android.test.InstrumentationTestRunner"
  android:targetPackage="cn.itcast.xml" android:label="Tests for My App" />
</manifest> 

 

测试结果

这样，xml解析就完成了