Android--解析XML之SAX

前言

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

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

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

Android中的XML

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

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

SAX

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

  使用SAX的优点:

  因为SAX的优势是流的方式处理,当遇到一个标签的时候,并不会记录下之前所碰到的标签。也就是说,在每个节点读取会触发的startElement()方法中,所能知道的信息,仅仅是当前的签名的名字和属性,至于标签嵌套的结构,上层标签的名字,是否有子元素与其他结构相关的信息,都是不知道的。
  
  使用SAX解析XML的简单步骤:
  1. 新建一个类MyHandler,继承自DefaultHandler,并重写DefaultHandler中的特有方法,解析XML的工作在此类中完成。
  2. 实例化一个SAX解析器的工厂对象,SAXParserFactory对象,使用SAXParserFactory.newInstance()方法获取。
  3. 利用SAXParserFactory.newSAXParser()获得SAX解析器对象SAXParser。
  4. 实例化MyHandler类,传入需要解析的节点名称。
  5. 使用SAXParser.parse()方法设置待解析的XML流和XML解析对象。
  6. 最后从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文件内容:

 1 <?xml version="1.0" encoding="utf-8"?>
 2 <persons>
 3 <person id="23">
 4 <name nameid="1">Jack</name>
 5 <age>21</age>
 6 </person>
 7 <person id="20">
 8 <name nameid="2">Dick</name>
 9 <age>23</age>
10 </person>
11 </persons>

 

  步骤一,DefaultHandler类的继承子类MyHandler:

 1 package cn.bgxt.handler;
 2 
 3 import java.util.ArrayList;
 4 import java.util.HashMap;
 5 import java.util.List;
 6 
 7 import org.xml.sax.Attributes;
 8 import org.xml.sax.SAXException;
 9 import org.xml.sax.helpers.DefaultHandler;
10 
11 public class MyHandler extends DefaultHandler {
12 
13     private List<HashMap<String, String>> list = null; //解析后的XML内容
14     private HashMap<String, String> map = null;  //存放当前需要记录的节点的XML内容
15     private String currentTag = null;//当前读取的XML节点
16     private String currentValue = null;//当前节点的XML文本值
17     private String nodeName = null;//需要解析的节点名称
18 
19     public MyHandler(String nodeName) {
20         // 设置需要解析的节点名称
21         this.nodeName = nodeName;
22     }
23 
24     @Override
25     public void startDocument() throws SAXException {
26         // 接收文档开始的通知。
27         // 实例化ArrayList用于存放解析XML后的数据
28         list = new ArrayList<HashMap<String, String>>();
29     }
30 
31     @Override
32     public void startElement(String uri, String localName, String qName,
33             Attributes attributes) throws SAXException {
34         // 接收元素开始的通知。        
35         if (qName.equals(nodeName)) {
36             //如果当前运行的节点名称与设定需要读取的节点名称相同,则实例化HashMap
37             map = new HashMap<String, String>();
38         }
39         //Attributes为当前节点的属性值,如果存在属性值,则属性值也读取。
40         if (attributes != null && map != null) {
41             for (int i = 0; i < attributes.getLength(); i++) {
42                 //读取到的属性值,插入到Map中。
43                 map.put(attributes.getQName(i), attributes.getValue(i));
44             }
45         }
46         //记录当前节点的名称。
47         currentTag = qName;
48     }
49 
50     @Override
51     public void characters(char[] ch, int start, int length)
52             throws SAXException {
53         // 接收元素中字符数据的通知。
54         //当前节点有值的情况下才继续执行
55         if (currentTag != null && map != null) {
56             //获取当前节点的文本值,ch这个直接数组就是存放的文本值。
57             currentValue = new String(ch, start, length);
58             if (currentValue != null && !currentValue.equals("")
59                     && !currentValue.equals("\n")) {
60                 //读取的文本需要判断不能为null、不能等于”“、不能等于”\n“
61                 map.put(currentTag, currentValue);
62             }
63         }
64         //读取完成后,需要清空当前节点的标签值和所包含的文本值。
65         currentTag = null;
66         currentValue = null;
67     }
68 
69     @Override
70     public void endElement(String uri, String localName, String qName)
71             throws SAXException {
72         // 接收元素结束的通知。
73         if (qName.equals(nodeName)) {
74             //如果读取的结合节点是我们需要关注的节点,则把map加入到list中保存
75             list.add(map);
76             //使用之后清空map,开始新一轮的读取person。
77             map = null;
78         }
79     }
80 
81     public List<HashMap<String, String>> getList() {
82         return list;
83     }
84 
85 }

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

 1 package cn.bgxt.http;
 2 
 3 import java.io.InputStream;
 4 import java.net.HttpURLConnection;
 5 import java.net.URL;
 6 
 7 public class HttpUtils {
 8 
 9     public HttpUtils() {
10     }
11     public static InputStream getXML(String path) {
12         try {
13             URL url=new URL(path);
14             if(url!=null)
15             {
16                 HttpURLConnection connection=(HttpURLConnection)url.openConnection();
17                 connection.setDoInput(true);
18                 connection.setConnectTimeout(3000);
19                 connection.setRequestMethod("GET");
20                 int requesetCode=connection.getResponseCode();
21                 if(requesetCode==200)
22                 {
23                     //如果执行成功,返回HTTP响应流
24                     return connection.getInputStream();
25                 }
26             }
27         } catch (Exception e) {
28             // TODO: handle exception
29         }        
30         return null;
31     }
32 }

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

 1 package cn.bgxt.service;
 2 
 3 import java.io.InputStream;
 4 import java.util.HashMap;
 5 import java.util.List;
 6 
 7 import javax.xml.parsers.SAXParser;
 8 import javax.xml.parsers.SAXParserFactory;
 9 
10 import cn.bgxt.handler.MyHandler;
11 
12 public class SaxService {
13 
14     public SaxService() {
15         // TODO Auto-generated constructor stub
16     }
17     
18     public static List<HashMap<String, String>> readXML(InputStream inputStream,String nodeName)
19     {
20         try {
21             //实例化SAX工厂类
22             SAXParserFactory factory=SAXParserFactory.newInstance();
23             //实例化SAX解析器。
24             SAXParser sParser=factory.newSAXParser();
25             //实例化DefaultHandler,设置需要解析的节点
26             MyHandler myHandler=new MyHandler(nodeName);
27             // 开始解析
28             sParser.parse(inputStream, myHandler);
29             // 解析完成之后,关闭流
30             inputStream.close();
31             //返回解析结果。
32             return myHandler.getList();
33         } catch (Exception e) {
34             // TODO: handle exception
35         }        
36         return null;
37     }
38     
39 }

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

 1 package cn.bgxt.androidxmlforsax;
 2 
 3 import java.io.InputStream;
 4 import java.util.HashMap;
 5 import java.util.List;
 6 import cn.bgxt.http.HttpUtils;
 7 import cn.bgxt.service.SaxService;
 8 import android.os.Bundle;
 9 import android.app.Activity;
10 import android.view.Menu;
11 import android.view.View;
12 import android.widget.Button;
13 
14 public class MainActivity extends Activity {
15     private Button btn;
16     @Override
17     protected void onCreate(Bundle savedInstanceState) {
18         super.onCreate(savedInstanceState);
19         setContentView(R.layout.activity_main);
20         
21         btn=(Button)findViewById(R.id.btn);
22         btn.setOnClickListener(new View.OnClickListener() {
23             
24             @Override
25             public void onClick(View v) {
26                 //Android4.0+需要另起线程访问网络
27                 Thread thread=new Thread(new Runnable() {
28                     
29                     @Override
30                     public void run() {
31                         // 设置XML文档的位置
32                         String path="http://192.168.1.107:1231/persons.xml";
33                         //读取服务器上的XML,获取XML流
34                         InputStream inputStream=HttpUtils.getXML(path);
35                         try {
36                             //解析流,设定需要解析的节点
37                             List<HashMap<String, String>> list=SaxService.readXML(inputStream, "person");
38                             for(HashMap<String,String> map:list)
39                             {
40                                 //打印到LogCat中
41                                 System.out.println(map.toString());
42                             }
43                         } catch (Exception e) {
44                             // TODO: handle exception
45                         }
46                     }
47                 });
48                 thread.start();                
49             }
50         });        
51     }
52 
53     @Override
54     public boolean onCreateOptionsMenu(Menu menu) {
55         // Inflate the menu; this adds items to the action bar if it is present.
56         getMenuInflater().inflate(R.menu.main, menu);
57         return true;
58     }
59 
60 }

   当点击后,XML解析后的内容会把打印到日志中,可以使用LogCat查看。

  源码下载 

  

 

  

  

posted @ 2013-06-23 14:36  承香墨影  阅读(4799)  评论(0编辑  收藏  举报