Android XML解析
在Android平臺上可以使用Simple API for XML(SAX) 、 Document Object Model(DOM)和Android附帶的pull解析器解析XML檔案。
下面是本例子要解析的XML檔案:
檔名稱:itcast.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;
}
}
使用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)就可以獲取內容。
解析itcast.xml觸發的事件為:
讀到的標籤及內容 觸發事件
{文件開始} startDocument()
<persons> startElement(, "persons", null, "{Attributes}")
"\n\t" characters("<persons>...</persons>", "12", "2")
<person> startElement(, "person", null, "{Attributes}")
"\n\t\t" characters("<persons>...</persons>", "31", "3")
<name> startElement(, "name", null, "{Attributes}")
"李明" characters("<persons>...</persons>", "40", "2")
</name> endElement("", "name", null)
"\n\t\t" characters("<persons>...</persons>", "50", "3")
<age> startElement(, "age", null, "{Attributes}")
"30" characters("<persons>...</persons>", "58", "2")
</age> endElement("", "age", null)
"\n\t" characters("<persons>...</persons>", "67", "2")
</person> endElement("", "person", null)
"\n\t" characters("<persons>...</persons>", "79", "2")
<person> startElement(, "person", null, "{Attributes}")
"\n\t\t" characters("<persons>...</persons>", "98", "3")
<name> startElement(, "name", null, "{Attributes}")
"李向梅" characters("<persons>...</persons>", "107", "3")
</name> endElement("", "name", null)
"\n\t\t" characters("<persons>...</persons>", "118", "3")
<age> startElement(, "age", null, "{Attributes}")
"25" characters("<persons>...</persons>", "126", "2")
</age> endElement("", "age", null)
"\n\t" characters("<persons>...</persons>", "135", "2")
</person> endElement("", "person", null)
"\n" characters("<persons>...</persons>", "147", "1")
</persons> endElement("", "persons", null)
{文件結束} endDocument()
只要為SAX提供實現ContentHandler介面的類,那麼該類就可以得到通知事件(實際上就是SAX呼叫了該類中的回撥方法)。因為ContentHandler是一個介面,在使用的時候可能會有些不方便,因此,SAX還為其制定了一個Helper類:DefaultHandler,它實現了這個介面,但是其所有的方法體都為空,在實現的時候,你只需要繼承這個類,然後過載相應的方法即可。使用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;
}
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 cn.itcast.xml.domain.Person;
public class XMLContentHandler extends DefaultHandler {
private List<Person> persons = null;
private Person currentPerson;
private String tagName = null;//當前解析的元素標籤
public List<Person> getPersons() {
return persons;
}
/*
* 接收文件的開始的通知。
*/
@Override public void startDocument() throws SAXException {
persons = new ArrayList<Person>();
}
/*
* 接收字元資料的通知。
*/
@Override public void characters(char[] ch, int start, int length) throws SAXException {
if(tagName!=null){
String data = new String(ch, start, length);
if(tagName.equals("name")){
this.currentPerson.setName(data);
}else if(tagName.equals("age")){
this.currentPerson.setAge(Short.parseShort(data));
}
}
}
/*
* 接收元素開始的通知。
* 引數意義如下:
* namespaceURI:元素的名稱空間
* localName :元素的本地名稱(不帶字首)
* qName :元素的限定名(帶字首)
* atts :元素的屬性集合
*/
@Override public void startElement(String namespaceURI, String localName, String qName, Attributes atts) throws SAXException {
if(localName.equals("person")){
currentPerson = new Person();
currentPerson.setId(Integer.parseInt(atts.getValue("id")));
}
this.tagName = localName;
}
/*
* 接收文件的結尾的通知。
* 引數意義如下:
* uri :元素的名稱空間
* localName :元素的本地名稱(不帶字首)
* name :元素的限定名(帶字首)
*
*/
@Override public void endElement(String uri, String localName, String name) throws SAXException {
if(localName.equals("person")){
persons.add(currentPerson);
currentPerson = null;
}
this.tagName = null;
}
}
使用DOM讀取XML檔案
除了可以使用 SAX解析XML檔案,大家也可以使用熟悉的DOM來解析XML檔案。 DOM解析XML檔案時,會將XML檔案的所有內容讀取到記憶體中,然後允許您使用DOM API遍歷XML樹、檢索所需的資料。使用DOM操作XML的程式碼看起來比較直觀,並且,在某些方面比基於SAX的實現更加簡單。但是,因為DOM需要將XML檔案的所有內容讀取到記憶體中,所以記憶體的消耗比較大,特別對於執行Android的移動裝置來說,因為裝置的資源比較寶貴,所以建議還是採用SAX來解析XML檔案,當然,如果XML檔案的內容比較小採用DOM是可行的。
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 cn.itcast.xml.domain.Person;
/**
* 使用Dom解析xml檔案
*
*/
public class DomXMLReader {
public static List<Person> readXML(InputStream inStream) {
List<Person> persons = new ArrayList<Person>();
DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
try {
DocumentBuilder builder = factory.newDocumentBuilder();
Document dom = builder.parse(inStream);
Element root = dom.getDocumentElement();
NodeList items = root.getElementsByTagName("person");//查詢所有person節點
for (int i = 0; i < items.getLength(); i++) {
Person person = new Person();
//得到第一個person節點
Element personNode = (Element) items.item(i);
//獲取person節點的id屬性值
person.setId(new Integer(personNode.getAttribute("id")));
//獲取person節點下的所有子節點(標籤之間的空白節點和name/age元素)
NodeList childsNodes = personNode.getChildNodes();
for (int j = 0; j < childsNodes.getLength(); j++) {
Node node = (Node) childsNodes.item(j); //判斷是否為元素型別
if(node.getNodeType() == Node.ELEMENT_NODE){ Element childNode = (Element) node;
//判斷是否name元素
if ("name".equals(childNode.getNodeName())) {
//獲取name元素下Text節點,然後從Text節點獲取資料
person.setName(childNode.getFirstChild().getNodeValue());
} else if (“age”.equals(childNode.getNodeName())) {
person.setAge(new Short(childNode.getFirstChild().getNodeValue()));
}
}
}
persons.add(person);
}
inStream.close();
} catch (Exception e) {
e.printStackTrace();
}
return persons;
}
使用Pull解析器讀取XML檔案
除了可以使用 SAX和DOM解析XML檔案,大家也可以使用Android內建的Pull解析器解析XML檔案。 Pull解析器的執行方式與 SAX 解析器相似。它提供了類似的事件,如:開始元素和結束元素事件,使用parser.next()可以進入下一個元素並觸發相應事件。事件將作為數值程式碼被髮送,因此可以使用一個switch對感興趣的事件進行處理。當元素開始解析時,呼叫parser.nextText()方法可以獲取下一個Text型別元素的值。
Pull解析器的原始碼及文件下載網址:http://www.xmlpull.org/
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;
}
}
使用Pull解析器生成XML檔案
有些時候,我們需要生成一個XML檔案,生成XML檔案的方法有很多,如:可以只使用一個StringBuilder組拼XML內容,然後把內容寫入到檔案中;或者使用DOM API生成XML檔案,或者也可以使用pull解析器生成XML檔案,這裡推薦大家使用Pull解析器。
使用Pull解析器生成一個與itcast.xml檔案內容相同的myitcast.xml檔案。
public static String writeXML(List<Person> persons, Writer writer){
XmlSerializer serializer = Xml.newSerializer();
try {
serializer.setOutput(writer);
serializer.startDocument("UTF-8", true);
//第一個引數為名稱空間,如果不使用名稱空間,可以設定為null
serializer.startTag("", "persons");
for (Person person : persons){
serializer.startTag("", "person");
serializer.attribute("", "id", person.getId().toString());
serializer.startTag("", "name");
serializer.text(person.getName());
serializer.endTag("", "name");
serializer.startTag("", "age");
serializer.text(person.getAge().toString());
serializer.endTag("", "age");
serializer.endTag("", "person");
}
serializer.endTag("", "persons");
serializer.endDocument();
return writer.toString();
} catch (Exception e) {
e.printStackTrace();
}
return null;
}
使用程式碼如下(生成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();
注:請開啟DDMS檢視讀取結果