Android学习笔记（七）-XML解析与生成：SAX、DOM、PULL(推荐)

在Android平台上可以使用Simple API for XML(SAX) 、 Document Object Model(DOM)和Android附带的pull解析器解析XML文件,

1、Simple API for XML(SAX)

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接口，但是其所有的方法体都为空，在实现的时候，你只需要继承这个类，然后重写相应的方法即可。

SAXPersonService.java

package com.geniusxiaoyu.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 com.geniusxiaoyu.domain.Person;

public class SAXPersonService {

public List<Person> getPersons(InputStream is) throws Exception{
SAXParserFactory factory = SAXParserFactory.newInstance();
SAXParser parser = factory.newSAXParser();
PersonParser personParser = new PersonParser();
//解析XML
parser.parse(is, personParser);
return personParser.getpersonList();
}

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

public List<Person> getpersonList(){
return personList;
}

@Override
public void startDocument() throws SAXException {
personList = 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(new Integer(attributes.getValue(0)));
}
tag = localName;
}

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

@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(new Short(data));
}
}
}

}

}

2、 Document Object Model(DOM)

DOM解析XML文件时，会将XML文件的所有内容以文档树方式存放在内存中，然后允许您使用DOM API遍历XML树、检索所需的数据。使用DOM操作XML的代码看起来是比较直观的，并且在编码方面比基于SAX的实现更加简单。但是，因为DOM需要将XML文件的所有内容以文档树方式存放在内存中，所以内存的消耗比较大，特别对于运行Android的移动设备来说，因为设备的资源比较宝贵，所以建议还是采用SAX来解析XML文件，当然，如果XML文件的内容比较小采用DOM也是可行的。

DOMPersonService.java

package com.geniusxiaoyu.service;

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

import javax.xml.parsers.DocumentBuilder;
import javax.xml.parsers.DocumentBuilderFactory;

import org.w3c.dom.Document;
import org.w3c.dom.Element;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

import com.geniusxiaoyu.domain.Person;

public class DOMPersonService {

public List<Person> getPersons(InputStream is) throws Exception{
List<Person> personList = new ArrayList<Person>();
//创建DOM解析器
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
DocumentBuilder builder = factory.newDocumentBuilder();
//开始解析
Document document = builder.parse(is);
Element rootElement = document.getDocumentElement();
NodeList nodeList = rootElement.getElementsByTagName("person");
for(int i=0; i<nodeList.getLength(); i++){
Person person = new Person();
Element personElement = (Element)nodeList.item(i);
person.setId(new Integer(personElement.getAttribute("id")));
NodeList childNodes = personElement.getChildNodes();
for(int j=0; j<childNodes.getLength(); j++){
//判断当前节点是否为元素节点
if(childNodes.item(j).getNodeType() == Node.ELEMENT_NODE){
Element childElement = (Element)childNodes.item(j);
String nodeName = childElement.getNodeName();
if("name".equals(nodeName)){
person.setName(childElement.getFirstChild().getNodeValue());
}else if("age".equals(nodeName)){
person.setAge(new Short(childElement.getFirstChild().getNodeValue()));
}
}
}
personList.add(person);
}
return personList;
}
}

3、Android附带的pull解析器-推荐方式

Pull解析器的运行方式与 SAX 解析器相似。它提供了类似的事件，如：开始元素和结束元素事件，使用parser.next()可以进入下一个元素并触发相应事件。事件将作为数值代码被发送，因此可以使用一个switch对感兴趣的事件进行处理。当元素开始解析时，调用parser.nextText()方法可以获取下一个Text类型节点的值。

有些时候，我们需要生成一个XML文件，生成XML文件的方法有很多，如：可以只使用一个StringBuilder组拼XML内容，然后把内容写入到文件中；或者使用DOM API生成XML文件，或者也可以使用pull解析器生成XML文件，这里推荐大家使用Pull解析器。

PULLPersonService.java

package com.geniusxiaoyu.service;

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

import org.xmlpull.v1.XmlPullParser;
import org.xmlpull.v1.XmlSerializer;

import android.util.Xml;

import com.geniusxiaoyu.domain.Person;

public class PULLPersonService {

public List<Person> getPersons(InputStream is) throws Exception{
List<Person> personList = null;
Person person = null;
//初始化解析器
XmlPullParser parser = Xml.newPullParser();
parser.setInput(is, "UTF-8");
//按顺序解析
int eventType = parser.getEventType();//产生第一个事件
while(eventType != XmlPullParser.END_DOCUMENT){
switch(eventType){
case XmlPullParser.START_DOCUMENT :
personList = new ArrayList<Person>();
break;
case XmlPullParser.START_TAG :
String name = parser.getName();
if("person".equals(name)){
person = new Person();
person.setId(new Integer(parser.getAttributeValue(0)));
}
if(person != null){
if("name".equals(name)){
person.setName(parser.nextText());
}else if("age".equals(name)){
person.setAge(new Short(parser.nextText()));
}
}
break;
case XmlPullParser.END_TAG :
if("person".equals(parser.getName())){
personList.add(person);
person = null;
}
break;
}

eventType = parser.next();
}
return personList;
}

/**
* 生成XML
* @param personList
* @param writer
* @throws Exception
*/
public void generateXml(List<Person> personList, Writer writer) throws Exception{
XmlSerializer serializer = Xml.newSerializer();
serializer.setOutput(writer);
serializer.startDocument("UTF-8", true);

serializer.startTag(null, "persons");
for(Person person : personList){
serializer.startTag(null, "person");
serializer.attribute(null, "id", person.getId().toString());

serializer.startTag(null, "name");
serializer.text(person.getName());
serializer.endTag(null, "name");

serializer.startTag(null, "age");
serializer.text(person.getAge().toString());
serializer.endTag(null, "age");

serializer.endTag(null, "person");
}
serializer.endTag(null, "persons");
serializer.endDocument();
writer.flush();
writer.close();
}
}

最后,列出项目其余相关代码：





data.xml

<?xml version="1.0" encoding="UTF-8"?>
<persons>
<person id="1">
<name>yug</name>
<age>25</age>
</person>
<person id="2">
<name>jay</name>
<age>28</age>
</person>
</persons>

AndroidManifest.xml

<?xml version="1.0" encoding="utf-8"?>
<manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.geniusxiaoyu.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=".XmlActivity"
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="com.geniusxiaoyu.xml" android:label="Tests for My App" />
</manifest>

Person.java

package com.geniusxiaoyu.domain;

public class Person {
private Integer id;
private String name;
private Short age;

public Person(){

}

public Person(Integer id, String name, Short age) {
super();
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 + "]";
}
}

PersonServiceTest.java

package com.geniusxiaoyu.xml;

import java.io.BufferedWriter;
import java.io.File;
import java.io.FileOutputStream;
import java.io.InputStream;
import java.io.OutputStreamWriter;
import java.util.ArrayList;
import java.util.List;

import android.content.Context;
import android.test.AndroidTestCase;
import android.util.Log;

import com.geniusxiaoyu.domain.Person;
import com.geniusxiaoyu.service.DOMPersonService;
import com.geniusxiaoyu.service.PULLPersonService;
import com.geniusxiaoyu.service.SAXPersonService;

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

public void testSAXPerson() throws Exception{
SAXPersonService service = new SAXPersonService();
InputStream is = this.getClass().getClassLoader().getResourceAsStream("data.xml");
List<Person> personList = service.getPersons(is);
for(Person person : personList){
Log.i(TAG, person.toString());
}
}

public void testDOMPerson() throws Exception{
DOMPersonService service = new DOMPersonService();
InputStream is = this.getClass().getClassLoader().getResourceAsStream("data.xml");
List<Person> personList = service.getPersons(is);
for(Person person : personList){
Log.i(TAG, person.toString());
}
}

public void testPULLPerson() throws Exception{
PULLPersonService service = new PULLPersonService();
InputStream is = this.getClass().getClassLoader().getResourceAsStream("data.xml");
List<Person> personList = service.getPersons(is);
for(Person person : personList){
Log.i(TAG, person.toString());
}
}

public void testPULLGenPersonXml() throws Exception{
PULLPersonService service = new PULLPersonService();
List<Person> personList = new ArrayList<Person>();
personList.add(new Person(10, "liLei", (short)15));
personList.add(new Person(12, "HanMeiMei", (short)18));
//		FileOutputStream fos = new FileOutputStream(new File(this.getContext().getFilesDir(), "person.xml"));
FileOutputStream fos = this.getContext().openFileOutput("person.xml", Context.MODE_PRIVATE);
OutputStreamWriter writer = new OutputStreamWriter(fos, "UTF-8");
BufferedWriter bufWriter = new BufferedWriter(writer);

service.generateXml(personList, bufWriter);
}
}