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