SAX(Simple API for XML) 是一个解析速度快并且占用内存少的xml解析器,非常适合用于Android等移动设备。 SAX解析XML文件采用的是事件驱动, 顺序读取XML文件,边加载边解析。也就是说,它并不需要解析完整个文档,在按内容顺序解析文档的过程中,SAX会判断当前读到的字符是否合法XML语法中的某部分,如果符合就会触发事件。(如:当遇到像文件开头,文档结束,或者标签开头与标签结束时,会触发一个事件,用户通过在其回调事件中写入处理代码来处理XML文件,适合对XML的顺序访问,且是只读的.)所谓事件,其实就是一些回调(callback)方法,这些方法(事件)定义在ContentHandler接口。在SAX接口中,事件源是org.xml.sax包总的XMLReader,它通过parser()方法来解析XML文档,并产生事件。事件处理器是org.xml.sax包中的ContentHandler,DTDHandler,ErrorHandler,以及EntityResolver这4个接口。它们分别处理事件源在解析XML文档过程中产生的不同种类的事件。
定义的事件处理类在实现该接口时,必须实现4个接口中的所有方法。在开发中不必直接从这4个接口直接继承,因为org.xml.sax.helper包提供了类DefaultHandler,其继承了这4个接口,在实际开发中直接从DefaultHandler继承并实现相关函数就可以了并调用相应的监听器设置方法(setXXXX()来完成与XMLReader事件源的连接),为了减少工作量,SDK提供了DefaultHandler类(适配器类)来做事件处理,主要的事件的回调方法如下:
方法 | 含义 |
---|---|
setDocumentLocator(Locator locator) | 设置一个可以定位文档位置的对象 |
startDocument() | 用于处理文档解析开始事件 |
startElement(String uri,String localName,String qName,Attrubutes) | 处理元素开始事件,从参数中可以获取元素所在的RUL,元素名称,属性列表等信息 |
charachters(char[] ch,int start,int length) | 处理元素的字符内容,从参数中可以获得内容 |
endElement(String uri,String localName,String qName) | 处理元素结束事件,参数中可以获得元素所在URL,元素名称等 |
endDocument() | 用于处理文档解析的结束事件 |
各方法详细说明:
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)就可以获取内容。
通过XMLReader及DefaultHandler的配合来解析XML,基本思路如下:
创建SAXParserFactory对象:SAXParserFactory factory = SAXParserFactory.newInstance();
创建SAX解析器 :SAXParser parser = factory.newSAXParser();
实例化一个DefaultHandler对象
将XML解析处理器(DefaultHandler对象)分配给解析器
对文档进行解析,将每个事件发送给处理器,parser.parse(file, contentHandler);
通过DefaultHandler返回需要的数据集合
具体代码如下:
domain:
package cn.itcast.domain; public class Person { private Integer id; private String name; private Short age; public Person(){} public Person(Integer id, String name, Short age) { this.id = id; 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; } @Override public String toString() { return "Person [age=" + age + ", id=" + id + ", name=" + name + "]"; } }
service:
package cn.itcast.service; import java.io.InputStream; import java.util.ArrayList; import java.util.List; import javax.xml.parsers.SAXParser; import javax.xml.parsers.SAXParserFactory; import org.xml.sax.Attributes; import org.xml.sax.SAXException; import org.xml.sax.helpers.DefaultHandler; import cn.itcast.domain.Person; /** * 采用SAX解析XML内容 */ public class SAXPersonService { public List<Person> getPersons(InputStream inStream) throws Throwable{ //得到一个Sax解析器工厂 SAXParserFactory factory = SAXParserFactory.newInstance(); //得到解析器 SAXParser parser = factory.newSAXParser(); //new出一个PersonParser对象出来。把这个对象传到下面语句中 PersonParser personParser = new PersonParser(); //对得到的输入流Sax进行解析,第一个参数是要进行解析的xml内容,第二个参数是给 SAX DefaultHandler使用(回调函数) parser.parse(inStream, personParser); inStream.close(); //返回得到的getPersons return personParser.getPersons(); } private final class PersonParser extends DefaultHandler{ //把解析到的数据都放到集合里面去 private List<Person> persons = null; //记录当前所解析到的元素节点名称 private String tag = null; private Person person = null; //提供一个getpersons方法,主要是为主程序使用 public List<Person> getPersons() { return persons; } @Override public void startDocument() throws SAXException { //初始化 persons = new ArrayList<Person>(); } @Override public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException { //判断是不是我们要解析的元素节点 if("person".equals(localName)){ person = new Person();//new出person对象,把要解析的内容传给person的Id属性 person.setId(new Integer(attributes.getValue(0))); } //存放节点名称到成员变量里面 tag = localName; } @Override public void characters(char[] ch, int start, int length) throws SAXException { //首先判断节点名称是否为空,然后在判断节点名称是否为name if(tag!=null){ String data = new String(ch, start, length);//获取文本节点的数据 if("name".equals(tag)){//判断节点名称是否为name person.setName(data);//把要解析的内容传给person的name属性 }else if("age".equals(tag)){//判断节点名称是否为age person.setAge(new Short(data)); } } } @Override public void endElement(String uri, String localName, String qName) throws SAXException { if("person".equals(localName)){//当跟末节点为person时 persons.add(person);//把person放到集合persons里面 person = null;//把当前person设为空 } //遇到结束元素就把记录设为空 tag = null; } } }
Activity或测试类:
public class PersonServiceTest extends AndroidTestCase { private static final String TAG = "PersonServiceTest"; public void testSAXGetPersons() throws Throwable{ //new出一个业务对象 SAXPersonService service = new SAXPersonService(); //通过类加载器加载要解析的文件 InputStream inStream = getClass().getClassLoader().getResourceAsStream("itcast.xml"); List<Person> persons = service.getPersons(inStream); for(Person person : persons){ Log.i(TAG, person.toString()); } } }
AndroidMainFest文件代码,这里主要是用到了单元测试,需要加几句代码:
<?xml version="1.0" encoding="utf-8"?> <manifest xmlns:android="http://schemas.android.com/apk/res/android" package="cn.itcast.xml" android:versionCode="1" android:versionName="1.0"> <application android:icon="@drawable/icon" android:label="@string/app_name"> <uses-library android:name="android.test.runner" /> <activity android:name=".MainActivity" android:label="@string/app_name"> <intent-filter> <action android:name="android.intent.action.MAIN" /> <category android:name="android.intent.category.LAUNCHER" /> </intent-filter> </activity> </application> <uses-sdk android:minSdkVersion="8" /> <instrumentation android:name="android.test.InstrumentationTestRunner" android:targetPackage="cn.itcast.xml" android:label="Tests for My App" /> </manifest>