Android基础总结（12）——XML和JSON解析

XML和JSON解析

 　　在网络上传输数据时最常用的格式有两种：XML和JSON。本文主要就是学习如何对这两种常用的数据格式进行解析。

1、XML和JSON的定义

• XML：扩展标记语言 (Extensible Markup Language, XML) ，用于标记电子文件使其具有结构性的标记语言，可以用来标记数据、定义数据类型，是一种允许用户对自己的标记语言进行定义的源语言。 XML使用DTD(document type definition)文档类型定义来组织数据;格式统一，跨平台和语言，早已成为业界公认的标准。XML是标准通用标记语言 (SGML) 的子集，非常适合 Web 传输。XML 提供统一的方法来描述和交换独立于应用程序或供应商的结构化数据。

  <apps>
      <app>
          <id>1</id>
          <name>matlab</name>
          <version>12.5</version>
      </app>
      <app>
          <id>2</id>
          <name>chorme</name>
          <version>9.986</version>
      </app>
      <app>
          <id>3</id>
          <name>Google Maps</name>
          <version>10.4</version>
      </app>
  </apps>

• JSON：JavaScript Object Notation，一种轻量级的数据交换格式，具有良好的可读和便于快速编写的特性。可在不同平台之间进行数据交换。JSON采用兼容性很高的、完全独立于语言文本格式，同时也具备类似于C语言的习惯(包括C, C++, C#, Java, JavaScript, Perl, Python等)体系的行为。这些特性使JSON成为理想的数据交换语言。JSON基于JavaScript Programming Language , Standard ECMA-262 3rd Edition - December 1999 的一个子集。

  JSON就是一串字符串，只不过元素会使用特定的符号标注。

  　　{} 双括号表示对象

  　　[] 中括号表示数组

  　　"" 双引号内是属性或值

  　　: 冒号表示后者是前者的值(这个值可以是字符串、数字、也可以是另一个数组或对象)

  [{"id":"1","name":"matlab","version","12.5"}
  {"id":"2","name":"chorme","version","9.986"}
  {"id":"3","name":"Google Maps","version","10.4"}]    

2、XML和JSON的优缺点

• XML的优缺点
  • XML的优点
  1. 1. 格式统一，符合标准；
     2. 容易与其他系统进行远程交互，数据共享比较方便。

• • XML的缺点
  1. 1. XML文件庞大，文件格式复杂，传输占带宽；
     2. 服务器端和客户端解析XML花费较多的资源和时间。
     3. 服务器端和客户端都需要花费大量代码来解析XML，导致服务器端和客户端代码变得异常复杂且不易维护；
     4. 客户端不同浏览器之间解析XML的方式不一致，需要重复编写很多代码；
• 两者对比：
  • 相同点：
  1. 1. 两者的数据可读性基本相同
     2. 两者拥有同样丰富的解析手段
  • 异同点：
  1. 1. json的数据体积更小
     2. json与JS的交互更加方便
     3. json的解析速度更快
     4. xml对数据的描述性更好

3、XML和JSON的解析

　　我们先整体上列一个思路，对于这两种数据格式的解析，每一种数据都有多种解析方法，本文对每一种数据都提供两种经常用到的两种方式：

• XML格式解析：Pull解析方式、SAX解析方式、DOM解析方式

1. 1. Pull解析方式：Pull解析器的运行方式与 SAX 解析器相似。它提供了类似的事件，如：开始元素和结束元素事件，使用parser.next()可以进入下一个元素并触发相应事件。事件将作为数值代码被发送，因此可以使用一个switch对感兴趣的事件进行处理。当元素开始解析时，调用parser.nextText()方法可以获取下一个Text类型元素的值。

      private void parseXMLWithPull(String xmlData){
          try {
              //创建一个xml解析的工厂
              XmlPullParserFactory factory = XmlPullParserFactory.newInstance();
              //获得xml解析类的引用
              XmlPullParser xmlPullParser = factory.newPullParser();
              //以流的方式传入需要解析的xml数据
              xmlPullParser.setInput(new StringReader(xmlData));
              //获得事件的类型
              int eventType = xmlPullParser.getEventType();
              String id = "" ;
              String name = "" ;
              String version = "" ;
              //判断是否到了文档结束位置
              while(eventType != XmlPullParser.END_DOCUMENT){
                  String nodeName = xmlPullParser.getName() ;
                 switch(eventType){
                   
                    //遇到标签元素
                    case XmlPullParser.START_TAG:
                       if("id".equals(nodeName)){
                          //取出属性值,0是代表第0个属性
                          id = xmlPullParser.nextText();
                       } else if("name".equals(nodeName)){
                          //获取该节点的内容 
                          name = xmlPullParser.nextText();
                       }else if("version".equals(nodeName)){
                          //获取该节点的内容 
                          version = xmlPullParser.nextText();
                       }
                       break; 
                    //标签结束
                    case XmlPullParser.END_TAG:
                        if("app".equals(xmlPullParser.getName())){
                           //这里可以做一些初始化,或者log记录
                            Log.d("MainAvtivity", "id is" + id) ;
                            Log.d("MainAvtivity", "name is" + name) ;
                            Log.d("MainAvtivity", "version is" + version) ;
                        }
                       break;
                    default:
                        break ;
                 }
                  //循环
                  eventType = xmlPullParser.next();
              } 
          } catch (Exception e) {
              // TODO Auto-generated catch block
              e.printStackTrace();
          }
      }

   2. SAX解析方式：Simple API for XML，SAX是一个解析速度快并且占用内存少的xml解析器，非常适合用于 Android等移动设备。 SAX解析XML文件采用的是事件驱动，也就是说，它并不需要解析完整个文档，在按内容顺序解析文档的过程中，SAX会判断当前读到的字符是否合法XML 语法中的某部分，如果符合就会触发事件。所谓事件，其实就是一些回调（callback）方法，这些方法(事件)定义在ContentHandler接口。

      private void parseXMLWithSAX(String xmlData){
          try {
              //第一步：新建一个工厂类SAXParserFactory,并获取其实例
              SAXParserFactory factory = SAXParserFactory.newInstance();
              //第二步：让工厂类产生一个SAX的解析类SAXParser的对象
              SAXParser parser = factory.newSAXParser();
              //第三步：从SAXPsrser中得到一个XMLReader实例
              XMLReader xmlReader = parser.getXMLReader();
              //第四步：把自己写的handler注册到XMLReader中，一般最重要的就是ContentHandler
              MySaxHandler handler = new MySaxHandler() ;
              xmlReader.setContentHandler(handler);
              //第五步：将一个xml文档或者资源变成一个java可以处理的InputStream流后，解析正式开始
              xmlReader.parse(new InputSource(new StringReader(xmlData)));
          } catch (Exception e) {
              // TODO Auto-generated catch block
              e.printStackTrace();
          }
      }

       最重要、最关键的就是第四步，handler的实现。下面是其实现的代码：

      /*
       * 实现一个ContentHandler一般要一下几个步骤：
       * 
       * 1、声明一个类，继承DefaultHandler。DefaultHandler是一个基类，这个类里面简单实现了
       *    一个ContentHandler。我们只需要重写里面的方法即可。
       * 2、重写 startDocument() 和 endDocument()，一般解析将正式解析之前的一些初始化工资放
       *    到startDocument()里面，收尾的工作放到endDocument()里面。
       * 3、重写startElement(),XML解析器遇到XML里面的tag时就会调用这个函数。经常在这个函数内是
       *    通过localName俩进行判断而操作一些数据。
       * 4、重写characters()方法，这是一个回调方法。解析器执行完startElement()后，解析完节点的内
       *    容后就会执行这个方法，并且参数ch[]就是节点的内容。这个例子里我们根据currentstate的不同，来
       *    判断当前那个tag的内容，并放到合适的实体类中。
       * 5、重写endElement()方法，这个方法与startElement()相对应，解析完一个tag节点后，执行这个方法。
       *    再找个例子中，如果解析一个item结束，就将RSSIiem添加到RSSFeed中。
       *    
       */
      class MySaxHandler extends DefaultHandler{
          
          private String nodeName ;
          private StringBuilder id ;
          private StringBuilder name ;
          private StringBuilder version ;
          
          /**
           * 当SAX解析器解析到XML文档开始时，会调用的方法
           */
          @Override
          public void startDocument() throws SAXException {
              id = new StringBuilder() ;
              name = new StringBuilder() ;
              version = new StringBuilder() ;
          }
          
          /**
           * 当SAX解析器解析到XML文档结束时，会调用的方法
           */
          @Override
          public void endDocument() throws SAXException {
              super.endDocument();
          }
          
          /**
           * 当SAX解析器解析到某个属性值时，会调用的方法
           * 其中参数ch记录了这个属性值的内容
           */
          @Override
          public void characters(char[] ch, int start, int length)throws SAXException {
              //根据当前的节点名判断将内容添加到哪一个StringBuilder上
              if("id".equals(nodeName)){
                  id.append(ch, start, length) ;
              }else if("name".equals(nodeName)){
                  name.append(ch, start, length) ;
              }else if("version".equals(nodeName)){
                  version.append(ch, start, length) ;
              }
          }
          
          /**
           * 当SAX解析器解析到某个元素开始时，会调用的方法
           * 其中localName记录的是元素属性名
           */
          @Override
          public void startElement(String uri, String localName, String qName,
                  Attributes attributes) throws SAXException {
              nodeName = localName ;
          }
          
          /**
           * 当SAX解析器解析到某个元素结束时，会调用的方法
           * 其中localName记录的是元素属性名
           */
          @Override
          public void endElement(String uri, String localName, String qName)
                  throws SAXException {
              if("app".equals(localName)){
                  //这里可以做一些初始化,或者log记录
                   Log.d("MainAvtivity", "id is" + id) ;
                   Log.d("MainAvtivity", "name is" + name) ;
                   Log.d("MainAvtivity", "version is" + version) ;
               }
          }
      }

   3. DOM解析方式： DOM解析XML文件时，会将XML文件的所有内容读取到内存中，然后允许您使用DOM API遍历XML树、检索所需的数据。使用DOM操作XML的代码看起来比较直观，并且，在某些方面比基于SAX的实现更加简单。但是，因为DOM需要将 XML文件的所有内容读取到内存中，所以内存的消耗比较大，特别对于运行Android的移动设备来说，因为设备的资源比较宝贵，所以建议还是采用SAX 来解析XML文件，当然，如果XML文件的内容比较小采用DOM是可行的。（不适合Android移动设备）

• JSON格式解析：使用JsonObject解析和使用GSON解析。可以参考：Android学习笔记45：JSON数据解析（GSON方式）

1. 1. 使用JsonObject解析：可以看作是一个json对象,这是系统中有关JSON定义的基本单元，其包含一对(Key/Value)数值。它对外部(External：应用toString()方法输出的数值)调用的响应体现为一个标准的字符串（例如：{"JSON": "Hello, World"}，最外被大括号包裹，其中的Key和Value被冒号":"分隔）。其对于内部(Internal)行为的操作格式略微，例如：初始化一个JSONObject实例，引用内部的put()方法添加数值：new JSONObject().put("JSON", "Hello, World!")，在Key和Value之间是以逗号","分隔。Value的类型包括：Boolean、JSONArray、JSONObject、Number、String或者默认值JSONObject.NULL object。

      private void parseJSONWithJSONObject(String jsonData){
          try {
              JSONArray jsonArray = new JSONArray(jsonData);
              for (int i = 0; i < jsonArray.length(); i++) {
                  JSONObject jsonObject = jsonArray.getJSONObject(i);
                  String id = jsonObject.getString("id");
                  String name = jsonObject.getString("name");
                  String version = jsonObject.getString("version");
      
                  // 解析完之后对这些数据进行处理，这里我们只是Log输出
                  Log.d("MainAvtivity", "id is" + id);
                  Log.d("MainAvtivity", "name is" + name);
                  Log.d("MainAvtivity", "version is" + version);
              }
          } catch (Exception e) {
              e.printStackTrace();
          }
      }

   2. 使用GSON解析：要创建和解析JSON数据，也可以使用GSON来完成。GSON是Google提供的用来在Java对象和JSON数据之间进行映射的Java类库。使用GSON，可以很容易的将一串JSON数据转换为一个Java对象，或是将一个Java对象转换为相应的JSON数据。之一，GSON是谷歌的开源库，并没有被添加到Android官方的API中，因此要使用这个功能，我们需要在项目中添加一个GSON的jar包。
      在GSON的API中，提供了两个重要的方法：String toJson()和<T> fromJson()方法。其中，toJson()方法用来实现将Java对象转换为相应的JSON数据，以字符串形式返回，fromJson()方法则用来实现将JSON数据转换为相应的Java对象。所以，我们在解析JSON数据时，可以直接通过使用前面提到的fromJson()方法将JSON数据（实际上是字符串类型）转化为我们所想要的一种类型，因此，我们一般需要自定义一个相关的类来将我们需要的数据进行封装，方面我们通过fromJson()方法返回获得。这里我们将一个对象的数据封装成App类。

      private void parseJSONWithGson(String jsonData){
          Gson gson= new Gson() ;
          //我们借助TypeTolen将期望解析成的数据类型传入到fromJson()方法中
          List<App> appList = gson.fromJson(jsonData, new TypeToken<List<App>>(){}.getType()) ;
          for(App app:appList){
              // 解析完之后对这些数据进行处理，这里我们只是Log输出
              Log.d("MainAvtivity", "id is" + app.getId());
              Log.d("MainAvtivity", "name is" +app.getName());
              Log.d("MainAvtivity", "version is" + app.getVersion());
          }
      }

      /*
       * 我们将一个JSON对象（{}之间表示一个对象）封装成App类
       */
      class App{
          String id ;
          String name ;
          String version ;
          public String getId() {
              return id;
          }
          public void setId(String id) {
              this.id = id;
          }
          public String getName() {
              return name;
          }
          public void setName(String name) {
              this.name = name;
          }
          public String getVersion() {
              return version;
          }
          public void setVersion(String version) {
              this.version = version;
          }    
      }

   3. FastJSON：不详细解释。