Android中使用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)就可以獲取內容。

注意：一個標簽之間的字符比較多時，或者字符串中包含有”\n”等特殊字符時，就會出現字符丟失的現象。遇到這種問題不要懷疑SAX不能解析標簽中含有”\n”或字符比較多的XML。實際上是我們寫的Handler是有問題的。SAX在解析XML時，當遇到一個標簽中的內容比較多時，就會多次調用characters。所以我們在寫Handler時要考慮到這種情況。就不會丟字符了。以下是一種解決方案：新建一個臨時變量temp，在調用characters方法中用temp接收數據，在endElement方法中把臨時變量temp賦值給目標變量，並給臨時變量temp清空，避免出現髒數據，這樣就可以解決sax讀取XML時不能讀取換行符號後面的內容的問題。

ljq.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>

實體類
代碼如下：

package com.ljq.entity;

import java.io.Serializable;

/**
 * 實體類
 *
 * @author jiqinlin
 *
 */
@SuppressWarnings("serial")
public class Person implements Serializable{
    private Integer id;
    private String name;
    private Short age;

    public Person() {
    }

    public Person(String name, Short age) {
        super();
        this.name = name;
        this.age = 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;
    }

}

handle類
代碼如下：

package com.ljq.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.ljq.entity.Person;

public class XMLContentHandler extends DefaultHandler {
    //臨時變量，解決sax讀取XML時不能讀取換行符號後面的內容的問題；注意temp=""不能寫成temp或temp=null，避免髒數據
    private String temp="";
    private String preTag;
    private Person person;
    private List<Person> persons;

    @Override
    public void startDocument() throws SAXException {
        persons = new ArrayList<Person>();
    }

    @Override
    public void characters(char[] ch, int start, int length) throws SAXException {
        if (person!=null){
            String date = new String(ch,start,length);
            if ("name".equals(preTag)) {
                temp+=date;
            }else if ("age".equals(preTag)) {
                temp+=date;
            }
        }
    }

    @Override
    public void startElement(String uri, String localName, String name, Attributes attributes) throws SAXException {
        if ("person".equals(localName)) {
            person= new Person();
            person.setId(attributes.getIndex("id"));
        }
        preTag = localName;
    }

    @Override
    public void endElement(String uri, String localName, String name) throws SAXException {
        if (person !=null && "name".equals(localName)) {
            person.setName(temp);
            temp="";
        }else if (person !=null && "age".equals(localName)) {
            person.setAge(new Short(temp));
            temp="";
        }else if (person !=null && "person".equals(localName)) {
            persons.add(person);
            person = null;
        }
        preTag = null;
    }

    //getter...
    public List<Person> getPersons() {
        return persons;
    }

}

代碼如下：

package com.ljq.service;

import java.io.InputStream;
import java.util.List;

import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory;

import com.ljq.entity.Person;

/**
 * sax解析工廠
 *
 * @author jiqinlin
 *
 */
public class SaxPersonService {
    // 業務層要對外拋出
    public static List<Person> readXML(InputStream inStream) throws Exception {
        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();
    }

}

測試類
代碼如下：

package com.ljq.test;

import java.io.InputStream;
import java.util.List;

import com.ljq.entity.Person;
import com.ljq.service.SaxPersonService;

import android.test.AndroidTestCase;
import android.util.Log;

public class SaxPersonServiceTest extends AndroidTestCase{
    private final String TAG = "SaxPersonServiceTest";
    public void testReadXML() throws Exception{
        //ljq.xml放在src目錄下
        InputStream inputStream = SaxPersonServiceTest.class.getClassLoader().getResourceAsStream("ljq.xml");
        List<Person> persons = SaxPersonService.readXML(inputStream);
        for(Person person : persons){
           Log.i(TAG, person.getId() + " : " + person.getName() + " : " + person.getAge());
        }
    }
}

運行結果

在android模擬器中，如果是中文字符會出現亂碼，在真機上就不會出現這種情況