Json解析 开发实践 XML和JSON格式的数据

JSON的定义：

       一种轻量级的数据交换格式，具有良好的可读和便于快速编写的特性。业内主流技术为其提供了完整的解决方案（有点类似于正则表达式 ，获得了当今大部分语言的支持），从而可以在不同平台间进行数据交换。JSON采用兼容性很高的文本格式，同时也具备类似于C语言体系的行为– Json.org

JSON数据是android网络开发中常见的数据格式，JSON最常见的传输方法是使用HTTP协议，关于android开发中HTTP协议的使用方法可参考我的另一篇随笔android网络编程之HTTP，解析JSON数据有多种方法：
使用官方自带JSONObject
使用第三方开源库，包括但不限于

GSON

、

FastJSON

、

Jackson

，本文主要介绍由Google提供的GSON库的使用方法。

科普：

  /*从安卓3.0以后，就不允许在主线程中直接访问网络，必须在子线程中访问
       访问后要修改主线程的UI，需要使用handler通信*/

JSON
Vs XML

1.JSON和XML的数据可读性基本相同

2.JSON和XML同样拥有丰富的解析手段

3.JSON相对于XML来讲，数据的体积小

4.JSON与JavaScript的交互更加方便

5.JSON对数据的描述性比XML较差

6.JSON的速度要远远快于XML

android2.3提供的json解析类 
android的json解析部分都在包org.json下，主要有以下几个类： 

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 。

JSONStringer：json文本构建类
，根据官方的解释，这个类可以帮助快速和便捷的创建JSON text。其最大的优点在于可以减少由于 格式的错误导致程序异常，引用这个类可以自动严格按照JSON语法规则（syntax rules）创建JSON text。每个JSONStringer实体只能对应创建一个JSON text。。其最大的优点在于可以减少由于格式的错误导致程序异常，引用这个类可以自动严格按照JSON语法规则（syntax rules）创建JSON text。每个JSONStringer实体只能对应创建一个JSON text。

JSONArray：它代表一组有序的数值。将其转换为String输出(toString)所表现的形式是用方括号包裹，数值以逗号”,”分隔（例如：
    [value1,value2,value3]，大家可以亲自利用简短的代码更加直观的了解其格式）。这个类的内部同样具有查询行为，     get()和opt()两种方法都可以通过index索引返回指定的数值，put()方法用来添加或者替换数值。同样这个类的value类型可以包括：Boolean、JSONArray、JSONObject、Number、String或者默认值JSONObject.NULL object。

JSONTokener：json解析类 

JSONException：json中用到的异常 

1.解析XML格式的数据

这里提供一段XML格式的数据用于解析：

<items>
<item>
<id>1</id>
<name>zhangsan</name>
<age>20</age>
</item>
<item>
<id>2</id>
<name>lisi</name>
<age>25</age>
</item>
</items>

解析XML格式的数据有很多方式，这里重点介绍
Pull解析 和 SAX解析：

1.Pull解析方式

/**
* @param xmlData XML格式数据
*/
private void parseXMLWithPull (String xmlData) {
try {
String id = "";
String name = "";
String age = "";
XmlPullParserFactory factory = XmlPullParserFactory.newInstance();
XmlPullParser xmlPullParser = factory.newPullParser();
xmlPullParser.setInput(new StringReader(xmlData));
int eventType = xmlPullParser.getEventType();
while (eventType != XmlPullParser.END_DOCUMENT) {
String nodeName = xmlPullParser.getName();
switch (eventType) {
// 开始解析某个节点
case XmlPullParser.START_TAG:
if ("id".equals(nodeName)) {
id = xmlPullParser.nextText();
} else if ("name".equals(nodeName)) {
name = xmlPullParser.nextText();
} else if ("age".equals(nodeName)) {
age = xmlPullParser.nextText();
}
break;
// 完成解析某个节点
case XmlPullParser.END_TAG:
if ("item".equals(nodeName)) {
Log.i("JAVA", "id:"+id+",name:"+name+",age:"+age);
}
break;
default:
break;
}
eventType = xmlPullParser.next();
}
} catch (XmlPullParserException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}

2.SAX解析方式

/**
* @param xmlData XML格式数据
*/
private void parseXMLWithSAX (String xmlData) {
try {
SAXParserFactory factory = SAXParserFactory.newInstance();
XMLReader xmlReader = factory.newSAXParser().getXMLReader();
ContentHandler handler = new ContentHandler();
xmlReader.setContentHandler(handler); // 将ContentHandler的实例设置到XMLReader中
xmlReader.parse(new InputSource(new StringReader(xmlData))); // 开始执行解析
} catch (SAXException e) {
e.printStackTrace();
} catch (ParserConfigurationException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
}
}

class ContentHandler extends DefaultHandler {
private String nodeName;
private StringBuilder id, name, age;
// XML解析的时候调用
@Override
public void startDocument() throws SAXException {
id = new StringBuilder();
name = new StringBuilder();
age = new StringBuilder();
}
// 开始解析某个节点的时候调用
@Override
public void startElement(String uri, String localName, String qName, Attributes attributes)
throws SAXException {
nodeName = localName;
}
// 获取节点中内容的时候调用
@Override
public void characters(char[] ch, int start, int length) throws SAXException {
if ("id".equals(nodeName)) {
id.append(ch, start, length);
} else if ("name".equals(nodeName)) {
name.append(ch, start, length);
} else if ("age".equals(nodeName)) {
age.append(ch, start, length);
}
}
// 完成解析某个节点的时候调用
@Override
public void endElement(String uri, String localName, String qName) throws SAXException {
if ("item".equals(localName)) {
Log.i("JAVA", "id:"+id.toString().trim()+",name:"+name.toString().trim()
+",age:"+age.toString().trim());
id.setLength(0); // 最后将StringBuilder清空
name.setLength(0);
age.setLength(0);
}
}
// 完成整个XML解析的时候调用
@Override
public void endDocument() throws SAXException {
super.endDocument();
}
}

2.解析JSON格式的数据

比起XML，JSON的主要优势在于它的体积更小，在网络上传输时可以更省流量。

这里提供一段JSON格式的数据用于解析：

[{"id":"1","name":"zhangsan","age":"20"},
{"id":"2","name":"lisi","age":"25"},
{"id":"3","name":"wangwu","age":"22"}]

解析JSON数据也有很多种方法，可以使用原生的JSONObject，也可以使用Google的开源库GSON，另外还有一些第三方开源库，比如Jackson、FastJSON等也非常不错。

1.JSONObject解析方式

/**
* @param jsonData JSON格式数据
*/
private void parseJSONWithJSONObject (String jsonData) {
try {
JSONArray jsonArray = new JSONArray(jsonData);
for (int i=0; i<jsonArray.length(); i++) {
JSONObject jsonObject = jsonArray.getJSONObject(i);
Log.i("JAVA", "id:"+jsonObject.getString("id")+",name:"+jsonObject.getString("name")
+",age:"+jsonObject.getString("age"));
}
} catch (JSONException e) {
e.printStackTrace();
}
}

2.使用GSON解析

使用GSON解析需要添加Gradle依赖（https://github.com/google/gson）：

GSON的使用方法

GSON2.6.1下载地址，点击即可下载。
将下载的gson-2.6.1.jar复制到

项目目录->app->libs

文件夹下

方法简介

toJson(params1)，将传入对象转换为字符串
fromJson(params1,params2)，传入两个参数，将字符串params1转换为params2指定的数据类型

示例代码

1 单个对象的解析

public class Student {
private int stu_no;
private String stu_name;
private String stu_sex;

Student(int stu_no,String stu_name,String stu_sex){
this.stu_no = stu_no;
this.stu_name = stu_name;
this.stu_sex = stu_sex;
}
}

// 序列化，将Student对象stu转换为字符串str
Student stu = new Student(123,"Tom","male");
Gson gson = new Gson();
String str = gson.toJson(stu);

//反序列化，将字符串转换为Student对象
jsonData = "{ \"stu_no\":12345,\"stu_name\":\"John\",\"stu_sex\":\"male\" }";
Gson gson = new Gson();
Student student = gson.fromJson(jsonData,Student.class);

2 JSON数组的解析（原生类）

3 JSON数组的解析（自定义类）

//对于类似于2.2中的jsonData，包含3个Student对象
//与原生类不同，需要借助TypeToken获得期望解析成的数据类型
//下列代码运行后，students包含三个Student对象
Gson gson = new Gson();
List<Student> students;
students = gson.fromJson(jsonData, new TypeToken<List<Student>>(){}.getType()); // ==>[stu0,stu1,stu2]

4 更多方法

GSON的

简便之处

在于其可以将字符串

自动映射

为原生或自定义对象，从而不需要手动编写代码进行解析。
GSON的

更多方法

可以阅读GSON在github上的用法介绍，README.md
-> user guide。

compile 'com.google.code.gson:gson:2.8.0'

这里我们先新建实体类（Jackson、FastJSON也会用到这个实体类）：

public class ItemBean {
private int id;
private String name;
private int age;

public int getId() {
return id;
}
public void setId(int id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
}

下面看一下如何使用GSON进行解析：

/**
* @param jsonData JSON格式数据
*/
private void parseJSONWithGSON (String jsonData) {
Gson gson = new Gson();
List<ItemBean> itemList = gson.fromJson(jsonData, new TypeToken<List<ItemBean>>(){}.getType());
for (ItemBean itemBean : itemList) {
Log.i("JAVA", "id:"+itemBean.getId()+",name:"+itemBean.getName()+",age:"+itemBean.getAge());
}
}

3.使用Jackson解析

Jackson在线文档 Jackson官网的翻译 Jackson源码查看

使用Jackson解析需要添加Gradle依赖（https://github.com/FasterXML/jackson）：

compile 'com.fasterxml.jackson.core:jackson-databind:2.9.0.pr2'

下面看一下如何使用Jackson进行解析：

/**
* @param jsonData JSON格式数据
*/
private void parseJSONWithFastJackson (String jsonData) {
try {
ObjectMapper objectMapper = new ObjectMapper();
List<ItemBean> itemList = objectMapper.readValue(jsonData,
new TypeReference<List<ItemBean>>(){});
Log.i("JAVA", itemList.toString());
for (ItemBean itemBean : itemList) {
Log.i("JAVA", "id:"+itemBean.getId()+",name:"+itemBean.getName()+",age:"+itemBean.getAge());
}
} catch (IOException e) {
e.printStackTrace();
}
}

4.使用FastJSON解析

使用FastJSON解析也需要添加Gradle依赖（https://github.com/alibaba/fastjson）：

compile 'com.alibaba:fastjson:1.2.28'

下面看一下如何使用FastJSON进行解析：

/**
* @param jsonData JSON格式数据
*/
private void parseJSONWithFastJSON (String jsonData) {
List<ItemBean> itemList = JSON.parseArray(jsonData, ItemBean.class);
for (ItemBean itemBean : itemList) {
Log.i("JAVA", "id:"+itemBean.getId()+",name:"+itemBean.getName()+",age:"+itemBean.getAge());
}
}