XML解析之-SAX解析

在android开发中，我们经常使用SAX解析来解析xml数据，和DOM相比，它对大的优点就是节省内存。

SAX的原理 

SAX的工作原理简单地说就是对文档进行顺序扫描，当扫描到文档（document）开始与结束、元素（element）开始与结束、文档（document）结束等地方时通知事件处理函数，由事件处理函数做相应动作，然后继续同样的扫描，直至文档结束。大多数SAX实现都会产生以下类型的事件：
在文档内每一XML元素接受解析的前后触发元素事件。 
在文档的开始和结束时触发文档处理事件。 
在处理文档的DTD或Schema时产生DTD或Schema事件。 
任何元数据通常都由单独的事件交付。 
产生错误事件用来通知主机应用程序解析错误。 
对于如下文档：
<doc>
<para>Hello, world!</para>
</doc>

在解析文档的过程中会产生如下一系列事件：

start document
start element: doc
start element: para
characters: Hello, world!
end element: para
end element: doc
end document
一个完整的SAX处理过程涉及如下几个步骤：
（1）创建事件处理程序。 
（2）创建SAX解析器。
（4）对文档进行解析，将每个事件发送给处理程序。
（3）将事件处理程序分配给解析器。

SAX的优缺点 
SAX的优点： 
解析速度快 
ContentHandler对象可以是多个 
内存消耗少 
SAX的缺点： 
必须实现事件处理程序 
不能修改文档 
不能随机访问 

 

SAX解析器对文档的解析过程是一种边解析边执行的过程 ，SAX解析器对文档的解析过程中，无需把整个文档都加载到内存中，使用SAX解析器时，可以注册多个ContentHandler对象，并行接收事件，SAX解析器对文档的解析是顺序进行的，使用SAX对文档进行解析，只能访问文档内容，无法做到向文档中添加节点，更不能删除和修改文档中的内容。

SAX的常用接口介绍 
ContentHandler接口 
ContentHandler是Java类包中一个特殊的SAX接口，位于org.xml.sax包中。该接口封装了一些对事件处理的方法，当XML解析器开始解析XML输入文档时，它会遇到某些特殊的事件，比如文档的开头和结束、元素开头和结束、以及元素中的字符数据等事件。当遇到这些事件时，XML解析器会调用ContentHandler接口中相应的方法来响应该事件。 
ContentHandler接口的方法有以下几种： 
void startDocument() 
void characters(char[ ] ch, int start, int length) 
void endDocument()
void startElement(String uri, String localName, String qName, Attributes atts) 
void endElement(String uri, String localName, String qName) 
DTDHandler接口 
DTDHandler用于接收基本的DTD相关事件的通知。该接口位于org.xml.sax包中。此接口仅包括DTD事件的注释和未解析的实体声明部分。SAX解析器可按任何顺序报告这些事件，而不管声明注释和未解析实体时所采用的顺序；但是，必须在文档处理程序的startDocument()事件之后，在第一个startElement()事件之前报告所有的DTD事件。 
DTDHandler接口包括以下两个方法： 
void startDocumevoid notationDecl(String name, String publicId, String systemId) nt() 
void unparsedEntityDecl(String name, String publicId, String systemId, String notationName) 
接收注释声明事件的通知
接收未解析的实体声明事件的通知 
EntityResolver接口 
EntityResolver接口是用于解析实体的基本接口，该接口位于org.xml.sax包中。 
该接口只有一个方法，如下： 
public InputSource resolveEntity(String publicId, String systemId) 
允许应用程序解析外部实体。并返回一个InputSource类的对象或者为null，用于读取实体信息 
解析器将在打开任何外部实体前调用此方法。此类实体包括在DTD内引用的外部DTD子集和外部参数实体和在文档元素内引用的外部通用实体等。如果SAX应用程序需要实现自定义处理外部实体，则必须实现此接口。 
ErrorHandler接口 
ErrorHandler接口是SAX错误处理程序的基本接口。如果SAX应用程序需要实现自定义的错误处理，则它必须实现此接口，然后解析器将通过此接口报告所有的错误和警告。 
该接口的方法如下： 
void error(SAXParseException exception) 
void fatalError(SAXParseException exception) 
接收可恢复的错误通知 
接收不可恢复的错误通知 
void warning(SAXParseException exception) 
接收警告的通知

理论就介绍这里，下面动手写代码来实现一个简单的xml解析。

这里我们使用到android的单元测试来测试我们所写的SAX解析代码。

 

要使用android单元测试，必须在AndroidManifest.xml文件中进行一些配置：

在AndroidManifest.xml文件的application节点下假如以下代码：

<uses-library android:name="android.test.runner" />

 在manifest节点下加入以下代码：

 

 

 

 

 

 

 

 

 

<instrumentation android:name="android.test.InstrumentationTestRunner"
  android:targetPackage="weiyong.huang.xml" android:label="Tests for My App" />
  <!-- android:label标签名字随便我们取 -->

接下来就是编码了，我定义了3个类，一个是javabean类，一个是实现SAX解析的功能类，一个是用于测试的类和一个测试用的xml文件。

javabean类：Person.java

 

 

 

 

 

 

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 + "]";
	}
}

 SAX解析的功能类：SAXPersonService.java

 

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{
		SAXParserFactory factory = SAXParserFactory.newInstance();
		SAXParser parser = factory.newSAXParser();
		PersonParser personParser = new PersonParser();
		parser.parse(inStream, personParser);
		inStream.close();
		return personParser.getPersons();
	}

	private final class PersonParser extends DefaultHandler{
		private List<Person> persons = null;
		private String tag = null;//用来存放xml标签
		private Person person = null;

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

		//开始读文档，我们在此方法中可以完成一些必要的初始化工作
		@Override
		public void startDocument() throws SAXException {
			persons = new ArrayList<Person>();
		}
		
		/**
		 * @param uri 名称空间 URI，如果元素没有任何名称空间 URI，或者没有正在执行名称空间处理，则为空字符串。
		 * @param localName 本地名称（不带前缀），如果没有正在执行名称空间处理，则为空字符串。/
		 * @param qName 限定的名称（带有前缀），如果限定的名称不可用，则为空字符串。
		 * @param attributes 附加到元素的属性。如果没有属性，则它将是空的 Attributes 对象。 
		 * @throws SAXException
		 * @see org.xml.sax.helpers.DefaultHandler#startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes)
		 */
		@Override
		public void startElement(String uri, String localName, String qName, Attributes attributes) throws SAXException {
			if("person".equals(localName)){
				person = new Person();
				person.setId(new Integer(attributes.getValue(0)));
			}
			tag = localName;
		}
		
		@Override
		public void characters(char[] ch, int start, int length)
				throws SAXException {
			if(tag!=null){
				String data = new String(ch, start, length);//获取文本节点的数据
				if("name".equals(tag)){
					person.setName(data);
				}else if("age".equals(tag)){
					person.setAge(new Short(data));
				}
			}
		}

		@Override
		public void endElement(String uri, String localName, String qName)
				throws SAXException {
			if("person".equals(localName)){
				persons.add(person);
				person = null;
			}
			tag = null;//当读完一个元素的内容时，我们要把tag清空，以继续读下面的标签
		}
	}
}

 测试类：PersonServiceTest.java

这里需要注意一点，在android测试的时候，我们最好把测试类放在和android启动的Activity类的同包下。

 

import java.io.InputStream;
import java.io.StringWriter;
import java.util.ArrayList;
import java.util.List;
import cn.itcast.domain.Person;
import cn.itcast.service.DOMPersonService;
import cn.itcast.service.PULLPersonService;
import cn.itcast.service.SAXPersonService;
import android.test.AndroidTestCase;
import android.util.Log;

public class PersonServiceTest extends AndroidTestCase {
	private static final String TAG = "PersonServiceTest";

	public void testSAXGetPersons() throws Throwable{
		SAXPersonService service = new SAXPersonService();
		InputStream inStream = getClass().getClassLoader().getResourceAsStream("target.xml");
		List<Person> persons = service.getPersons(inStream);
		for(Person person : persons){
			Log.i(TAG, person.toString());    
		}
	}
}

 

测试用的xml文件： target.xml

<?xml version="1.0" encoding="UTF-8"?>
<persons>
	<person id="23">
		<name>liming</name>
		<age>30</age>
	</person>
	<person id="20">
		<name>lixiangmei</name>
		<age>25</age>
	</person>
</persons>

到此，我们完成了SAX解析的全部编码工作。

 

下面开始进行测试工作：对PersonServiceTest的testSAXGetPersons()方法进行单元测试，再在android的LogCat添加一个PersonServiceTest过滤器。我们可以在这个过滤器里面看到如下结果：

 

Person [age=30, id=23, name=liming]
Person [age=25, id=20, name=lixiangmei]

 由此，我们的SAX解析目标xml文件顺利完成，哈哈，是不是比较简单！！！