Android開源庫--Gson谷歌官方json解析庫

官方文檔地址：http://google-gson.googlecode.com/svn/trunk/gson/docs/javadocs/index.html

官方網站：http://code.google.com/p/google-gson/

json官方網站：http://www.json.org/json-zh.html

目前主流數據傳輸都用的是json，解析json而且轉換成相應的類型就成了必經之路。

在沒有使用gson以前，原生Andoird自帶有類解析json，可是實在不方便使用。

先介紹一下Android原生的解析

在Android中包含四個與JSON相關的類和一個Exceptions：
JSONArray
JSONObject
JSONStringer
JSONTokener
JSONException

（1）JSONObject:
這是系統中有關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。
有兩個不一樣的取值方法：
get(): 在肯定數值存在的條件下使用，不然當沒法檢索到相關Key時，將會拋出一個Exception信息。
opt(): 這個方法相對比較靈活，當沒法獲取所指定數值時，將會返回一個默認數值，並不會拋出異常。

（2）JSONArray:
它表明一組有序的數值。將其轉換爲String輸出(toString)所表現的形式是用方括號包裹，數值以逗號」,」分隔（例如：[value1,value2,value3]，你們能夠親自利用簡短的代碼更加直觀的瞭解其格式）。這個類的內部一樣具備查詢行爲，get()和opt()兩種方法均可以經過index索引返回指定的數值，put()方法用來添加或者替換數值。
一樣這個類的value類型能夠包括：Boolean、JSONArray、JSONObject、Number、String或者默認值JSONObject.NULL object。

使用起來是這樣的

//將此json數據變成一個對象。
JSONObject jsonObject = new JSONObject(String);
//而後得到list裏面的數據
JSONArray jsonArray = jsonObject.getJSONArray("list");

//當不知道key時，使用循環
for(int i=0;i<jsonArray.length();i++)
    {
        JSONObject jsonOb = (JSONObject)jsonArray.opt(i);
        int tel = jsonOb.getInt("tel");
    }

（3）JSONStringer:
根據官方的解釋，這個類能夠幫助快速和便捷的建立JSONtext。其最大的優勢在於能夠減小因爲格式的錯誤致使程序異常，引用這個類能夠自動嚴格按照JSON語法規則（syntaxrules）建立JSON text。每一個JSONStringer實體只能對應建立一個JSON text。

String myString = new JSONStringer().object().key("name").value("小豬").endObject().toString();  
//結果是一組標準格式的JSON text：{"name" : "小豬"}

其中的.object()和.endObject()必須同時使用，是爲了按照Object標準給數值添加邊界。一樣，針對數組也有一組標準的方法來生成邊界.array()和.endArray()。

（4）JSONTokener:
這個是系統爲JSONObject和JSONArray構造器解析JSON source string的類，它能夠從source string中提取數值信息。
（5）JSONException:
是JSON.org類拋出的異常信息。

 

自從使用了gson，一切都變得簡單了

Gson有兩個重要的方法，一個是toJson，一個是fromJson，也就是序列化和反序列化。

使用起來很是簡單

Gson gson = new Gson();
//序列化
MyObject myobj = new MyObject();  
String jsonstr = gson .toJson(myobj);

//反序列化
MyObject myobj = gson.fromJson(jsonstr, MyObject.class);  

//序列化數組
String[] days = {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"};
String numbersJson = gson.toJson(numbers);

//序列化集合
List<String> myobjs = new ArrayList<String>();
String jsonstr = gson.toJson(myobjs);

//反序列化集合數組
List<MyObject> myobjs = gson.fromJson(str, new TypeToken<ArrayList<MyObject>>(){}.getType());

同時Gson還支持使用註解，在com.google.gson.annotation包中，有幾個註解Expose, SerializedName, Since和Until，他們各有各的做用，下面使用官方例子介紹經常使用的註解：

Expose

　　此註解做用在屬性上，代表當序列化和反序列化的時候，這個屬性將會暴露給Gson對象。這個註解只有當建立Gson對象時使用GsonBuilder方式建立並調用了GsonBuilder.excludeFieldsWithoutExposeAnnotation() 方法的時候纔有效，不然無效。下面是一個介紹@Expose註解如何使用的例子：

public class User {
　@Expose private String firstName;
　@Expose(serialize = false) private String lastName;
　@Expose (serialize = false, deserialize = false) private String emailAddress;
　private String password;
}

若是你以new Gson()的方式建立Gson對象，toJson()方法和fromJson() 方法在序列化和反序列化的時候將會操做這4個屬性。然而，若是你使用 Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation().create()來建立Gson對象，Gson 的 toJson() 和 fromJson() 方法將會排除掉 password 字段，這是由於 password 字段沒有被註解 @Expose 所標記。 這個 Gson 對象一樣會排除 lastName 和 emailAddress 字段，由於註解@Expose的屬性 serialize 被設置成了 false。相似的，Gson 將會在反序列化時排除掉 emailAddress 字段，由於 deserialize被設置成了 false。

 

PS：

若是不但願有某些屬性，也可使用transient屏蔽，如：

transient int val;

 

SerializedName

　　此註解做用在屬性上，代表這個屬性在序列化成Json的時候，須要將名字序列化成註解的value屬性指定的值。

　　這個註解將會覆蓋任何的FieldNamingPolicy， 包括默認的命名策略。下面是一個介紹@SerializedName註解如何使用的例子：

public class SomeClassWithFields {
   　@SerializedName("name") private final String someField;
   　private final String someOtherField;
   　public SomeClassWithFields(String a, String b) {
     　this.someField = a;
     　this.someOtherField = b;
   　}
}

序列化結果是：{"name":"a","someOtherField":"b"}

Since

使用@Since註解去維護版本，好比你有一個REST的API,而且有多個版本的JSON，若是下一個版本JSON中增長了字段，但又不但願全部的版本都在使用這些字段的話，就可使用

public class Example33 {  
  public static void main(String[] args) {  
    Gson gson = new GsonBuilder().setVersion(2.0).create();  
    String json = gson.toJson(new ExampleClass());  
    System.out.println("Output for version 2.0...");  
    System.out.println(json);  
      
    gson= new GsonBuilder().setVersion(1.0).create();  
    json = gson.toJson(new ExampleClass());  
    System.out.println("\nOutput for version 1.0...");  
    System.out.println(json);  
      
    gson= new Gson();  
    json = gson.toJson(new ExampleClass());  
    System.out.println("\nOutput for No version set...");  
    System.out.println(json);  
  }  
}  
   
class ExampleClass{  
  String field=  "field";  
  // this is in version 1.0  
  @Since(1.0) String newField1 = "field 1";  
  // following will be included in the version 1.1  
  @Since(2.0) String newField2 = "field 2";  
}  

輸出爲：
Output for version 2.0...
{"field":"field","newField1":"field 1","newField2":"field 2"}

Output for version 1.0...
{"field":"field","newField1":"field 1"}

Output for No version set...
{"field":"field","newField1":"field 1","newField2":"field 2"}

Until

和Since相反，若是下一個版本JSON中刪除了某個字段，就可使用，原理同上。

 

使用註釋以後，咱們建立gson就須要用到

GsonBuilder

具體設置參數以下

Gson gson = new GsonBuilder()  
        .excludeFieldsWithoutExposeAnnotation() //不導出實體中沒有用@Expose註解的屬性  
        .enableComplexMapKeySerialization() //支持Map的key爲複雜對象的形式  
        .serializeNulls().setDateFormat("yyyy-MM-dd HH:mm:ss:SSS")//時間轉化爲特定格式    
        .setFieldNamingPolicy(FieldNamingPolicy.UPPER_CAMEL_CASE)//會把字段首字母大寫,注:對於實體上使用了@SerializedName註解的不會生效.  
        .setPrettyPrinting() //對json結果格式化.  
        .setVersion(1.0)
　　   　.disableHtmlEscaping()//默認是GSON把HTML 轉義的，但也能夠設置不轉義
        .serializeNulls()//把null值也轉換，默認是不轉換null值的，能夠選擇也轉換
        .create();

 

PS:若是須要轉換的類包括泛型，那麼也須要用到TypeToken，經過這個類能夠獲取具體的類型

public class ApiResult<T> {
    private int ret;
    private String msg;
    private T data;

    public int getRet() {
        return ret;
    }

    public void setRet(int ret) {
        this.ret = ret;
    }

    public String getMsg() {
        return msg;
    }

    public void setMsg(String msg) {
        this.msg = msg;
    }

    public T getData() {
        return data;
    }

    public void setData(T data) {
        this.data = data;
    }

}

                ApiResult<UserInfo> r = GsonUtils.parse(json, new TypeToken<ApiResult<UserInfo>>() {
                }.getType());

 

 

參考網站：

http://jiuyuehe.iteye.com/blog/1882800

http://shazhuzhu1.iteye.com/blog/974758

http://jackyrong.iteye.com/blog/2004374

http://blog.csdn.net/lk_blog/article/details/7685190