Android SAX和DOM解析XML文件
邮箱：[email protected]om
使用SAX或者DOM解析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>
例子定义了一个javabean用于存放上面解析出来的xml内容， 这个javabean为Person，代码请见本页下面备注：
public class Person {
private Integer id;
private String name;
private Short 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;
}
}
布局的效果：
布局代码：
String.xml里面的值代码：
<?xml version="1.0" encoding="utf-8"?>
<resources>
<string name="app_name">用户登录三种数据存储方式</string>
<string name="action_settings">Settings</string>
<string name="hello_world">Hello world!</string>
<string name="text_name">用户名:</string>
<string name="text_pass">密码:</string>
<string name="text_login">登陆</string>
<string name="text_rember">记住密码</string>
<string name="rom">rom存储</string>
<string name="sp">sp存储</string>
<string name="sd">sd存储</string>
</resources>
使用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解析时的服务层的代码：
package com.example.android03xml.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.android03xml.domain.Person;
public class XMLContentHandlerService extends DefaultHandler {
// 解析的person对象存储到list集合中
private List<Person> persons;// =new ArrayList<Person>();
public Person currentPerson;// 解析的当前person对象
public String tagName;// 声明标签的名称
// 获取解析的所有的person对象
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);
// 首先判断tagName是否为空
if (tagName != null) {
// 获取标签中的内容
String data = new String(ch, start, length);
// 判断标签是否是name
if (tagName.equals("name")) {
currentPerson.setName("name");
// 判断标签是否是age
} else if (tagName.equals("age")) {
currentPerson.setAge((short) Integer.parseInt(data));
}
}
}
@Override
public void endDocument() throws SAXException {
// TODO Auto-generated method stub
super.endDocument();
}
@Override
public void endElement(String uri, String localName, String qName)
throws SAXException {
// 当person标签结束的时候 把person对象存储到集中
super.endElement(uri, localName, qName);
if (localName.equals("person")) {
persons.add(currentPerson);
currentPerson = null;
}
this.tagName = null;
}
/**
* 文档开始触发的事件
*/
@Override
public void startDocument() throws SAXException {
super.startDocument();
persons = new ArrayList<Person>();
}
/**
* 当接受到元素开始标签的时候触发该事件 <person> uri:元素的命名空间 localName:元素的本地名称（不带前缀）
* qName:元素的限定名（带前缀） attributes:属性集合
*/
@Override
public void startElement(String uri, String localName, String qName,
Attributes attributes) throws SAXException {
super.startElement(uri, localName, qName, attributes);
// 判断解析的标签是否是person
if (localName.equals("person")) {
// 创建person对象
currentPerson = new Person();
// 把id属性的值解析出来 并且把id赋值给currentPerson对象
currentPerson.setId(Integer.parseInt(attributes.getValue(0)));
}
// person name age
this.tagName = localName;
}
}
效果图：
使用DOM读取XML文件:
除了可以使用 SAX解析XML文件，大家也可以使用熟悉的DOM来解析XML文件。 DOM解析XML文件时，会将XML文件的所有内容以对象树方式存放在内存中，然后允许您使用DOM API遍历XML树、检索所需的数据。使用DOM操作XML的代码看起来比较直观，并且，在某些方面比基于SAX的实现更加简单。但是，因为DOM需要将XML文件的所有内容以对象树方式存放在内存中，所以内存的消耗比较大，特别对于运行Android的移动设备来说，因为设备的资源比较宝贵，所以建议还是采用SAX来解析XML文件，当然，如果XML文件的内容比较小采用DOM是可行的。
使用DOM解析xml文件时的服务层的代码：
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 {
public List<Person> parseXML(InputStream is) {
List<Person> list = new ArrayList<Person>();
// 创建DOM工厂对象
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
try {
// DocumentBuilder对象
DocumentBuilder builder = factory.newDocumentBuilder();
// 获取文档对象
Document document = builder.parse(is);
// 获取文档对象的root
Element root = document.getDocumentElement();
// 获取persons根节点中所有的person节点对象
NodeList personNodes = root.getElementsByTagName("person");
// 遍历所有的person节点
for (int i = 0; i < personNodes.getLength(); i++) {
Person person = new Person();
// 根据item(index)获取该索引对应的节点对象
Element personNode = (Element) personNodes.item(i); // 具体的person节点
// 设置id属性值
person.setId(Integer.parseInt(personNode.getAttribute("id")));
// 获取该节点下面的所有字节点
NodeList personChildNodes = personNode.getChildNodes();
// 遍历person的字节点
for (int index = 0; index < personChildNodes.getLength(); index++) {
// 获取子节点
Node node = personChildNodes.item(index);
// 判断node节点是否是元素节点
if (node.getNodeType() == Node.ELEMENT_NODE) {
//把节点转换成元素节点
Element element = (Element) node;
//判断元素节点是否是name元素节点
if ("name".equals(element.getNodeName())) {
person.setName(element.getFirstChild()
.getNodeValue());
} else if ("age".equals(element.getNodeName())) { //判断是否是age节点
person.setAge(new Short(element.getFirstChild()
.getNodeValue()));
}
}
}
// 把person对象加入到集合中
list.add(person);
}
//关闭输入流
is.close();
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
return list;
}
}
效果图：
使用Pull解析器读取XML文件
除了可以使用 SAX和DOM解析XML文件，大家也可以使用Android内置的Pull解析器解析XML文件。 Pull解析器的运行方式与 SAX 解析器相似。它提供了类似的事件，如：开始元素和结束元素事件，使用parser.next()可以进入下一个元素并触发相应事件。事件将作为数值代码被发送，因此可以使用一个switch对感兴趣的事件进行处理。当元素开始解析时，调用parser.nextText()方法可以获取下一个Text类型元素的值。
使用Pull解析器读取itcast.xml的代码在本页下方备注
Pull解析器的源码及文档下载网址：http://www.xmlpull.org/
有些时候，我们需要生成一个XML文件，生成XML文件的方法有很多，如：可以只使用一个StringBuilder组拼XML内容，然后把内容写入到文件中；或者使用DOM API生成XML文件，或者也可以使用pull解析器生成XML文件，这里推荐大家使用Pull解析器。
使用Pull解析器生成一个与itcast.xml文件内容相同的myitcast.xml文件，代码在本页下方备注
使用代码如下（生成XML文件）：
File xmlFile = new File("myitcast.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();
使用Pull解析xml文件时的服务层的代码：
import org.xmlpull.v1.XmlPullParser;
import android.util.Xml;
import cn.itcast.xml.domain.Person;
public class PullXMLReader {
public static List<Person> readXML(InputStream inStream) {
XmlPullParser parser = Xml.newPullParser();
try {
parser.setInput(inStream, "UTF-8");
int eventType = parser.getEventType();
Person currentPerson = null;
List<Person> persons = null;
while (eventType != XmlPullParser.END_DOCUMENT) {
switch (eventType) {
case XmlPullParser.START_DOCUMENT://文档开始事件,可以进行数据初始化处理
persons = new ArrayList<Person>();
break;
case XmlPullParser.START_TAG://开始元素事件
String name = parser.getName();
if (name.equalsIgnoreCase("person")) {
currentPerson = new Person();
currentPerson.setId(new Integer(parser.getAttributeValue(null, "id")));
} else if (currentPerson != null) {
if (name.equalsIgnoreCase("name")) {
currentPerson.setName(parser.nextText());// 如果后面是Text元素,即返回它的值
} else if (name.equalsIgnoreCase("age")) {
currentPerson.setAge(new Short(parser.nextText()));
}
}
break;
case XmlPullParser.END_TAG://结束元素事件
if (parser.getName().equalsIgnoreCase("person") && currentPerson != null) {
persons.add(currentPerson);
currentPerson = null;
}
break;
}
eventType = parser.next();
}
inStream.close();
return persons;
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
}
最重要的MainActivity中的代码:
package com.example.android03xml;
import java.io.IOException;
import java.io.InputStream;
import java.util.List;
import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;
import com.example.android03xml.domain.Person;
import com.example.android03xml.service.XMLContentHandlerService;
import com.example.android03xml.service.XMLDomService;
import android.app.Activity;
import android.os.Bundle;
import android.view.Menu;
import android.view.View;
import android.widget.Button;
import android.widget.Toast;
public class MainActivity extends Activity {
// 声明控件
public Button btn_sax, btn_dom, btn_pull;
public XMLDomService xmlDomService;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// 设置显示的视图
setContentView(R.layout.activity_main);
//实例化
xmlDomService = new XMLDomService();
// 通过findViewById方法获取控件对象
btn_sax = (Button) findViewById(R.id.btn_sax);
btn_dom = (Button) findViewById(R.id.btn_dom);
btn_pull = (Button) findViewById(R.id.btn_pull);
// 给按钮注册事件
btn_sax.setOnClickListener(new MyClickListener());
btn_dom.setOnClickListener(new MyClickListener());
btn_pull.setOnClickListener(new MyClickListener());
}
@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 MyClickListener implements View.OnClickListener {
@Override
public void onClick(View v) {
// 获取组件的id
int id = v.getId();
switch (id) {
case R.id.btn_sax:
// sax解析的工厂对象
SAXParserFactory factory = SAXParserFactory.newInstance();
try {
// 得到sax的解析器
SAXParser saxParser = factory.newSAXParser();
// 创建handler对象
XMLContentHandlerService handlerService = new XMLContentHandlerService();
// 获取到了 asserts目录中 csdn.xml文件
InputStream is = getAssets().open("csdn.xml");
// 直接解析 InputStream的流对象
saxParser.parse(is, handlerService);
// 通过 handlerService对象
Toast.makeText(MainActivity.this,
"---" + handlerService.getPersons().size(),
Toast.LENGTH_LONG).show();
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
break;
case R.id.btn_dom:
InputStream is=null;
try {
//获取读取文件的输入流对象
is = getAssets().open("csdn.xml");
//采用dom解析
List<Person> persons = xmlDomService.parseXML(is);
//简单测试
Toast.makeText(MainActivity.this, ""+persons.get(0).getName(), Toast.LENGTH_LONG).show();
} catch (IOException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
break;
case R.id.btn_pull:
Toast.makeText(MainActivity.this, "采用pull解析xml文件案例",
Toast.LENGTH_LONG).show();
break;
}
}
}
}