【攻克Android (37)：XML解析之二】SAX方式解析XML

本文围绕以下两个部分展开：

一、SAX解析

案例一






一、SAX解析

        1. SAX是一个解析速度快并且占用内存少的xml解析器，非常适合用于Android等移动设备。

        2. SAX解析XML文件采用的是事件驱动，也就是说，它并不需要解析完整个文档，在按内容顺序解析文档的过程中，SAX会判断当前读到的字符是否合法XML语法中的某部分，如果符合就会触发事件。

        所谓事件，其实就是一些回调（callback）方法，这些方法(事件)定义在ContentHandler接口。

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

        3. SAX 支持已内置到JDK1.5中，你无需添加任何的jar文件。

        4. 下面是一些ContentHandler接口常用的方法：

            （1）startDocument()

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

            （2）endDocument()

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

            （3）startElement(String namespaceURI, String localName, String qName, Attributes atts)

            当读到一个开始标签的时候，会触发这个方法。

                1）namespaceURI：命名空间。

                2）localName：不带命名空间前缀的标签名。

                3）qName：带命名空间前缀的标签名。

                4）atts：通过atts可以得到所有的属性名和相应的值。

            （4）endElement(String uri, String localName, String name)

            这个方法和上面的方法相对应，在遇到结束标签的时候，调用这个方法。

            （5）characters(char[] ch, int start, int length)

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

            要注意的是SAX中一个重要的特点就是它的流式处理，当遇到一个标签的时候，它并不会纪录下以前所碰到的标签，也就是说，在startElement()方法中，所有你所知道的信息，就是标签的名字和属性，至于标签的嵌套结构，上层标签的名字，是否有子元属等等其它与结构相关的信息，都是不得而知的，都需要你的程序来完成。这使得SAX在编程处理上没有DOM来得那么方便。


案例一

        1. 在java下面创建 persons.xml。里面写入XML内容。

<?xml version="1.0" encoding="UTF-8"?>
<persons>    
	<person id="10">
		<name>段誉</name>
		<age>16</age>
	</person>
	
	<person id="11">
		<name>乔峰</name>
		<age>32</age>
	</person>
</persons>


<!--
  1.
  Table:
    persons : 根元素
    person子节点：一条记录
    属性id：主键列
    name/age：其他字段
    name/age的文本节点：其他字段的值


  Element Node 元素节点
  Text Node 文本节点
  
  xm.substring(start,length)
  new String(ch,start,length)
-->

        2. 创建 com.android.pojo 包，里面创建 Person.java 的 pojo 类，用来封装XML文件中的一条记录。

package com.android.pojo;

/**
 * Created by Xiangdong Lee on 2015/8/25.
 */
public class Person {
    private String id;
    private String name;
    private String age;

    @Override
    public String toString() {
        return "Person{" + "id=" +id +",name='" +name + '\'' +",age="+age+'?';
    }

    public String getId() {
        return id;
    }

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

    public String getName() {
        return name;
    }

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

    public String getAge() {
        return age;
    }

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

        3. 创建com.android.service包，用于放处理业务逻辑的类。在该包下创建 SaxPersonService.java 的类，是一个使用DOM方式解析XML的业务逻辑类。

package com.android.service;

import com.android.pojo.Person;

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

import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;

import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;

/**
 * Sax 解析 xml （基于事件解析。适用于 xml 文件比较大。
 *
 * Created by Xiangdong Lee on 2015/8/26.
 */
public class SaxPersonService {
    public List<Person> getPersons(InputStream is) throws Exception {
        SAXParserFactory factory = SAXParserFactory.newInstance();
        SAXParser parser = factory.newSAXParser();

        PersonHandler handler = new PersonHandler();
        parser.parse(is, handler);
        is.close();
        return handler.getPersons();
    }

    private final class PersonHandler extends DefaultHandler {
        private List<Person> persons = null;
        private String tag = null;
        private Person person = null;

        @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();
                person.setId(attributes.getValue("id"));
            }
            tag = localName;
        }

        @Override
        public void characters(char[] ch, int start, int length)
                throws SAXException {
            if (tag != null) {
                // 获取文本节点的数据
                String data = new String(ch, start, length);
                if ("name".equals(tag)) {
                    person.setName(data);
                } else if ("age".equals(tag)) {
                    person.setAge(data);
                }
            }
        }

        @Override
        public void endElement(String uri, String localName, String qName)
                throws SAXException {
            if ("person".equals(localName)) {
                persons.add(person);
                person = null;
            }
            tag = null;
        }

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

        4. 在测试包下面创建一个单元测试类：PersonServiceTest，用于进行JUnit单元测试。

package com.android.dataparsing;

import android.test.InstrumentationTestCase;
import android.util.Log;

/**
 * Junit 单元测试 -- 要先连接真机/模拟器。
 *      第一步.继承 InstrumentationTestCase 测试案例类
 *      第二步.定义测试方法：方法名必须以 小写的 testXxx 开头
 *      第三步.选中方法名，右击 -> Run -> testXxx()
 *
 * Created by Xiangdong on 2015/8/25.
 */
public class PersonServiceTest extends InstrumentationTestCase {
    private static final String TAG = "MainActivity";

    public void testLog() {
        Log.v(TAG, "This is Junit.");
    }
}

        5. 在测试类中对SAX解析进行测试。写testSax测试方法。

package com.android.dataparsing;

import android.test.InstrumentationTestCase;
import android.util.Log;

import com.android.pojo.Person;
import com.android.service.SaxPersonService;

import java.io.InputStream;
import java.util.List;

/**
 * Junit 单元测试 -- 要先连接真机/模拟器。
 * 第一步.继承 InstrumentationTestCase 测试案例类
 * 第二步.定义测试方法：方法名必须以 小写的 testXxx 开头
 * 第三步.选中方法名，右击 -> Run -> testXxx()
 * <p/>
 * Created by Xiangdong on 2015/8/25.
 */
public class PersonServiceTest extends InstrumentationTestCase {
    private static final String TAG = "MainActivity";

    public void testLog() {
        Log.v(TAG, "This is Junit.");
    }

    /**
     * 该方法有可能抛出异常，直接在此抛出即可
     *
     * @throws Exception
     */
    public void testSax() throws Exception {
        // xml文件读到流中间去了
        InputStream is = getClass().getClassLoader().getResourceAsStream("persons.xml");
        // 把 DOM 解析的类实例化
        // DomPersonService service = new DomPersonService();
        // List<Person> persons = service.getPersons(is);
        SaxPersonService saxPersonService = new SaxPersonService();
        List<Person> persons = saxPersonService.getPersons(is);
        // 用日志循环输出出来
        for (Person person : persons) {
            Log.v(TAG, person.toString());
        }
    }
}

        运行的时候，会报错：

        因为不能直接读取到java文件夹下面的persons.xml文件，而是通过SaxPersonService类中，从流里面读取的。流中的文件是从真机/虚拟机中获取的。

        而persons.xml文件并不在真机/虚拟机中，因此要打包，将其放到其中。


        6. 使用流读取 classpath 下的文件(通过手工命令方式)：

        然后，再测试，就可以正常解析了。