Android SAX和DOM解析XML檔案

   使用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 {

// 解析的personObject Storage Service到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標籤結束的時候 把personObject Storage Service到集中

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的代碼在本頁下方備忘

 
有些時候，我們需要產生一個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;

}

}

}
}