Android開源庫--GsonGoogle官方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();

 

 

參考網站：

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

Android開源庫--GsonGoogle官方json解析庫