本文為作者根據日常使用結合Gson源碼注釋及wiki所作的原創內容，轉載請注明出處。
本文鏈接：http://www.lxweimin.com/p/e740196225a4
JSON (官網) 是一種文本形式的數據交換格式，它比XML更輕量、比二進制容易閱讀和編寫，調式也更加方便。其重要性不言而喻。解析和生成的方式很多，Java中最常用的類庫有：JSON-Java、Gson、Jackson、FastJson等，本次我向大家介紹的是Gson。
該系列其它文章
注：此系列基于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); // 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",24);
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":24,"emailAddress":"ikidou@example.com"}
實際
{"name":"怪盜kidou","age":24,"email_address":"ikidou@example.com"}
這對于使用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":24,"emailAddress":"ikidou@example.com"}
{"name":"怪盜kidou","age":24,"email_address":"ikidou@example.com"}
{"name":"怪盜kidou","age":24,"email":"ikidou@example.com"}
為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\":\"ikidou_1@example.com\",\"email\":\"ikidou_2@example.com\",\"email_address\":\"ikidou_3@example.com\"}";
User user = gson.fromJson(json, User.class);
System.out.println(user.emailAddress); // ikidou_3@example.com
三、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>>，其它同理。
PS：嫌每次 new TypeToken<Result<XXX> 和 new TypeToken<Result<List<XXX>> 太麻煩, 想進一步封裝? 查看我的另一篇博客：** 《搞定Gson泛型封裝》 **
結語
本文主要通過代碼向各位讀者講解了Gson的基本用法，以后還會更新更多更高級的用法，如果你還不熟悉 注解和泛型 那么你要多多努力啦。
如果你有其它的想了解的內容(不限于Gson)請給我留言評論，水平有限，歡迎拍磚。
4月6日補充
有說看不懂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;
看出區別了么?引入了泛型之后雖然要多寫一句話用于獲取泛型信息，但是返回值類型很直觀，也少定義了很多無關類。
我最近剛剛開通了微信公眾號（怪盜kidou），歡迎關注
