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 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 |
<?xml version="1.0" encoding="utf-8"?> <books> <book> <id>1001</id> <name>Thinking In Java</name> <price>80.00</price> </book> <book> <id>1002</id> <name>Core Java</name> <price>90.00</price> </book> <book> <id>1003</id> <name>Hello, Andriod</name> <price>100.00</price> </book> </books> |
然後我們分別使用以上三種解析技術解析文件，得到一個List<Book>的物件，先來看一下Book.java的程式碼：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 |
package com.scott.xml.model; public class Book { private int id; private String name; private float price; public int getId() { return id; } public void setId(int id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public float getPrice() { return price; } public void setPrice(float price) { this.price = price; } @Override public String toString() { return "id:" + id + ", name:" + name + ", price:" + price; } } |
最後，我們還要把這個集合物件中的資料生成一個新的XML文件，如圖：
生成的XML結構跟原始文件略有不同，是下面這種格式：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
<?xml version="1.0" encoding="UTF-8"?> <books> <book id="1001"> <name>Thinking In Java</name> <price>80.0</price> </book> <book id="1002"> <name>Core Java</name> <price>90.0</price> </book> <book id="1003"> <name>Hello, Andriod</name> <price>100.0</price> </book> </books> |
接下來，就該介紹操作過程了，我們先為解析器定義一個BookParser介面，每種型別的解析器需要實現此介面。BookParser.java程式碼如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 |
package com.scott.xml.parser; import java.io.InputStream; import java.util.List; import com.scott.xml.model.Book; public interface BookParser { /** * 解析輸入流 得到Book物件集合 * @param is * @return * @throws Exception */ public List<Book> parse(InputStream is) throws Exception; /** * 序列化Book物件集合 得到XML形式的字串 * @param books * @return * @throws Exception */ public String serialize(List<Book> books) throws Exception; } |
好了，我們就該一個一個的實現該介面，完成我們的解析過程。
使用SAX解析器：
SaxBookParser.java程式碼如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 |
package com.scott.xml.parser; import java.io.InputStream; import java.io.StringWriter; import java.util.ArrayList; import java.util.List; import javax.xml.parsers.SAXParser; import javax.xml.parsers.SAXParserFactory; import javax.xml.transform.OutputKeys; import javax.xml.transform.Result; import javax.xml.transform.Transformer; import javax.xml.transform.TransformerFactory; import javax.xml.transform.sax.SAXTransformerFactory; import javax.xml.transform.sax.TransformerHandler; import javax.xml.transform.stream.StreamResult; import org.xml.sax.Attributes; import org.xml.sax.SAXException; import org.xml.sax.helpers.AttributesImpl; import org.xml.sax.helpers.DefaultHandler; import com.scott.xml.model.Book; public class SaxBookParser implements BookParser { @Override public List<Book> parse(InputStream is) throws Exception { SAXParserFactory factory = SAXParserFactory.newInstance(); //取得SAXParserFactory例項 SAXParser parser = factory.newSAXParser(); //從factory獲取SAXParser例項 MyHandler handler = new MyHandler(); //例項化自定義Handler parser.parse(is, handler); //根據自定義Handler規則解析輸入流 return handler.getBooks(); } @Override public String serialize(List<Book> books) throws Exception { SAXTransformerFactory factory = (SAXTransformerFactory) TransformerFactory.newInstance();//取得SAXTransformerFactory例項 TransformerHandler handler = factory.newTransformerHandler(); //從factory獲取TransformerHandler例項 Transformer transformer = handler.getTransformer(); //從handler獲取Transformer例項 transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8"); // 設定輸出採用的編碼方式 transformer.setOutputProperty(OutputKeys.INDENT, "yes"); // 是否自動新增額外的空白 transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "no"); // 是否忽略XML宣告 StringWriter writer = new StringWriter(); Result result = new StreamResult(writer); handler.setResult(result); String uri = ""; //代表名稱空間的URI 當URI無值時 須置為空字串 String localName = ""; //名稱空間的本地名稱(不包含字首) 當沒有進行名稱空間處理時 須置為空字串 handler.startDocument(); handler.startElement(uri, localName, "books", null); AttributesImpl attrs = new AttributesImpl(); //負責存放元素的屬性資訊 char[] ch = null; for (Book book : books) { attrs.clear(); //清空屬性列表 attrs.addAttribute(uri, localName, "id", "string", String.valueOf(book.getId()));//新增一個名為id的屬性(type影響不大,這裡設為string) handler.startElement(uri, localName, "book", attrs); //開始一個book元素 關聯上面設定的id屬性 handler.startElement(uri, localName, "name", null); //開始一個name元素 沒有屬性 ch = String.valueOf(book.getName()).toCharArray(); handler.characters(ch, 0, ch.length); //設定name元素的文字節點 handler.endElement(uri, localName, "name"); handler.startElement(uri, localName, "price", null);//開始一個price元素 沒有屬性 ch = String.valueOf(book.getPrice()).toCharArray(); handler.characters(ch, 0, ch.length); //設定price元素的文字節點 handler.endElement(uri, localName, "price"); handler.endElement(uri, localName, "book"); } handler.endElement(uri, localName, "books"); handler.endDocument(); return writer.toString(); } //需要重寫DefaultHandler的方法 private class MyHandler extends DefaultHandler { private List<Book> books; private Book book; private StringBuilder builder; //返回解析後得到的Book物件集合 public List<Book> getBooks() { return books; } @Override public void startDocument() throws SAXException { super.startDocument(); books = new ArrayList<Book>(); builder = new StringBuilder(); } @Override public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException { super.startElement(uri, localName, qName, attributes); if (localName.equals("book")) { book = new Book(); } builder.setLength(0); //將字元長度設定為0 以便重新開始讀取元素內的字元節點 } @Override public void characters(char[] ch, int start, int length) throws SAXException { super.characters(ch, start, length); builder.append(ch, start, length); //將讀取的字元陣列追加到builder中 } @Override public void endElement(String uri, String localName, String qName) throws SAXException { super.endElement(uri, localName, qName); if (localName.equals("id")) { book.setId(Integer.parseInt(builder.toString())); } else if (localName.equals("name")) { book.setName(builder.toString()); } else if (localName.equals("price")) { book.setPrice(Float.parseFloat(builder.toString())); } else if (localName.equals("book")) { books.add(book); } } } } |
程式碼中，我們定義了自己的事件處理邏輯，重寫了DefaultHandler的幾個重要的事件方法。下面我為大家著重介紹一下DefaultHandler的相關知識。DefaultHandler是一個事件處理器，可以接收解析器報告的所有事件，處理所發現的資料。它實現了EntityResolver介面、DTDHandler介面、ErrorHandler介面和ContentHandler介面。這幾個介面代表不同型別的事件處理器。我們著重介紹一下ContentHandler介面。結構如圖：
這幾個比較重要的方法已被我用紅線標註，DefaultHandler實現了這些方法，但在方法體內沒有做任何事情，因此我們在使用時必須覆寫相關的方法。最重要的是startElement方法、characters方法和endElement方法。當執行文件時遇到起始節點，startElement方法將會被呼叫，我們可以獲取起始節點相關資訊；然後characters方法被呼叫，我們可以獲取節點內的文字資訊；最後endElement方法被呼叫，我們可以做收尾的相關操作。
最後，我們需要呼叫SAX解析程式，這個步驟在MainActivity中完成：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 |
package com.scott.xml; import java.io.FileOutputStream; import java.io.InputStream; import java.util.List; import android.app.Activity; import android.content.Context; import android.os.Bundle; import android.util.Log; import android.view.View; import android.widget.Button; import com.scott.xml.model.Book; import com.scott.xml.parser.BookParser; import com.scott.xml.parser.SaxBookParser; public class MainActivity extends Activity { private static final String TAG = "XML"; private BookParser parser; private List<Book> books; @Override public void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.main); Button readBtn = (Button) findViewById(R.id.readBtn); Button writeBtn = (Button) findViewById(R.id.writeBtn); readBtn.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { try { InputStream is = getAssets().open("books.xml"); parser = new SaxBookParser(); //建立SaxBookParser例項 books = parser.parse(is); //解析輸入流 for (Book book : books) { Log.i(TAG, book.toString()); } } catch (Exception e) { Log.e(TAG, e.getMessage()); } } }); writeBtn.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { try { String xml = parser.serialize(books); //序列化 FileOutputStream fos = openFileOutput("books.xml", Context.MODE_PRIVATE); fos.write(xml.getBytes("UTF-8")); } catch (Exception e) { Log.e(TAG, e.getMessage()); } } }); } } |
介面就兩個按鈕，順便給大家貼上：
點選“readXML”按鈕，將會呼叫SAX解析器解析文件，並在日誌臺列印相關資訊：
然後再點選“writeXML”按鈕，將會在該應用包下的files目錄生成一個books.xml檔案：
使用DOM解析器：
DomBookParser.java程式碼如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 |
package com.scott.xml.parser; import java.io.InputStream; import java.io.StringWriter; import java.util.ArrayList; import java.util.List; import javax.xml.parsers.DocumentBuilder; import javax.xml.parsers.DocumentBuilderFactory; import javax.xml.transform.OutputKeys; import javax.xml.transform.Result; import javax.xml.transform.Source; import javax.xml.transform.Transformer; import javax.xml.transform.TransformerFactory; import javax.xml.transform.dom.DOMSource; import javax.xml.transform.stream.StreamResult; import org.w3c.dom.Document; import org.w3c.dom.Element; import org.w3c.dom.Node; import org.w3c.dom.NodeList; import com.scott.xml.model.Book; public class DomBookParser implements BookParser { @Override public List<Book> parse(InputStream is) throws Exception { List<Book> books = new ArrayList<Book>(); DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); //取得DocumentBuilderFactory例項 DocumentBuilder builder = factory.newDocumentBuilder(); //從factory獲取DocumentBuilder例項 Document doc = builder.parse(is); //解析輸入流 得到Document例項 Element rootElement = doc.getDocumentElement(); NodeList items = rootElement.getElementsByTagName("book"); for (int i = 0; i < items.getLength(); i++) { Book book = new Book(); Node item = items.item(i); NodeList properties = item.getChildNodes(); for (int j = 0; j < properties.getLength(); j++) { Node property = properties.item(j); String nodeName = property.getNodeName(); if (nodeName.equals("id")) { book.setId(Integer.parseInt(property.getFirstChild().getNodeValue())); } else if (nodeName.equals("name")) { book.setName(property.getFirstChild().getNodeValue()); } else if (nodeName.equals("price")) { book.setPrice(Float.parseFloat(property.getFirstChild().getNodeValue())); } } books.add(book); } return books; } @Override public String serialize(List<Book> books) throws Exception { DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance(); DocumentBuilder builder = factory.newDocumentBuilder(); Document doc = builder.newDocument(); //由builder建立新文件 Element rootElement = doc.createElement("books"); for (Book book : books) { Element bookElement = doc.createElement("book"); bookElement.setAttribute("id", book.getId() + ""); Element nameElement = doc.createElement("name"); nameElement.setTextContent(book.getName()); bookElement.appendChild(nameElement); Element priceElement = doc.createElement("price"); priceElement.setTextContent(book.getPrice() + ""); bookElement.appendChild(priceElement); rootElement.appendChild(bookElement); } doc.appendChild(rootElement); TransformerFactory transFactory = TransformerFactory.newInstance();//取得TransformerFactory例項 Transformer transformer = transFactory.newTransformer(); //從transFactory獲取Transformer例項 transformer.setOutputProperty(OutputKeys.ENCODING, "UTF-8"); // 設定輸出採用的編碼方式 transformer.setOutputProperty(OutputKeys.INDENT, "yes"); // 是否自動新增額外的空白 transformer.setOutputProperty(OutputKeys.OMIT_XML_DECLARATION, "no"); // 是否忽略XML宣告 StringWriter writer = new StringWriter(); Source source = new DOMSource(doc); //表明文件來源是doc Result result = new StreamResult(writer);//表明目標結果為writer transformer.transform(source, result); //開始轉換 return writer.toString(); } } |
然後再MainActivity中只需改一個地方：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 |
readBtn.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { try { InputStream is = getAssets().open("books.xml"); // parser = new SaxBookParser(); parser = new DomBookParser(); books = parser.parse(is); for (Book book : books) { Log.i(TAG, book.toString()); } } catch (Exception e) { Log.e(TAG, e.getMessage()); } } ); |
執行結果是一樣的。
使用PULL解析器：
PullBookParser.java程式碼如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 |
package com.scott.xml.parser; import java.io.InputStream; import java.io.StringWriter; import java.util.ArrayList; import java.util.List; import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlSerializer; import android.util.Xml; import com.scott.xml.model.Book; public class PullBookParser implements BookParser { @Override public List<Book> parse(InputStream is) throws Exception { List<Book> books = null; Book book = null; // XmlPullParserFactory factory = XmlPullParserFactory.newInstance(); // XmlPullParser parser = factory.newPullParser(); XmlPullParser parser = Xml.newPullParser(); //由android.util.Xml建立一個XmlPullParser例項 parser.setInput(is, "UTF-8"); //設定輸入流 並指明編碼方式 int eventType = parser.getEventType(); while (eventType != XmlPullParser.END_DOCUMENT) { switch (eventType) { case XmlPullParser.START_DOCUMENT: books = new ArrayList<Book>(); break; case XmlPullParser.START_TAG: if (parser.getName().equals("book")) { book = new Book(); } else if (parser.getName().equals("id")) { eventType = parser.next(); book.setId(Integer.parseInt(parser.getText())); } else if (parser.getName().equals("name")) { eventType = parser.next(); book.setName(parser.getText()); } else if (parser.getName().equals("price")) { eventType = parser.next(); book.setPrice(Float.parseFloat(parser.getText())); } break; case XmlPullParser.END_TAG: if (parser.getName().equals("book")) { books.add(book); book = null; } break; } eventType = parser.next(); } return books; } @Override public String serialize(List<Book> books) throws Exception { // XmlPullParserFactory factory = XmlPullParserFactory.newInstance(); // XmlSerializer serializer = factory.newSerializer(); XmlSerializer serializer = Xml.newSerializer(); //由android.util.Xml建立一個XmlSerializer例項 StringWriter writer = new StringWriter(); serializer.setOutput(writer); //設定輸出方向為writer serializer.startDocument("UTF-8", true); serializer.startTag("", "books"); for (Book book : books) { serializer.startTag("", "book"); serializer.attribute("", "id", book.getId() + ""); serializer.startTag("", "name"); serializer.text(book.getName()); serializer.endTag("", "name"); serializer.startTag("", "price"); serializer.text(book.getPrice() + ""); serializer.endTag("", "price"); serializer.endTag("", "book"); } serializer.endTag("", "books"); serializer.endDocument(); return writer.toString(); } } |
然後再對MainActivity做以下更改：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
readBtn.setOnClickListener(new View.OnClickListener() { @Override public void onClick(View v) { try { InputStream is = getAssets().open("books.xml"); // parser = new SaxBookParser(); // parser = new DomBookParser(); parser = new PullBookParser(); books = parser.parse(is); for (Book book : books) { Log.i(TAG, book.toString()); } } catch (Exception e) { Log.e(TAG, e.getMessage()); } } }); |
和其他兩個執行結果都一樣。
對於這三種解析器各有優點，我個人比較傾向於PULL解析器，因為SAX解析器操作起來太笨重，DOM不適合文件較大，記憶體較小的場景，唯有PULL輕巧靈活，速度快，佔用記憶體小，使用非常順手。讀者也可以根據自己的喜好選擇相應的解析技術。