网络相关系列之四：数据解析之SAX方式解析XML数据

Posted 2020-07-02 koozxcv

一、XML和Json数据的引入：

通常情况下，每个需要访问网络的应用程序都会有一个自己的服务器，我们可以向服务器提交数据，也可以从服务器获取数据。不过这个时候就有一个问题，这些数据是以什么格式在网络上传输的呢？一般我们都会在网络上传输一些格式化后的数据，这种数据会有一定的结构规格和语言，当另一方收到数据消息后就可以按照相同的结构规格进行解析，从而取出它想要的那部分内容。

在网络上传输数据最常用的格式：XML和Json。本文就来学习一下XML数据的解析，Json格式的数据解析将在下一篇文章中讲到。

二、XML的介绍：

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

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

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

XML的结构解析如下：

• 节点
• 元素
• 属性和属性值

格式如下：

<标记名称 属性名1="属性值1" 属性名1="属性值1" ……>内容</标记名称>

三、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解析器，非常适合用于Android等移动设备。 SAX解析XML文件采用的是事件驱动，也就是说，它并不需要解析完整个文档，在按内容顺序解析文档的过程中，SAX会判断当前读到的字符是否合法XML语法中的某部分，如果符合就会触发事件。所谓事件，其实就是一些回调（callback）方法，这些方法(事件)定义在ContentHandler接口。

使用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()
当遇到文档的开头的时候，调用这个方法，可以在其中做一些预处理的工作。 

public void startElement(String namespaceURI, String localName, String qName, Attributes attributes)
当读到一个开始标签的时候，会触发这个方法，再次获得元素的属性。namespaceURI就是命名空间，localName是不带命名空间前缀的标签名，qName是带命名空间前缀的标签名。通过attributes可以得到所有的属性名和相应的值。要注意的是SAX中一个重要的特点就是它的流式处理，当遇到一个标签的时候，它并不会纪录下以前所碰到的标签，也就是说，在startElement()方法中，所有你所知道的信息，就是标签的名字和属性，至于标签的嵌套结构，上层标签的名字，是否有子元属等等其它与结构相关的信息，都是不得而知的，都需要你的程序来完成。这使得SAX在编程处理上没有DOM来得那么方便。 

public void characters(char[] ch, int start, int length)
这个方法用来处理在XML文件中读到的内容，第一个参数用于存放文件的内容，后面两个参数是读到的字符串在这个数组中的起始位置和长度，使用new String(ch,start,length)就可以获取内容。 

public void endElement(String uri, String localName, String name)
和startElement()方法相对应，在遇到结束标签的时候，调用这个方法。

public void endDocument()
和startDocument()方法相对应。当文档结束的时候，调用这个方法，可以在其中做一些善后的工作。 

我们通过一个XML文件来讲解一下上面的五个方法在什么时候被执行：

<?xml version="1.0" encoding="utf-8"?>                  startDocument

<persons>                                                             startElement

　　<person id="01">                                             startElement

  　 　　<name nameid="1">                                   startElement

   　　   andy                                                         characters

  　　    </name>                                                   endElement

           <age>                                                        startElement

            23                                                             characters

          </age>                                                        endElement

　 </person>　　　　　　　　　　　　　　　　　　　　  endElement　　　　　　　

</persons> 　　　　　　　　　　　　　　　　　　　　   endElement

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

五、SAX解析XML的步骤：（代码实现）

现在通过一个示例程序来讲解一下SAX是怎么解析XML文件的，这个示例程序是运行在Android平台上的，为了模拟真实情况，在tomcat服务器上放置了一个静态的XML文件，即在opt/apache-tomcat-8.0.33/webapps/ROOT目录(当然这只是我的目录)中新建一个andy.xml文件，xml文件内容如下：

<?xml version="1.0" encoding="UTF-8"?>
<persons>
    <person id="01">
        <name>andy</name>
        <age>23</age>
    </person>
    <person id="02">
        <name>koozxcv</name>
        <age>24</age>
    </person>
</persons>

因为我电脑的IP地址是192.168.191.3。现在我们在浏览器输入http://192.168.191.3:8080/andy.xml，显示效果如下：

现在我们需要做的是：通过Android程序去获取并解析这段XML数据。在这个示例程序中，读取person节点的值。因为是Android程序，所以别忘了赋予其访问网络的权限。

（1）【新建工具类HttpUtils】通过URLHttpConnection获取服务器上的XML流：

我们将其写成工具类，代码如下：

 package com.example.androidsaxxml.http;
 
 import java.io.InputStream;
 import java.net.HttpURLConnection;
 import java.net.URL;
 
 //工具类：通过URLHttpConnection获取服务器上的XML流
 public class HttpUtils {
 
     public HttpUtils() {
     }
     
     //方法：返回的InputStream对象就是服务器返回的XML流。
     public static InputStream getXML(String path) {//参数path：之后将在MainActivity中指定具体的url链接
         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;
     }
 } 

（2）【新建类MyHandler】新建子类MyHandler，继承DefaultHandler类：用来解析xml

sax解析xml最重要的步骤就是定义一个我们自己的Handler处理类，并让其继承 DefaultHandler 这个类，然后在里面重写其回调方法，在这些回调方法里来做我们的xml解析。代码如下：

 package com.example.androidsaxxml.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;
 
 
 //类：MyHandler，继承DefaultHandler类，用于解析XML数据。
 //之后在MainActivity中通过设定具体的nodeName来实例化MyHandler
    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;
     }
 }

(3)【新建类SaxService】实例化一个SAX解析器的工厂对象:SAXParserFactory

需要一个调用SAXParser对象的类，这里新建一个SaxService类，实例化SAXParserFactory用于设定XML流和解析器，也就是在这里调用了上一步中的MyHandler类。代码如下：

package com.example.androidsaxxml.service;
  
 import java.io.InputStream;
 import java.util.HashMap;
 import java.util.List;
 
 import javax.xml.parsers.SAXParser;
 import javax.xml.parsers.SAXParserFactory;
  
 import com.example.androidsaxxml.handler.MyHandler;
 
 
 //类：用于实例化例化一个SAX解析器的工厂对象:SAXParserFactory
 public class SaxService {
 
     public SaxService() {
         // TODO Auto-generated constructor stub
     }
     
     //方法：解析xml数据并返回，返回值类型是HashMap
     public static List<HashMap<String, String>> readXML(InputStream inputStream,String nodeName)
     {
         try {
             //实例化SAX工厂类
             SAXParserFactory factory=SAXParserFactory.newInstance();
             //实例化SAX解析器。
             SAXParser sParser=factory.newSAXParser();
             //实例化工具类MyHandler，设置需要解析的节点
             MyHandler myHandler=new MyHandler(nodeName);
             // 开始解析
             sParser.parse(inputStream, myHandler);
             // 解析完成之后，关闭流
             inputStream.close();
             //返回解析结果。
             return myHandler.getList();  //在这里返回解析之后的数据
         } catch (Exception e) {
             // TODO: handle exception
         }        
         return null;
     }
     
 } 

（4）在MainActicity中实例化：即实例化需要访问的链接path和需要解析的节点nodeName

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

 package com.example.androidsaxxml;
 
 import java.io.InputStream;
 import java.util.HashMap;
 import java.util.List;
 
 import android.app.Activity;
 import android.os.Bundle;
 import android.view.View;
 import android.widget.Button;
 
 import com.example.androidsaxxml.http.HttpUtils;
 import com.example.androidsaxxml.service.SaxService;
 
 
 public class MainActivity extends Activity {
     private Button button;
     @Override
     protected void onCreate(Bundle savedInstanceState) {
         super.onCreate(savedInstanceState);
         setContentView(R.layout.activity_main);
         
         button=(Button)findViewById(R.id.button1);
         button.setOnClickListener(new View.OnClickListener() {
             
             @Override
             //点击按钮，开启线程访问网络
             public void onClick(View v) {
                 Thread thread=new Thread(new Runnable() {
                     
                     @Override
                     public void run() {
                         // 设置XML文档的路径
                         String path="http://192.168.1.112:8080/smyhvae.xml";
                         //调用类HttpUtils：从服务器上获取XML流。
                         InputStream inputStream=HttpUtils.getXML(path);
                         try {
                             //调用类SaxService：解析流，同时设定需要解析的节点
                             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();                
             }
         });        
     }
 }

当点击按钮后，XML解析后的内容会把打印到日志中: