你真的會用Gson嗎?Gson使用指南
本文為作者根據日常使用結合Gson源碼注釋及wiki所作的原創内容，轉載請注明出處。
本文連結：http://www.jianshu.com/p/e740196225a4
JSON (官網) 是一種文本形式的資料交換格式，它比XML更輕量、比二進制容易閱讀和編寫，調式也更加友善。其重要性不言而喻。解析和生成的方式很多，Java中最常用的類庫有：JSON-Java、Gson、Jackson、FastJson等。
注：此系列基于Gson 2.4。
對Gson使用很自信的大大可以點選關閉啦。
本篇文章的主要内容：
- Gson的基本用法
- 屬性重命名
@SerializedName
- Gson中使用泛型
一、Gson的基本用法
Gson提供了
fromJson()
和
toJson()
兩個直接用于解析和生成的方法，前者實作反序列化，後者實作了序列化。同時每個方法都提供了重載方法，我常用的總共有5個。
基本資料類型的解析
Gson gson = new Gson();
int i = gson.fromJson("100", int.class); //100
double d = gson.fromJson("\"99.99\"", double.class); //99.99
boolean b = gson.fromJson("true", boolean.class); // true
String str = gson.fromJson("String", String.class); // String 注：不知道你是否注意到了第2、3行有什麼不一樣沒
基本資料類型的生成
Gson gson = new Gson();
String jsonNumber = gson.toJson(); // 100
String jsonBoolean = gson.toJson(false); // false
String jsonString = gson.toJson("String"); //"String" POJO類的生成與解析
public class User {
//省略其它
public String name;
public int age;
public String emailAddress;
} 生成JSON：
Gson gson = new Gson();
User user = new User("怪盜kidou",);
String jsonObject = gson.toJson(user); // {"name":"怪盜kidou","age":24} 解析JSON：
Gson gson = new Gson();
String jsonString = "{\"name\":\"怪盜kidou\",\"age\":24}";
User user = gson.fromJson(jsonString, User.class); 二、屬性重命名 @SerializedName 注解的使用
從上面POJO的生成與解析可以看出json的字段和值是的名稱和類型是一一對應的，但也有一定容錯機制(如第一個例子第3行将字元串的99.99轉成double型，你可别告訴我都是字元串啊)，但有時候也會出現一些不和諧的情況，如：
期望的json格式
{"name":"怪盜kidou","age":,"emailAddress":"[email protected]"}
實際
{"name":"怪盜kidou","age":,"email_address":"[email protected]"}
這對于使用PHP作為背景開發語言時很常見的情況，php和js在命名時一般采用下劃線風格，而Java中一般采用的駝峰法，讓背景的哥們改吧 前端和背景都不爽，但要自己使用下劃線風格時我會感到不适應，怎麼辦?難到沒有兩全齊美的方法麼?
我們知道Gson在序列化和反序列化時需要使用反射，說到反射就不得不想到注解,一般各類庫都将注解放到
annotations
包下，打開源碼在
com.google.gson
包下果然有一個
annotations
，裡面有一個
SerializedName
的注解類，這應該就是我們要找的。
那麼對于json中
email_address
這個屬性對應POJO的屬性則變成：
@SerializedName("email_address")
public String emailAddress; 這樣的話，很好的保留了前端、背景、Android/java各自的命名習慣。
你以為這樣就完了麼?
如果接中設計不嚴謹或者其它地方可以重用該類，其它字段都一樣，就
emailAddress
字段不一樣，比如有下面三種情況那怎麼?重新寫一個?
{"name":"怪盜kidou","age":,"emailAddress":"[email protected]"}
{"name":"怪盜kidou","age":,"email_address":"[email protected]"}
{"name":"怪盜kidou","age":,"email":"[email protected]"}
為POJO字段提供備選屬性名
SerializedName
注解提供了兩個屬性，上面用到了其中一個，别外還有一個屬性
alternate
，接收一個String數組。
注：
alternate
需要2.4版本
@SerializedName(value = "emailAddress", alternate = {"email", "email_address"})
public String emailAddress; 當上面的三個屬性(email_address、email、emailAddress)都中出現任意一個時均可以得到正确的結果。
注：當多種情況同時出時，以最後一個出現的值為準。
Gson gson = new Gson();
String json = "{\"name\":\"怪盜kidou\",\"age\":24,\"emailAddress\":\"[email protected]\",\"email\":\"iki[email protected]\",\"email_address\":\"[email protected]\"}";
User user = gson.fromJson(json, User.class);
System.out.println(user.emailAddress); // [email protected] 三、Gson中使用泛型
上面了解的JSON中的Number、boolean、Object和String，現在說一下Array。
例：JSON字元串數組
["Android","Java","PHP"]
當我們要通過Gson解析這個json時，一般有兩種方式：使用數組，使用List。而List對于增删都是比較友善的，是以實際使用是還是List比較多。
數組比較簡單
Gson gson = new Gson();
String jsonArray = "[\"Android\",\"Java\",\"PHP\"]";
String[] strings = gson.fromJson(jsonArray, String[].class); 但對于List将上面的代碼中的
String[].class
直接改為
List<String>.class
是行不通的。對于Java來說
List<String>
和
List<User>
這倆個的位元組碼檔案隻一個那就是
List.class
，這是Java泛型使用時要注意的問題 泛型擦除。
為了解決的上面的問題，Gson為我們提供了
TypeToken
來實作對泛型的支援，是以當我們希望使用将以上的資料解析為
List<String>
時需要這樣寫。
Gson gson = new Gson();
String jsonArray = "[\"Android\",\"Java\",\"PHP\"]";
String[] strings = gson.fromJson(jsonArray, String[].class);
List<String> stringList = gson.fromJson(jsonArray, new TypeToken<List<String>>() {}.getType()); 注：
TypeToken
的構造方法是
protected
修飾的,是以上面才會寫成
new TypeToken<List<String>>() {}.getType()
而不是
new TypeToken<List<String>>().getType()
泛型解析對接口POJO的設計影響
泛型的引入可以減少無關的代碼，如我現在所在公司接口傳回的資料分為兩類：
{"code":"0","message":"success","data":{}}
{"code":"0","message":"success","data":[]}
我們真正需要的
data
所包含的資料，而
code
隻使用一次，
message
則幾乎不用。如果Gson不支援泛型或不知道Gson支援泛型的同學一定會這麼定義POJO。
public class UserResponse {
public int code;
public String message;
public User data;
} 當其它接口的時候又重新定義一個
XXResponse
将
data
的類型改成XX，很明顯
code
，和
message
被重複定義了多次，通過泛型的話我們可以将
code
和
message
字段抽取到一個
Result
的類中，這樣我們隻需要編寫
data
字段所對應的POJO即可，更專注于我們的業務邏輯。如：
public class Result<T> {
public int code;
public String message;
public T data;
} 那麼對于
data
字段是
User
時則可以寫為
Result<User>
,當是個清單的時候為
Result<List<User>>
，其它同理。
結語
本文主要通過代碼向各位讀者講解了Gson的基本用法，以後還會更新更多更進階的用法，如果你還不熟悉 注解和泛型 那麼你要多多努力啦。
如果你有其它的想了解的内容(不限于Gson)請給我留言評論，水準有限，歡迎拍磚。
補充
有說看不懂Result那段怎麼個簡化法，下面給個兩個完整的例子，User和List<User> 。
沒有引入泛型之前時寫法：
public class UserResult {
public int code;
public String message;
public User data;
}
//=========
public class UserListResult {
public int code;
public String message;
public List<User> data;
}
//=========
String json = "{..........}";
Gson gson = new Gson();
UserResult userResult = gson.fromJson(json,UserResult.class);
User user = userResult.data;
UserListResult userListResult = gson.fromJson(json,UserListResult.class);
List<User> users = userListResult.data;
上面有兩個類
UserResult
和
UserListResult
，有兩個字段重複，一兩個接口就算了，如果有上百個怎麼辦?不得累死?是以引入泛型。
//不再重複定義Result類
Type userType = new TypeToken<Result<User>>(){}.getType();
Result<User> userResult = gson.fromJson(json,userType);
User user = userResult.data;
Type userListType = new TypeToken<Result<List<User>>>(){}.getType();
Result<List<User>> userListResult = gson.fromJson(json,userListType);
List<User> users = userListResult.data;
看出差別了麼?引入了泛型之後雖然要多寫一句話用于擷取泛型資訊，但是傳回值類型很直覺，也少定義了很多無關類。
![七牛雲-C#SDK-上傳-前期準備[圖]](data:image/gif;base64,R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=)