Android中解析XML

来自：http://blog.csdn.net/chengyingzhilian/article/details/7658768

感谢原作者

XML在各种开发中都广泛应用，Android也不例外。作为承载数据的一个重要角色，如何读写XML成为Android开发中一项重要的技能。今天就由我向大家介绍一下在Android平台下几种常见的XML解析和创建的方法。

在Android中，常见的XML解析器分别为SAX解析器、DOM解析器和PULL解析器，下面，我将一一向大家详细介绍。

SAX解析器：

SAX(Simple API for XML)解析器是一种基于事件的解析器，它的核心是事件处理模式，主要是围绕着事件源以及事件处理器来工作的。当事件源产生事件后，调用事件处理器相应的处理方法，一个事件就可以得到处理。在事件源调用事件处理器中特定方法的时候，还要传递给事件处理器相应事件的状态信息，这样事件处理器才能够根据提供的事件信息来决定自己的行为。

SAX解析器的优点是解析速度快，占用内存少。非常适合在Android移动设备中使用。

DOM解析器：

DOM是基于树形结构的的节点或信息片段的集合，允许开发人员使用DOM API遍历XML树、检索所需数据。分析该结构通常需要加载整个文档和构造树形结构，然后才可以检索和更新节点信息。

由于DOM在内存中以树形结构存放，因此检索和更新效率会更高。但是对于特别大的文档，解析和加载整个文档将会很耗资源。

PULL解析器：

PULL解析器的运行方式和SAX类似，都是基于事件的模式。不同的是，在PULL解析过程中，我们需要自己获取产生的事件然后做相应的操作，而不像SAX那样由处理器触发一种事件的方法，执行我们的代码。PULL解析器小巧轻便，解析速度快，简单易用，非常适合在Android移动设备中使用，Android系统内部在解析各种XML时也是用PULL解析器。

以上三种解析器，都是非常实用的解析器，我将会一一介绍。我们将会使用这三种解析技术完成一项共同的任务。

我们新建一个项目，项目结构如下：

 

 

我会在项目的assets目录中放置一个XML文档books.xml，内容如下：

1. <?xml version="1.0" encoding="utf-8"?>  
2. <books>  
3.     <book>  
4.         <id>1001</id>  
5.         <name>Thinking In Java</name>  
6.         <price>80.00</price>  
7.     </book>  
8.     <book>  
9.         <id>1002</id>  
10.         <name>Core Java</name>  
11.         <price>90.00</price>  
12.     </book>  
13.     <book>  
14.         <id>1003</id>  
15.         <name>Hello, Andriod</name>  
16.         <price>100.00</price>  
17.     </book>  
18. </books>  

然后我们分别使用以上三种解析技术解析文档，得到一个List<Book>的对象，先来看一下Book.java的代码：

1. package com.scott.xml.model;  
2. public class Book {  
3.     private int id;  
4.     private String name;  
5.     private float price;  
6.     public int getId() {  
7.         return id;  
8.     public void setId(int id) {  
9.         this.id = id;  
10.     public String getName() {  
11.         return name;  
12.     public void setName(String name) {  
13.         this.name = name;  
14.     public float getPrice() {  
15.         return price;  
16.     public void setPrice(float price) {  
17.         this.price = price;  
18.     @Override  
19.     public String toString() {  
20.         return "id:" + id + ", name:" + name + ", price:" + price;  

最后，我们还要把这个集合对象中的数据生成一个新的XML文档，如图：

 

 

生成的XML结构跟原始文档略有不同，是下面这种格式：

1. <?xml version="1.0" encoding="UTF-8"?>  
2. <books>  
3.   <book id="1001">  
4.     <name>Thinking In Java</name>  
5.     <price>80.0</price>  
6.   </book>  
7.   <book id="1002">  
8.     <name>Core Java</name>  
9.     <price>90.0</price>  
10.   </book>  
11.   <book id="1003">  
12.     <name>Hello, Andriod</name>  
13.     <price>100.0</price>  
14.   </book>  
15. </books>  

接下来，就该介绍操作过程了，我们先为解析器定义一个BookParser接口，每种类型的解析器需要实现此接口。BookParser.java代码如下：

1. package com.scott.xml.parser;  
2. import java.io.InputStream;  
3. import java.util.List;  
4. import com.scott.xml.model.Book;  
5. public interface BookParser {  
6.      * 解析输入流 得到Book对象集合 
7.      * @param is 
8.      * @return 
9.      * @throws Exception 
10.     public List<Book> parse(InputStream is) throws Exception;  
11.      * 序列化Book对象集合 得到XML形式的字符串 
12.      * @param books 
13.      * @return 
14.      * @throws Exception 
15.     public String serialize(List<Book> books) throws Exception;  

好了，我们就该一个一个的实现该接口，完成我们的解析过程。

使用SAX解析器：

SaxBookParser.java代码如下：

1. package com.scott.xml.parser;  
2. import java.io.InputStream;  
3. import java.io.StringWriter;  
4. import java.util.ArrayList;  
5. import java.util.List;  
6. import javax.xml.parsers.SAXParser;  
7. import javax.xml.parsers.SAXParserFactory;  
8. import javax.xml.transform.OutputKeys;  
9. import javax.xml.transform.Result;  
10. import javax.xml.transform.Transformer;  
11. import javax.xml.transform.TransformerFactory;  
12. import javax.xml.transform.sax.SAXTransformerFactory;  
13. import javax.xml.transform.sax.TransformerHandler;  
14. import javax.xml.transform.stream.StreamResult;  
15. import org.xml.sax.Attributes;  
16. import org.xml.sax.SAXException;  
17. import org.xml.sax.helpers.AttributesImpl;  
18. import org.xml.sax.helpers.DefaultHandler;  
19. import com.scott.xml.model.Book;  
20. public class SaxBookParser implements BookParser {  
21.     @Override  
22.     public List<Book> parse(InputStream is) throws Exception {  
23.         SAXParserFactory factory = SAXParserFactory.newInstance();  //取得SAXParserFactory实例  
24.         SAXParser parser = factory.newSAXParser();                  //从factory获取SAXParser实例  
25.         MyHandler handler = new MyHandler();                        //实例化自定义Handler  
26.         parser.parse(is, handler);                                  //根据自定义Handler规则解析输入流  
27.         return handler.getBooks();  
28.     @Override  
29.     public String serialize(List<Book> books) throws Exception {  
30.         SAXTransformerFactory factory = (SAXTransformerFactory) TransformerFactory.newInstance();//取得SAXTransformerFactory实例  
31.         TransformerHandler handler = factory.newTransformerHandler();           //从factory获取TransformerHandler实例  
32.         Transformer transformer = handler.getTransformer();                     //从handler获取Transformer实例  
33.         transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8");            // 设置输出采用的编码方式  
34.         transformer.setOutputProperty(OutputKeys.INDENT, "yes");                // 是否自动添加额外的空白  
35.         transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "no");   // 是否忽略XML声明  
36.         StringWriter writer = new StringWriter();  
37.         Result result = new StreamResult(writer);  
38.         handler.setResult(result);  
39.         String uri = "";    //代表命名空间的URI 当URI无值时 须置为空字符串  
40.         String localName = "";  //命名空间的本地名称(不包含前缀) 当没有进行命名空间处理时 须置为空字符串  
41.         handler.startDocument();  
42.         handler.startElement(uri, localName, "books", null);  
43.         AttributesImpl attrs = new AttributesImpl();    //负责存放元素的属性信息  
44.         char[] ch = null;  
45.         for (Book book : books) {  
46.             attrs.clear();  //清空属性列表  
47.             attrs.addAttribute(uri, localName, "id", "string", String.valueOf(book.getId()));//添加一个名为id的属性(type影响不大,这里设为string)  
48.             handler.startElement(uri, localName, "book", attrs);    //开始一个book元素 关联上面设定的id属性  
49.             handler.startElement(uri, localName, "name", null); //开始一个name元素 没有属性  
50.             ch = String.valueOf(book.getName()).toCharArray();  
51.             handler.characters(ch, 0, ch.length);   //设置name元素的文本节点  
52.             handler.endElement(uri, localName, "name");  
53.             handler.startElement(uri, localName, "price", null);//开始一个price元素 没有属性  
54.             ch = String.valueOf(book.getPrice()).toCharArray();  
55.             handler.characters(ch, 0, ch.length);   //设置price元素的文本节点  
56.             handler.endElement(uri, localName, "price");  
57.             handler.endElement(uri, localName, "book");  
58.         handler.endElement(uri, localName, "books");  
59.         handler.endDocument();  
60.         return writer.toString();  
61.     //需要重写DefaultHandler的方法  
62.     private class MyHandler extends DefaultHandler {  
63.         private List<Book> books;  
64.         private Book book;  
65.         private StringBuilder builder;  
66.         //返回解析后得到的Book对象集合  
67.         public List<Book> getBooks() {  
68.             return books;  
69.         @Override  
70.         public void startDocument() throws SAXException {  
71.             super.startDocument();  
72.             books = new ArrayList<Book>();  
73.             builder = new StringBuilder();  
74.         @Override  
75.         public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {  
76.             super.startElement(uri, localName, qName, attributes);  
77.             if (localName.equals("book")) {  
78.                 book = new Book();  
79.             builder.setLength(0);   //将字符长度设置为0 以便重新开始读取元素内的字符节点  
80.         @Override  
81.         public void characters(char[] ch, int start, int length) throws SAXException {  
82.             super.characters(ch, start, length);  
83.             builder.append(ch, start, length);  //将读取的字符数组追加到builder中  
84.         @Override  
85.         public void endElement(String uri, String localName, String qName) throws SAXException {  
86.             super.endElement(uri, localName, qName);  
87.             if (localName.equals("id")) {  
88.                 book.setId(Integer.parseInt(builder.toString()));  
89.             } else if (localName.equals("name")) {  
90.                 book.setName(builder.toString());  
91.             } else if (localName.equals("price")) {  
92.                 book.setPrice(Float.parseFloat(builder.toString()));  
93.             } else if (localName.equals("book")) {  
94.                 books.add(book);  

代码中，我们定义了自己的事件处理逻辑，重写了DefaultHandler的几个重要的事件方法。下面我为大家着重介绍一下DefaultHandler的相关知识。DefaultHandler是一个事件处理器，可以接收解析器报告的所有事件，处理所发现的数据。它实现了EntityResolver接口、DTDHandler接口、ErrorHandler接口和ContentHandler接口。这几个接口代表不同类型的事件处理器。我们着重介绍一下ContentHandler接口。结构如图：

 

 

这几个比较重要的方法已被我用红线标注，DefaultHandler实现了这些方法，但在方法体内没有做任何事情，因此我们在使用时必须覆写相关的方法。最重要的是startElement方法、characters方法和endElement方法。当执行文档时遇到起始节点，startElement方法将会被调用，我们可以获取起始节点相关信息；然后characters方法被调用，我们可以获取节点内的文本信息；最后endElement方法被调用，我们可以做收尾的相关操作。

最后，我们需要调用SAX解析程序，这个步骤在MainActivity中完成：

1. package com.scott.xml;  
2. import java.io.FileOutputStream;  
3. import java.io.InputStream;  
4. import java.util.List;  
5. import android.app.Activity;  
6. import android.content.Context;  
7. import android.os.Bundle;  
8. import android.util.Log;  
9. import android.view.View;  
10. import android.widget.Button;  
11. import com.scott.xml.model.Book;  
12. import com.scott.xml.parser.BookParser;  
13. import com.scott.xml.parser.SaxBookParser;  
14. public class MainActivity extends Activity {  
15.     private static final String TAG = "XML";  
16.     private BookParser parser;  
17.     private List<Book> books;  
18.     @Override  
19.     public void onCreate(Bundle savedInstanceState) {  
20.         super.onCreate(savedInstanceState);  
21.         setContentView(R.layout.main);  
22.         Button readBtn = (Button) findViewById(R.id.readBtn);  
23.         Button writeBtn = (Button) findViewById(R.id.writeBtn);  
24.         readBtn.setOnClickListener(new View.OnClickListener() {  
25.             @Override  
26.             public void onClick(View v) {  
27.                     InputStream is = getAssets().open("books.xml");  
28.                     parser = new SaxBookParser();  //创建SaxBookParser实例  
29.                     books = parser.parse(is);  //解析输入流  
30.                     for (Book book : books) {  
31.                         Log.i(TAG, book.toString());  
32.                 } catch (Exception e) {  
33.                     Log.e(TAG, e.getMessage());  
34.         writeBtn.setOnClickListener(new View.OnClickListener() {  
35.             @Override  
36.             public void onClick(View v) {  
37.                     String xml = parser.serialize(books);  //序列化  
38.                     FileOutputStream fos = openFileOutput("books.xml", Context.MODE_PRIVATE);  
39.                     fos.write(xml.getBytes("UTF-8"));  
40.                 } catch (Exception e) {  
41.                     Log.e(TAG, e.getMessage());  

界面就两个按钮，顺便给大家贴上：

 

 

点击“readXML”按钮，将会调用SAX解析器解析文档，并在日志台打印相关信息：

然后再点击“writeXML”按钮，将会在该应用包下的files目录生成一个books.xml文件：

 

 

使用DOM解析器：

DomBookParser.java代码如下：

1. package com.scott.xml.parser;  
2. import java.io.InputStream;  
3. import java.io.StringWriter;  
4. import java.util.ArrayList;  
5. import java.util.List;  
6. import javax.xml.parsers.DocumentBuilder;  
7. import javax.xml.parsers.DocumentBuilderFactory;  
8. import javax.xml.transform.OutputKeys;  
9. import javax.xml.transform.Result;  
10. import javax.xml.transform.Source;  
11. import javax.xml.transform.Transformer;  
12. import javax.xml.transform.TransformerFactory;  
13. import javax.xml.transform.dom.DOMSource;  
14. import javax.xml.transform.stream.StreamResult;  
15. import org.w3c.dom.Document;  
16. import org.w3c.dom.Element;  
17. import org.w3c.dom.Node;  
18. import org.w3c.dom.NodeList;  
19. import com.scott.xml.model.Book;  
20. public class DomBookParser implements BookParser {  
21.     @Override  
22.     public List<Book> parse(InputStream is) throws Exception {  
23.         List<Book> books = new ArrayList<Book>();  
24.         DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();  //取得DocumentBuilderFactory实例  
25.         DocumentBuilder builder = factory.newDocumentBuilder(); //从factory获取DocumentBuilder实例  
26.         Document doc = builder.parse(is);   //解析输入流 得到Document实例  
27.         Element rootElement = doc.getDocumentElement();  
28.         NodeList items = rootElement.getElementsByTagName("book");  
29.         for (int i = 0; i < items.getLength(); i++) {  
30.             Book book = new Book();  
31.             Node item = items.item(i);  
32.             NodeList properties = item.getChildNodes();  
33.             for (int j = 0; j < properties.getLength(); j++) {  
34.                 Node property = properties.item(j);  
35.                 String nodeName = property.getNodeName();  
36.                 if (nodeName.equals("id")) {  
37.                     book.setId(Integer.parseInt(property.getFirstChild().getNodeValue()));  
38.                 } else if (nodeName.equals("name")) {  
39.                     book.setName(property.getFirstChild().getNodeValue());  
40.                 } else if (nodeName.equals("price")) {  
41.                     book.setPrice(Float.parseFloat(property.getFirstChild().getNodeValue()));  
42.             books.add(book);  
43.         return books;  
44.     @Override  
45.     public String serialize(List<Book> books) throws Exception {  
46.         DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();  
47.         DocumentBuilder builder = factory.newDocumentBuilder();  
48.         Document doc = builder.newDocument();   //由builder创建新文档  
49.         Element rootElement = doc.createElement("books");  
50.         for (Book book : books) {  
51.             Element bookElement = doc.createElement("book");  
52.             bookElement.setAttribute("id", book.getId() + "");  
53.             Element nameElement = doc.createElement("name");  
54.             nameElement.setTextContent(book.getName());  
55.             bookElement.appendChild(nameElement);  
56.             Element priceElement = doc.createElement("price");  
57.             priceElement.setTextContent(book.getPrice() + "");  
58.             bookElement.appendChild(priceElement);  
59.             rootElement.appendChild(bookElement);  
60.         doc.appendChild(rootElement);  
61.         TransformerFactory transFactory = TransformerFactory.newInstance();//取得TransformerFactory实例  
62.         Transformer transformer = transFactory.newTransformer();    //从transFactory获取Transformer实例  
63.         transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8");            // 设置输出采用的编码方式  
64.         transformer.setOutputProperty(OutputKeys.INDENT, "yes");                // 是否自动添加额外的空白  
65.         transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "no");   // 是否忽略XML声明  
66.         StringWriter writer = new StringWriter();  
67.         Source source = new DOMSource(doc); //表明文档来源是doc  
68.         Result result = new StreamResult(writer);//表明目标结果为writer  
69.         transformer.transform(source, result);  //开始转换  
70.         return writer.toString();  

然后再MainActivity中只需改一个地方：

1.      readBtn.setOnClickListener(new View.OnClickListener() {  
2. @Override  
3. public void onClick(View v) {  
4.         InputStream is = getAssets().open("books.xml");  
5.  //             parser = new SaxBookParser();  
6.         parser = new DomBookParser();  
7.         books = parser.parse(is);  
8.         for (Book book : books) {  
9.             Log.i(TAG, book.toString());  
10.     } catch (Exception e) {  
11.         Log.e(TAG, e.getMessage());  

执行结果是一样的。

使用PULL解析器：

PullBookParser.java代码如下：

1. package com.scott.xml.parser;  
2. import java.io.InputStream;  
3. import java.io.StringWriter;  
4. import java.util.ArrayList;  
5. import java.util.List;  
6. import org.xmlpull.v1.XmlPullParser;  
7. import org.xmlpull.v1.XmlSerializer;  
8. import android.util.Xml;  
9. import com.scott.xml.model.Book;  
10. public class PullBookParser implements BookParser {  
11.     @Override  
12.     public List<Book> parse(InputStream is) throws Exception {  
13.         List<Book> books = null;  
14.         Book book = null;  
15. //      XmlPullParserFactory factory = XmlPullParserFactory.newInstance();  
16. //      XmlPullParser parser = factory.newPullParser();  
17.         XmlPullParser parser = Xml.newPullParser(); //由android.util.Xml创建一个XmlPullParser实例  
18.         parser.setInput(is, "UTF-8");               //设置输入流 并指明编码方式  
19.         int eventType = parser.getEventType();  
20.         while (eventType != XmlPullParser.END_DOCUMENT) {  
21.             switch (eventType) {  
22.             case XmlPullParser.START_DOCUMENT:  
23.                 books = new ArrayList<Book>();  
24.                 break;  
25.             case XmlPullParser.START_TAG:  
26.                 if (parser.getName().equals("book")) {  
27.                     book = new Book();  
28.                 } else if (parser.getName().equals("id")) {  
29.                     eventType = parser.next();  
30.                     book.setId(Integer.parseInt(parser.getText()));  
31.                 } else if (parser.getName().equals("name")) {  
32.                     eventType = parser.next();  
33.                     book.setName(parser.getText());  
34.                 } else if (parser.getName().equals("price")) {  
35.                     eventType = parser.next();  
36.                     book.setPrice(Float.parseFloat(parser.getText()));  
37.                 break;  
38.             case XmlPullParser.END_TAG:  
39.                 if (parser.getName().equals("book")) {  
40.                     books.add(book);  
41.                     book = null;      
42.                 break;  
43.             eventType = parser.next();  
44.         return books;  
45.     @Override  
46.     public String serialize(List<Book> books) throws Exception {  
47. //      XmlPullParserFactory factory = XmlPullParserFactory.newInstance();  
48. //      XmlSerializer serializer = factory.newSerializer();  
49.         XmlSerializer serializer = Xml.newSerializer(); //由android.util.Xml创建一个XmlSerializer实例  
50.         StringWriter writer = new StringWriter();  
51.         serializer.setOutput(writer);   //设置输出方向为writer  
52.         serializer.startDocument("UTF-8", true);  
53.         serializer.startTag("", "books");  
54.         for (Book book : books) {  
55.             serializer.startTag("", "book");  
56.             serializer.attribute("", "id", book.getId() + "");  
57.             serializer.startTag("", "name");  
58.             serializer.text(book.getName());  
59.             serializer.endTag("", "name");  
60.             serializer.startTag("", "price");  
61.             serializer.text(book.getPrice() + "");  
62.             serializer.endTag("", "price");  
63.             serializer.endTag("", "book");  
64.         serializer.endTag("", "books");  
65.         serializer.endDocument();  
66.         return writer.toString();  

然后再对MainActivity做以下更改：

1.         readBtn.setOnClickListener(new View.OnClickListener() {  
2.             @Override  
3.             public void onClick(View v) {  
4.                     InputStream is = getAssets().open("books.xml");  
5. //                  parser = new SaxBookParser();  
6. //                  parser = new DomBookParser();  
7.                     parser = new PullBookParser();  
8.                     books = parser.parse(is);  
9.                     for (Book book : books) {  
10.                         Log.i(TAG, book.toString());  
11.                 } catch (Exception e) {  
12.                     Log.e(TAG, e.getMessage());  

和其他两个执行结果都一样。

对于这三种解析器各有优点，我个人比较倾向于PULL解析器，因为SAX解析器操作起来太笨重，DOM不适合文档较大，内存较小的场景，唯有PULL轻巧灵活，速度快，占用内存小，使用非常顺手。读者也可以根据自己的喜好选择相应的解析技术。