你真的會(huì)用Gson嗎?Gson使用指南（一）

你真的會(huì)用Gson嗎?Gson使用指南（一）
JSON (官網(wǎng)) 是一種文本形式的數(shù)據(jù)交換格式，它比XML更輕量、比二進(jìn)制容易閱讀和編寫，調(diào)式也更加方便。其重要性不言而喻。解析和生成的方式很多，Java中最常用的類庫(kù)有：JSON-Java、Gson、Jackson、FastJson等，本次我向大家介紹的是Gson。

本篇文章的主要內(nèi)容：

Gson的基本用法
屬性重命名 @SerializedName 注解的使用
Gson中使用泛型
一、Gson的基本用法
Gson提供了fromJson() 和toJson() 兩個(gè)直接用于解析和生成的方法，前者實(shí)現(xiàn)反序列化，后者實(shí)現(xiàn)了序列化。同時(shí)每個(gè)方法都提供了重載方法，我常用的總共有5個(gè)。

基本數(shù)據(jù)類型的解析

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行有什么不一樣沒(méi)

基本數(shù)據(jù)類型的生成

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的字段和值是的名稱和類型是一一對(duì)應(yīng)的，但也有一定容錯(cuò)機(jī)制(如第一個(gè)例子第3行將字符串的99.99轉(zhuǎn)成double型，你可別告訴我都是字符串啊)，但有時(shí)候也會(huì)出現(xiàn)一些不和諧的情況，如：
期望的json格式

{"name":"怪盜kidou","age":24,"emailAddress":"ikidou@example.com"}
實(shí)際

{"name":"怪盜kidou","age":24,"email_address":"ikidou@example.com"}
這對(duì)于使用PHP作為后臺(tái)開發(fā)語(yǔ)言時(shí)很常見(jiàn)的情況，php和js在命名時(shí)一般采用下劃線風(fēng)格，而Java中一般采用的駝峰法，讓后臺(tái)的哥們改吧 前端和后臺(tái)都不爽，但要自己使用下劃線風(fēng)格時(shí)我會(huì)感到不適應(yīng)，怎么辦?難到?jīng)]有兩全齊美的方法么?

我們知道Gson在序列化和反序列化時(shí)需要使用反射，說(shuō)到反射就不得不想到注解,一般各類庫(kù)都將注解放到annotations包下，打開源碼在com.google.gson包下果然有一個(gè)annotations，里面有一個(gè)SerializedName的注解類，這應(yīng)該就是我們要找的。

那么對(duì)于json中email_address這個(gè)屬性對(duì)應(yīng)POJO的屬性則變成：

@SerializedName("email_address")
public String emailAddress;
這樣的話，很好的保留了前端、后臺(tái)、Android/java各自的命名習(xí)慣。

你以為這樣就完了么?

如果接中設(shè)計(jì)不嚴(yán)謹(jǐn)或者其它地方可以重用該類，其它字段都一樣，就emailAddress 字段不一樣，比如有下面三種情況那怎么?重新寫一個(gè)?

{"name":"怪盜kidou","age":24,"emailAddress":"ikidou@example.com"}{"name":"怪盜kidou","age":24,"email_address":"ikidou@example.com"}
br/>{"name":"怪盜kidou","age":24,"email_address":"ikidou@example.com"}
為POJO字段提供備選屬性名
SerializedName注解提供了兩個(gè)屬性，上面用到了其中一個(gè)，別外還有一個(gè)屬性alternate，接收一個(gè)String數(shù)組。
注：alternate需要2.4版本

@SerializedName(value = "emailAddress", alternate = {"email", "email_address"})
public String emailAddress;
當(dāng)上面的三個(gè)屬性(email_address、email、emailAddress)都中出現(xiàn)任意一個(gè)時(shí)均可以得到正確的結(jié)果。
注：當(dāng)多種情況同時(shí)出時(shí)，以最后一個(gè)出現(xiàn)的值為準(zhǔn)。

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，現(xiàn)在說(shuō)一下Array。

例：JSON字符串?dāng)?shù)組

["Android","Java","PHP"]
當(dāng)我們要通過(guò)Gson解析這個(gè)json時(shí)，一般有兩種方式：使用數(shù)組，使用List。而List對(duì)于增刪都是比較方便的，所以實(shí)際使用是還是List比較多。

數(shù)組比較簡(jiǎn)單

Gson gson = new Gson();
String jsonArray = "[\"Android\",\"Java\",\"PHP\"]";
String[] strings = gson.fromJson(jsonArray, String[].class);
但對(duì)于List將上面的代碼中的 String[].class 直接改為 List<String>.class 是行不通的。對(duì)于Java來(lái)說(shuō)List<String> 和List<User> 這倆個(gè)的字節(jié)碼文件只一個(gè)那就是List.class，這是Java泛型使用時(shí)要注意的問(wèn)題 泛型擦除。

為了解決的上面的問(wèn)題，Gson為我們提供了TypeToken來(lái)實(shí)現(xiàn)對(duì)泛型的支持，所以當(dāng)我們希望使用將以上的數(shù)據(jù)解析為L(zhǎng)ist<String>時(shí)需要這樣寫。

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的構(gòu)造方法是protected修飾的,所以上面才會(huì)寫成new TypeToken<List<String>>() {}.getType() 而不是 new TypeToken<List<String>>().getType()

泛型解析對(duì)接口POJO的設(shè)計(jì)影響
泛型的引入可以減少無(wú)關(guān)的代碼，如我現(xiàn)在所在公司接口返回的數(shù)據(jù)分為兩類：

{"code":"0","message":"success","data":{}}
{"code":"0","message":"success","data":[]}
我們真正需要的data所包含的數(shù)據(jù)，而code只使用一次，message則幾乎不用。如果Gson不支持泛型或不知道Gson支持泛型的同學(xué)一定會(huì)這么定義POJO。

public class UserResponse {
public int code;
public String message;
public User data;
}
當(dāng)其它接口的時(shí)候又重新定義一個(gè)XXResponse將data的類型改成XX，很明顯code，和message被重復(fù)定義了多次，通過(guò)泛型的話我們可以將code和message字段抽取到一個(gè)Result的類中，這樣我們只需要編寫data字段所對(duì)應(yīng)的POJO即可，更專注于我們的業(yè)務(wù)邏輯。如：

public class Result<T> {
public int code;
public String message;
public T data;
}
那么對(duì)于data字段是User時(shí)則可以寫為 Result<User> ,當(dāng)是個(gè)列表的時(shí)候?yàn)?Result<List<User>>，其它同理。
下面給個(gè)兩個(gè)完整的例子，User和List<User> 。

沒(méi)有引入泛型之前時(shí)寫法：

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;

上面有兩個(gè)類UserResult和UserListResult，有兩個(gè)字段重復(fù)，一兩個(gè)接口就算了，如果有上百個(gè)怎么辦?不得累死?所以引入泛型。

//不再重復(fù)定義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;
看出區(qū)別了么?引入了泛型之后雖然要多寫一句話用于獲取泛型信息，但是返回值類型很直觀，也少定義了很多無(wú)關(guān)類。