Android--解析XML之SAX

提示：扫一扫查出行
【扫一扫了解最新限行尾号】
复制提示

前言

既然要说XML解析，那么先来聊聊什么是XML。XML，可扩展标记语言 (Extensible Markup Language) ，用于标记电子文件使其具有结构性的标记语言，可以用来标记数据、定义数据类型，是一种允许用户对自己的标记语言进行定义的源语言，这是百度百科的解释。而XML是一种在Internet中传输数据的常见格式，它与HTML一样，都是SGML（标准通用标记语言），无论你是需要通过Internet访问数据，或者发送数据给Web服务，都可能需要用到XML的知识。恰恰Android应用程序需要和网络交互，否则只是一款单机的无互动的应用程序，所以很可能在Android应用程序开发的过程中使用到XML。

由于XML的扩展性强，致使它需要有稳定的基础规则来支持扩展，该语法规则需要注意的是：

开始和结束标签匹配。
嵌套标签不能相互嵌套。
区分大小写。

Android中的XML

Android平台最大的优势在于，上层应用基本可以利用Java编程语言开发，Java平台支持通过许多不同的方式来使用XML，并且大多数与XML相关的API已经在Android系统上得到了完全的支持。但是因为Android这个移动设备的局限性，一般仅考虑使用三种方式解析XML：

DOM，Document Object Model，文档对象模型方式，解析完的XML将生成一个树状结构的对象。
SAX，simple API for Xml，以事件的形式通知程序，对XML进行解析。
XML PULL，类似于SAX方式，程序以拉取的方式对XML进行解析。

SAX

SAX是一种以事件驱动的XML API，由它定义的事件流可以指定从解析器传到专门的处理程序的代码的XML结构，简单来讲，它是解析速度快，占用内存少的接解析器，这种解析器比较适合Android等移动设备。

使用SAX的优点：

因为SAX的优势是流的方式处理，当遇到一个标签的时候，并不会记录下之前所碰到的标签。也就是说，在每个节点读取会触发的startElement()方法中，所能知道的信息，仅仅是当前的签名的名字和属性，至于标签嵌套的结构，上层标签的名字，是否有子元素与其他结构相关的信息，都是不知道的。

使用SAX解析XML的简单步骤：

新建一个类MyHandler，继承自DefaultHandler，并重写DefaultHandler中的特有方法，解析XML的工作在此类中完成。
实例化一个SAX解析器的工厂对象，SAXParserFactory对象，使用SAXParserFactory.newInstance()方法获取。
利用SAXParserFactory.newSAXParser()获得SAX解析器对象SAXParser。
实例化MyHandler类，传入需要解析的节点名称。
使用SAXParser.parse()方法设置待解析的XML流和XML解析对象。
最后从MyHandler对象中获得解析结果。

现在详细讲解一下上面提到的类的作用。

DefaultHandler类是SAX2事件处理程序的默认基类。它继承了EntityResolver、DTDHandler、ContentHandler和ErrorHandler这四个接口。包含这四个接口的所有方法，所以我们在编写事件处理程序时，可以不用直接实现这四个接口，而继承该类，然后重写我们需要的方法。

而在DefaultHandler中的继承类中，具体需要重写的方法有以下几个：

public void startDocument()：接受到一个XML文档时候的通知。
public void startElement(String uri, String localName, String qName,Attributes attributes)：接受到一个开始元素的通知，并且可以在此获得元素的属性。
public void characters(char[] ch, int start, int length)：接收元素中字符数据的通知。
public void endElement(String uri, String localName, String qName)：接收结束元素的通知。
public void endDocument()：接受一个文档的结束通知。

上面一些重写的方法通过一个XML文件来讲解一下什么时候被执行。

<?xml version="1.0" encoding="utf-8"?>               startDocument
<persons>                                                          startElement
<person id="23">                                               startElement
  <name nameid="1">                                          startElement
   Jack                                                                 characters
  </name>                                                           endElement
  <age>                                                               startElement
   21                                                                   characters
  </age>                                                             endElement
</person> endElement
</persons> endElement

SAXParserFactory类，定义了一个工厂API，使应用程序能够配置和获得基于SAX的解析器以解析XML文档。它只有一个prctected的构造方法（单例模式），所以需要使用静态的newInstance()方法来回的SAXParserFactory()对象。使用SAXParserFactory可以通过调用.newSAXParser()方法获得一个SAXParser，通过SAXParser对象可以执行parser()方法，通过传递的参数设定XML流和解析器类。

示例程序

现在通过一个示例程序来讲解一下SAX是怎么解析XML文件的，这个示例程序是运行在Android平台上的，为了模拟真实情况，在IIS服务器上放置了一个静态的XML文件，通过Android程序去读取XML文件中的内容，在这个示例程序中，读取person节点的值。因为是Android程序，所以别忘了赋予其访问网络的权限。

XML文件内容：

<?xml version="1.0" encoding="utf-8"?>
<persons>
<person id="23">
<name nameid="1">Jack</name>
<age>21</age>
</person>
<person id="20">
<name nameid="2">Dick</name>
<age>23</age>
</person>
</persons>

步骤一，DefaultHandler类的继承子类MyHandler：

package cn.bgxt.handler; import java.util.ArrayList;
import java.util.HashMap;
import java.util.List; import org.xml.sax.Attributes;
import org.xml.sax.SAXException;
import org.xml.sax.helpers.DefaultHandler; public class MyHandler extends DefaultHandler { private List<HashMap<String, String>> list = null; //解析后的XML内容
private HashMap<String, String> map = null; //存放当前需要记录的节点的XML内容
private String currentTag = null;//当前读取的XML节点
private String currentValue = null;//当前节点的XML文本值
private String nodeName = null;//需要解析的节点名称 public MyHandler(String nodeName) {
// 设置需要解析的节点名称
this.nodeName = nodeName;
} @Override
public void startDocument() throws SAXException {
// 接收文档开始的通知。
// 实例化ArrayList用于存放解析XML后的数据
list = new ArrayList<HashMap<String, String>>();
} @Override
public void startElement(String uri, String localName, String qName,
Attributes attributes) throws SAXException {
// 接收元素开始的通知。
if (qName.equals(nodeName)) {
//如果当前运行的节点名称与设定需要读取的节点名称相同，则实例化HashMap
map = new HashMap<String, String>();
}
//Attributes为当前节点的属性值，如果存在属性值，则属性值也读取。
if (attributes != null && map != null) {
for (int i = 0; i < attributes.getLength(); i++) {
//读取到的属性值，插入到Map中。
map.put(attributes.getQName(i), attributes.getValue(i));
}
}
//记录当前节点的名称。
currentTag = qName;
} @Override
public void characters(char[] ch, int start, int length)
throws SAXException {
// 接收元素中字符数据的通知。
//当前节点有值的情况下才继续执行
if (currentTag != null && map != null) {
//获取当前节点的文本值，ch这个直接数组就是存放的文本值。
currentValue = new String(ch, start, length);
if (currentValue != null && !currentValue.equals("")
&& !currentValue.equals("\n")) {
//读取的文本需要判断不能为null、不能等于”“、不能等于”\n“
map.put(currentTag, currentValue);
}
}
//读取完成后，需要清空当前节点的标签值和所包含的文本值。
currentTag = null;
currentValue = null;
} @Override
public void endElement(String uri, String localName, String qName)
throws SAXException {
// 接收元素结束的通知。
if (qName.equals(nodeName)) {
//如果读取的结合节点是我们需要关注的节点，则把map加入到list中保存
list.add(map);
//使用之后清空map，开始新一轮的读取person。
map = null;
}
} public List<HashMap<String, String>> getList() {
return list;
} }

因为XML文件是放在服务器上的，需要写一个HttpUitils类读取服务器上XML文件，使用的是URLHttpConnection的方式读取，如果不了解URLHttpConnection的朋友，可以看之前的博客：http://www.cnblogs.com/plokmju/p/java-HTTP.html。下面直接附上代码：

package cn.bgxt.http; import java.io.InputStream;
import java.net.HttpURLConnection;
import java.net.URL; public class HttpUtils { public HttpUtils() {
}
public static InputStream getXML(String path) {
try {
URL url=new URL(path);
if(url!=null)
{
HttpURLConnection connection=(HttpURLConnection)url.openConnection();
connection.setDoInput(true);
connection.setConnectTimeout(3000);
connection.setRequestMethod("GET");
int requesetCode=connection.getResponseCode();
if(requesetCode==200)
{
//如果执行成功，返回HTTP响应流
return connection.getInputStream();
}
}
} catch (Exception e) {
// TODO: handle exception
}
return null;
}
}

还需要一个调用SAXParser对象的类，这里新建一个SaxService类，实例化SAXParserFactory用于设定XML流和解析器。代码如下：

package cn.bgxt.service; import java.io.InputStream;
import java.util.HashMap;
import java.util.List; import javax.xml.parsers.SAXParser;
import javax.xml.parsers.SAXParserFactory; import cn.bgxt.handler.MyHandler; public class SaxService { public SaxService() {
// TODO Auto-generated constructor stub
} public static List<HashMap<String, String>> readXML(InputStream inputStream,String nodeName)
{
try {
//实例化SAX工厂类
SAXParserFactory factory=SAXParserFactory.newInstance();
//实例化SAX解析器。
SAXParser sParser=factory.newSAXParser();
//实例化DefaultHandler，设置需要解析的节点
MyHandler myHandler=new MyHandler(nodeName);
// 开始解析
sParser.parse(inputStream, myHandler);
// 解析完成之后，关闭流
inputStream.close();
//返回解析结果。
return myHandler.getList();
} catch (Exception e) {
// TODO: handle exception
}
return null;
} }

最后就是Android的一个Activity类了，布局界面很简单，只有一个按钮控件，这里不展示布局代码了。点击按钮后，触发点击事件，因为是Android4.0+，所以不能在主线程中访问网络，需要另起一个线程，这里使用Thread类。代码如下：

package cn.bgxt.androidxmlforsax; import java.io.InputStream;
import java.util.HashMap;
import java.util.List;
import cn.bgxt.http.HttpUtils;
import cn.bgxt.service.SaxService;
import android.os.Bundle;
import android.app.Activity;
import android.view.Menu;
import android.view.View;
import android.widget.Button; public class MainActivity extends Activity {
private Button btn;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_main); btn=(Button)findViewById(R.id.btn);
btn.setOnClickListener(new View.OnClickListener() { @Override
public void onClick(View v) {
//Android4.0+需要另起线程访问网络
Thread thread=new Thread(new Runnable() { @Override
public void run() {
// 设置XML文档的位置
String path="http://192.168.1.107:1231/persons.xml";
//读取服务器上的XML，获取XML流
InputStream inputStream=HttpUtils.getXML(path);
try {
//解析流，设定需要解析的节点
List<HashMap<String, String>> list=SaxService.readXML(inputStream, "person");
for(HashMap<String,String> map:list)
{
//打印到LogCat中
System.out.println(map.toString());
}
} catch (Exception e) {
// TODO: handle exception
}
}
});
thread.start();
}
});
} @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;
} }