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 name)这个方法和上面的方法相对应,在遇到结束标签的时候,调用这个方法。
- characters(char[] ch,int start,int length)这个方法用来处理在XML文件中读到的内容,第一个参数用于存放文件的内容,后面两个参数是读到的字符串在这个数组中的起始位置和长度,使用new String(ch,start,length)就可以获取内容。
只要为SAX提供实现ContentHandler接口的类,那么该类就可以得到通知事件(实际上就是SAX调用了该类中的回调方法)。因为ContentHandler是一个接口,在使用的时候可能会有些不方便,因此,SAX还为其制定了一个Helper类:DefaultHandler,它实现了这个接口,但是其所有的方法体都为空,在实现的时候,你只需要继承这个类,然后重载相应的方法即可。
下面是本例子要解析的XML文件,保存在assets文件夹中:
<?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内容:
package com.example.xmlsaxparse; public class PersonBean { private int id; private String name; private int age; 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 int getAge() { return age; } public void setAge(int age) { this.age = age; } }
package com.example.xmlsaxparse; import java.io.IOException; import java.io.InputStream; import java.util.List; import javax.xml.parsers.SAXParser; import javax.xml.parsers.SAXParserFactory; import android.app.Activity; import android.os.Bundle; import android.widget.TextView; public class MainActivity extends Activity { private List<PersonBean> persons; private TextView textView; private String notice = ""; private InputStream inStream; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); textView = (TextView) findViewById(R.id.test); try { inStream = this.getAssets().open("test.xml"); } catch (IOException e) { e.printStackTrace(); } persons = readXML(inStream); for (int i = 0; i < persons.size(); i++) { notice += persons.get(i).getName()+persons.get(i).getAge(); } textView.setText(notice); } public List<PersonBean> 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; } }
继承DefaultHandler类,覆写它的回调方法:
package com.example.xmlsaxparse; import java.util.ArrayList; import java.util.List; import org.xml.sax.Attributes; import org.xml.sax.SAXException; import org.xml.sax.helpers.DefaultHandler; public class XMLContentHandler extends DefaultHandler { private List<PersonBean> persons; private PersonBean currentPerson; private String tagName = ""; @Override public void startDocument() throws SAXException { persons = new ArrayList<PersonBean>(); super.startDocument(); } /* * 接收元素开始的通知。 * 参数意义如下: * namespaceURI:元素的命名空间 * localName :元素的本地名称(不带前缀) * qName :元素的限定名(带前缀) * atts :元素的属性集合 */ @Override public void startElement(String namespaceURI,Attributes atts) throws SAXException { if(localName.equals("person")){ currentPerson = new PersonBean(); currentPerson.setId(Integer.parseInt(atts.getValue("id"))); } this.tagName = localName; } /* * 接收字符数据的通知。 */ @Override public void characters(char[] ch,int length) throws SAXException { if(tagName!=null){ String data = new String(ch,length); if(tagName.equals("name")){ this.currentPerson.setName(data); }else if(tagName.equals("age")){ this.currentPerson.setAge(Short.parseShort(data)); } } } @Override public void endDocument() throws SAXException { super.endDocument(); } /* * 接收文档的结尾的通知。 * 参数意义如下: * uri :元素的命名空间 * localName :元素的本地名称(不带前缀) * name :元素的限定名(带前缀) * */ @Override public void endElement(String uri,String name) throws SAXException { if(localName.equals("person")){ persons.add(currentPerson); currentPerson = null; } this.tagName = null; } public List<PersonBean> getPersons(){ return persons; } }