使用SAX或者DOM或者XmlPullParser解析XML文件

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


文件名称：csdn.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>


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

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

public static List<Person> readXML(InputStream inStream) {

   try {

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();

   } catch (Exception e) {

e.printStackTrace();

   }

  return null;

}

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

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

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


使用Pull解析器读取itcast.xml的代码在本页下方备注


Pull解析器的源码及文档下载网址：http://www.xmlpull.org/

使用Pull解析器生成XML文件
有些时候，我们需要生成一个XML文件，生成XML文件的方法有很多，如：可以只使用一个StringBuilder组拼XML内容，然后把内容写入到文件中；或者使用DOM API生成XML文件，或者也可以使用pull解析器生成XML文件，这里推荐大家使用Pull解析器。 Note: some char "&" etc,not supported
使用Pull解析器生成一个与csdn.xml文件内容相同的mycsdn.xml文件，代码在本页下方备注


使用代码如下（生成XML文件）：

File xmlFile = new File("mycsdn.xml");

FileOutputStream outStream = new FileOutputStream(xmlFile);

OutputStreamWriter outStreamWriter = new OutputStreamWriter(outStream, "UTF-8");

BufferedWriter writer = new BufferedWriter(outStreamWriter);

writeXML(persons, writer);

writer.flush();

writer.close();

如果只想得到生成的xml字符串内容，可以使用StringWriter：

StringWriter writer = new StringWriter();

writeXML(persons, writer);

String content = writer.toString();

案例：

Activity类：


package com.example.lession03_xml;

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

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

import android.app.Activity;
import android.os.Bundle;
import android.view.Menu;
import android.view.View;
import android.view.View.OnClickListener;
import android.widget.Button;
import android.widget.Toast;

import com.example.lession03_xml.domain.Person;
import com.example.lession03_xml.service.PullXmlService;
import com.example.lession03_xml.service.XmlDomService;
import com.example.lession03_xml.service.XmlParseService;

public class MainActivity extends Activity {

public Button btn_xml, btn_dom, btn_full, btn_pullxml;
public XmlDomService xmlDomService;
public PullXmlService pullXmlService;

@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main);
xmlDomService = new XmlDomService();
pullXmlService = new PullXmlService();

btn_xml = (Button) findViewById(R.id.btn_xml);
btn_dom = (Button) findViewById(R.id.btn_dom);
btn_full = (Button) findViewById(R.id.btn_full);
btn_pullxml = (Button) findViewById(R.id.btn_fullxml);

btn_xml.setOnClickListener(new MyOnClickListener());
btn_dom.setOnClickListener(new MyOnClickListener());
btn_full.setOnClickListener(new MyOnClickListener());
btn_pullxml.setOnClickListener(new MyOnClickListener());

}

@Override
public boolean onCreateOptionsMenu(Menu menu) {
// Inflate the menu; this adds items to the action bar if it is present.
getMenuInflater().inflate(R.menu.main, menu);
return true;
}

class MyOnClickListener implements OnClickListener {

@Override
public void onClick(View v) {
Integer id = v.getId();
switch (id) {
case R.id.btn_xml:
SAXParserFactory factory = SAXParserFactory.newInstance();
try {
XmlParseService handler = new XmlParseService();
SAXParser saxParser = factory.newSAXParser();
InputStream is = getAssets().open("csdn.xml");
saxParser.parse(is, handler);
is.close();
Toast.makeText(MainActivity.this,
"---" + handler.getPersons().size(),
Toast.LENGTH_LONG).show();
} catch (Exception e) {
e.printStackTrace();
}
break;
case R.id.btn_dom:
try {
InputStream is = getAssets().open("csdn.xml");
List<Person> list = xmlDomService.parseXml(is);
Toast.makeText(MainActivity.this,
"---" + list.get(1).getName(), Toast.LENGTH_LONG)
.show();
} catch (IOException e) {
e.printStackTrace();
}
break;
case R.id.btn_full:
try {
List<Person> persons = pullXmlService.readXml(getAssets()
.open("csdn.xml"));
Toast.makeText(MainActivity.this,
"pull解析长度" + persons.size(), Toast.LENGTH_LONG)
.show();
} catch (IOException e) {
e.printStackTrace();
}
break;
case R.id.btn_fullxml:
try {
List<Person> persons = pullXmlService.readXml(getAssets()
.open("csdn.xml"));
boolean flag = pullXmlService.write(persons);
if (flag) {
Toast.makeText(MainActivity.this, "采用pull解析创建xml文件成功",
Toast.LENGTH_LONG).show();
} else {
Toast.makeText(MainActivity.this, "采用pull解析创建xml文件失败",
Toast.LENGTH_LONG).show();
}
} catch (IOException e) {
e.printStackTrace();
}
}

}

}
}

Domain类：


package com.example.lession03_xml.domain;

import java.io.Serializable;

/**
*
* @author
*/
public class Person implements Serializable {

/**
*
*/
private static final long serialVersionUID = 1L;
private Integer id;
private String name;
private Short age;

public Person() {
super();
}

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;
}

}

Dom解析类代码：


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

public class XmlDomService {
private List<Person> persons = new ArrayList<Person>();

private Person person;

public List<Person> parseXml(InputStream is) {
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
try {
DocumentBuilder documentBuilder = factory.newDocumentBuilder();
Document document = documentBuilder.parse(is);
Element root = document.getDocumentElement();
NodeList nodeList = root.getElementsByTagName("person");
for (int i = 0; i < nodeList.getLength(); i++) {
person = new Person();
Element node = (Element) nodeList.item(i);
person.setId(Integer.parseInt(node.getAttribute("id")));

NodeList childNodeList = node.getChildNodes();
for (int j = 0; j < childNodeList.getLength(); j++) {
Node childNode = childNodeList.item(j);
if (childNode.getNodeType() == childNode.ELEMENT_NODE) {
Element element = (Element) childNode;
if ("name".equals(element.getNodeName())) {
person.setName(element.getFirstChild()
.getNodeValue());
} else if ("age".equals(element.getNodeName())) {
person.setAge(Short.parseShort(element
.getFirstChild().getNodeValue()));
}
}
}
persons.add(person);
}
is.close();
} catch (Exception e) {
e.printStackTrace();
}

return persons;
}

}

Sax解析类代码：


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

/**
*
* @author
*/
public class XmlParseService extends DefaultHandler {

private List<Person> persons;
private Person curPerson;

private String domName;

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

public void setPersons(List<Person> persons) {
this.persons = persons;
}

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

String data = new String(ch, start, length);
if (domName != null) {
if (domName.endsWith("name")) {
curPerson.setName(data);
} else if (domName.equals("age")) {
curPerson.setAge(Short.parseShort(data));
}
}
}

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

@Override
public void startDocument() throws SAXException {
super.startDocument();
persons = new ArrayList<Person>();
}

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

if (localName.equals("person")) {
curPerson = new Person();
curPerson.setId(Integer.parseInt(attributes.getValue(0)));
}
this.domName = localName;

}

}

pull解析类代码：

package com.example.lession03_xml.service;

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

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

import android.os.Environment;
import android.util.Xml;

import com.example.lession03_xml.domain.Person;

/**
*
* @author
*/
public class PullXmlService {

public Person currentPerson;
public List<Person> persons;

// 采用pull解析读取xml文件
public List<Person> readXml(InputStream is) {
XmlPullParser xmlPullParser = Xml.newPullParser();
try {
xmlPullParser.setInput(is, "utf-8");
int eventType = xmlPullParser.getEventType();
while (eventType != XmlPullParser.END_DOCUMENT) {
switch (eventType) {
case XmlPullParser.START_DOCUMENT:
persons = new ArrayList<Person>();
break;
case XmlPullParser.START_TAG:
String tagName = xmlPullParser.getName();
if ("person".equals(tagName)) {
currentPerson = new Person();
currentPerson.setId(Integer.parseInt(xmlPullParser
.getAttributeValue(0)));
} else if ("name".equals(tagName)) {
currentPerson.setName(xmlPullParser.nextText());
} else if ("age".equals(tagName)) {
currentPerson.setAge(Short.parseShort(xmlPullParser
.nextText()));
}
break;

case XmlPullParser.END_TAG:
if ("person".equals(xmlPullParser.getName())
&& currentPerson != null) {
persons.add(currentPerson);
currentPerson = null;
}
break;
}
eventType = xmlPullParser.next();

}
is.close();
} catch (Exception e) {
e.printStackTrace();
}

return persons;
}

// 采用pull解析创建xml文件
public boolean write(List<Person> persons) {
if (Environment.getExternalStorageState().equals(
Environment.MEDIA_MOUNTED)) {
File sdCard = Environment.getExternalStorageDirectory();
File file = new File(sdCard, "mycsdn.xml");
XmlSerializer serializer = Xml.newSerializer();
try {
FileOutputStream fos = new FileOutputStream(file);
serializer.setOutput(fos, "UTF-8");
serializer.startDocument("UTF-8", true);
serializer.startTag(null, "persons");
for (Person person : persons) {
serializer.startTag(null, "person");
serializer.attribute(null, "id", person.getId() + "");
serializer.startTag(null, "name");
serializer.text(person.getName());
serializer.endTag(null, "name");
serializer.startTag(null, "age");
serializer.text(person.getAge() + "");
serializer.endTag(null, "age");
serializer.endTag(null, "person");
}
serializer.endTag(null, "persons");
serializer.endDocument();
fos.flush();
fos.close();
return true;
} catch (Exception e) {
e.printStackTrace();
}
}
return false;
}
}


class Test {
public Person person;
public List<Person> persons;
XmlPullParser xmlPullParser;

public List<Person> aaa(InputStream is) {

try {
xmlPullParser = XmlPullParserFactory.newInstance().newPullParser();
} catch (XmlPullParserException e1) {
// TODO Auto-generated catch block
e1.printStackTrace();
}
try {
xmlPullParser.setInput(is, "UTF-8");
int eventType = xmlPullParser.getEventType();
while (eventType != XmlPullParser.END_DOCUMENT) {
switch (eventType) {
case XmlPullParser.START_DOCUMENT:
persons = new ArrayList<Person>();
break;

case XmlPullParser.START_TAG:
String tagName = xmlPullParser.getName();
if ("person".equals(tagName)) {
person = new Person();
person.setId(Integer.parseInt(xmlPullParser
.getAttributeValue(null, "id")));
} else if ("name".equals(tagName)) {
person.setName(xmlPullParser.nextText());
} else if ("age".equals(tagName)) {
person
.setId(Short.parseShort(xmlPullParser
.nextText()));
}
break;
case XmlPullParser.END_TAG:
if ("person".equals(xmlPullParser.getName())
&& person != null) {
persons.add(person);
person = null;
}
}
eventType = xmlPullParser.next();
}
is.close();
} catch (Exception e) {
e.printStackTrace();
}

return persons;
}
}