Android网络之数据解析----使用Google Gson解析Json数据

【声明】 

欢迎转载，但请保留文章原始出处→_→ 

生命壹号：http://www.cnblogs.com/smyhvae/

文章来源：http://www.cnblogs.com/smyhvae/p/4063452.html

 

【正文】

文章回顾： Android网络之数据解析----SAX方式解析XML数据

一、Json数据的介绍                                                                                                                

Json(JavaScript Object Notation) 是一种轻量级的数据交换格式。它基于JS的一个子集。 Json采用完全独立于语言的文本格式，这使得Json成为理想的数据交换语言。易于人阅读和编写，同时也易于机器解析和生成。

Json简单来说就是JS中的对象和数组，所以Json也存在两种结构：对象、数组。

1、Json对象：

含义：是“‘键/值’对”的无序集合

格式：Json对象定义在花括号“{}”内，以Key:value键值对的形式存放数据，多个键值对之间使用逗号“,”隔开，多个数据使用分号“;”隔开。

举例：

{
    “name”:”jackson”,
    “age”:100
}

注：不同的语言中，它被理解为对象（object）、纪录（record）、结构（struct）、字典（dictionary）、哈希表（hash table）、有键列表（keyed list）、或者关联数组 （associative array）。

2、Json数组：

含义：数组是值（value）的有序集合

格式：Json数组定义在方括号“[]”内，以字符串的形式存放数据，值之间使用逗号“,”隔开，多个数据使用分号“；”隔开。

举例：

{
    “students”:
    [
        {“name”:”jackson”,“age”:100},
        {“name”:”michael”,”age”:51}
    ]
}

一般情况下，我们用jsp+servlet作服务器端，生成Json的数据；然后在客户端解析Json的数据。

解析JSON数据, 首先需要明确待解析的是JSON Object还是JSON array, 然后需要确定采用哪种解析技术。android平台上一般有以下几种解析技术可供选择:android内置的org.json包（Json），google的开源库GSON，还有一些第三方的开源库如Jackson、FastJson等。我们今天来学习一下使用开源库GSON来解析Json数据。

 

二、Gson解析Json的基本思路                                                                                                     

首先在服务器端，将服务器端的Person对象通过Gson解析成json的字符串；然后在客户端，通过Gson类将json的字符串还原为Person对象。Gson支持任意复杂Java对象包括没有源代码的对象。

如果我们将Person对象看成一个泛型，那么不管服务器端的Person对象是什么类型，都可以解析出来。

Gson库神奇在哪里呢？如果解析的是Json对象，它主要就是可以将一段Json格式的字符串自动映射成一个对象，从而不需要我们再手动去编写代码进行解析了。比如一段Json格式的数据如下：

{"name":"tom","age":20} 

那我们就可以写一个Person类，并加入name和age这两个字段，只需要简单地调用如下代码就可以将Json数据自动解析成一个Person对象了：

Gson gson = new Gson();

Person person = gson.fromJson(jsonData,Person.class); 

如果解析的是Json对象数组，就要麻烦一点，需要借助Typetoken（官方提供的一种反射机制）将期望解析成的数据类型传入到fromJson()方法中，如下所示：

List<Person> people = gson.fromJson(jsonData, new TypeToken<List<Person>>().getType()); 

基本用法就是这样，我们现在来看一下具体的实现步骤吧。

 

三、Gson解析Json的步骤（代码实现）                                                                                           

现在通过一个示例程序来讲解一下SAX是怎么解析XML文件的，这个示例程序是运行在Android平台上的，为了模拟真实情况，在tomcat服务器上放置了一个两个静态的XML文件：person.json和perons.json，前者代表对象，后者代表对象数组。即在D:\apache-tomcat-8.0.14\webapps\ROOT目录中新建文件person.json和perons.json.

person.json的内容如下：

{
"id": 1,
"name": "smyhvae",
"address":"成都"
} 

需要特别注意的是，要注意json文件的格式。例如第4行的后面不要有逗号（我就是因为这个低级错误，导致后来调试程序，调了半个多小时才发觉）

persons.json的内容如下：

[{
    "id": 1,
    "name": "smyhvae",
    "address":"成都"
},
{
    "id": 2,
    "name": "许嵩",
    "address":"合肥"
}] 

注：关于tomcat服务器的配置，如果不清楚的话，请参照本人另外一篇博客的第三段：JavaWeb学习（一）----JSP简介及入门（含Tomcat的使用）

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

上方的中文出现了乱码，不过没关系，在稍后解析的时候是不会出现这种情况的。

现在我们需要做的是：通过Android程序去获取并解析这段Json数据。因为是Android程序，所以别忘了赋予其访问网络的权限。

整个工程文件的目录结构如下：

（1）下载并添加Gson的jar包：

下载地址：https://code.google.com/p/google-gson/  网页界面如下：

点击上图中的红框部分，出现如下界面：

上图中的红框部分gson-2.3.jar就是我们需要下载的内容，如果需要帮助文档的话，也可以把箭头处的文件下载下来。然后把gson-2.3.jar拷贝到工程文件的libs目录下，Gson库就自动添加到项目中去了。

（2）【新建工具类HttpUtils】通过URLHttpConnection获取服务器上的XML流：返回的是字符串

package com.example.android_gson_json.http;

import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.HttpURLConnection;
import java.net.URL;


//通过HttpURLCnnection获取链接里的数据，放到流里，然后把流里面的数据转换为字符串（借鉴于：老罗老版本1-04）
public class HttpUtils {

    public HttpUtils() {
        // TODO Auto-generated constructor stub
    }

    public static String getJsonContent(String url_path) {
        try {
            URL url = new URL(url_path);
            HttpURLConnection connection = (HttpURLConnection) url
                    .openConnection();
            connection.setConnectTimeout(3000);
            connection.setRequestMethod("GET");
            connection.setDoInput(true);
            int code = connection.getResponseCode();
            if (code == 200) {
                return changeInputStream(connection.getInputStream());
            }
        } catch (Exception e) {
            // TODO: handle exception
        }
        return "";
    }

    private static String changeInputStream(InputStream inputStream) {
        // TODO Auto-generated method stub
        String jsonString = "";
        ByteArrayOutputStream outputStream = new ByteArrayOutputStream();
        int len = 0;
        byte[] data = new byte[1024];
        try {
            while ((len = inputStream.read(data)) != -1) {
                outputStream.write(data, 0, len);
            }
            jsonString = new String(outputStream.toByteArray());
        } catch (IOException e) {
            // TODO Auto-generated catch block
            e.printStackTrace();
        }
        return jsonString;
    }
}

（3）【新建类Person】新建实体类Person，用于存放解析完成后的对象数据

package com.example.android_gson_json.domain;

public class Person {
    private int id;
    private String name;
    private String address;
    public Person() {
        super();
    }
    public Person(int id, String name, String address) {
        super();
        this.id = id;
        this.name = name;
        this.address = address;
    }
    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 String getAddress() {
        return address;
    }
    public void setAddress(String address) {
        this.address = address;
    }
    @Override
    public String toString() {
        return "Person [id=" + id + ", name=" + name + ", address=" + address
                + "]";
    }    
    
}

（4）【新建类GsonTools】真正用于解析Json数据

package com.example.android_gson_json.gson;

import java.util.ArrayList;
import java.util.List;

import com.google.gson.Gson;
import com.google.gson.reflect.TypeToken;

public class GsonTools {

    public GsonTools() {
        // TODO Auto-generated constructor stub
    }

    //使用Gson进行解析Person
    public static <T> T getPerson(String jsonString, Class<T> cls) {
        T t = null;
        try {
            Gson gson = new Gson(); 20             t = gson.fromJson(jsonString, cls); 21         } catch (Exception e) {
            // TODO: handle exception
        }
        return t;
    }
    
    
    // 使用Gson进行解析 List<Person>
    public static <T> List<T> getPersons(String jsonString, Class<T> cls) {
        List<T> list = new ArrayList<T>();
        try {
            Gson gson = new Gson(); 33             list = gson.fromJson(jsonString, new TypeToken<List<T>>() { 34  }.getType()); 35         } catch (Exception e) {
        }
        return list;
    }

}

上面有两个方法，分别用于解析Person对象、List嵌套的Person。如果还有更复杂的数据类型，以后再说吧~O(∩_∩)O~这里只需要注意关键的思路就行。

核心代码：19至20行、32至34行

（5）在MainActicity中实例化：即实例化需要访问的链接path并解析它

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

package com.example.android_gson_json;

import java.util.List;

import android.app.Activity;
import android.os.Bundle;
import android.util.Log;
import android.view.View;
import android.view.View.OnClickListener;
import android.widget.Button;

import com.example.android_gson_json.domain.Person;
import com.example.android_gson_json.gson.GsonTools;
import com.example.android_gson_json.http.HttpUtils;

public class MainActivity extends Activity implements OnClickListener {

    private Button button1, button2;
    private static final String TAG = "MainActivity";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        button1 = (Button) this.findViewById(R.id.button1);
        button2 = (Button) this.findViewById(R.id.button2);
        button1.setOnClickListener(this);
        button2.setOnClickListener(this);
    }

    //点击按钮，开始使用Gson解析Json数据：Person对象、List嵌套的Person对象的集合
    @Override
    public void onClick(final View v) {
        Thread thread = new Thread(new Runnable() {

            @Override
            public void run() {
                switch (v.getId()) {
                case R.id.button1:
                    String path = "http://192.168.1.112:8080/person.json";
                    String jsonString = HttpUtils.getJsonContent(path);//从网络获取数据
                    Person person = GsonTools.getPerson(jsonString, Person.class);//解析json数据
                    Log.i(TAG, person.toString());
                    break;
                case R.id.button2:
                    String path2 = "http://192.168.1.112:8080/persons.json";
                    String jsonString2 = HttpUtils.getJsonContent(path2);//从网络获取数据
                    List<Person> list = GsonTools.getPersons(jsonString2, Person.class);//解析json数据
                    Log.i(TAG, list.toString());
                    break;
                }

            }
        });
        thread.start();

    }

}

核心代码：43行、49行

（6）添加网络权限：（这个千万不要忘记了）

<uses-sdk
android:minSdkVersion="14"
android:targetSdkVersion="21" />
<uses-permission android:name="android.permission.INTERNET"/> 

程序运行在模拟器上运行后，界面如下：

分别点击这两个按钮，后台打印的日志如下：

在真机上运行的效果如下：

说明Json数据解析成功，大功告成。

最后声明：

其实，如果是在模拟器上运行，即使不添加网络权限，也是没有关系的；但是，如果在真机上运行（前提是真机和电脑在同一个局域网），不添加网络权限，程序是绝对运行不了的，点击按钮，程序就会死掉，这个地方又耽误了我半个小时，罪过。

【工程文件】

链接：http://pan.baidu.com/s/1mgj0FY4

密码：61u3