你真的會用Gson嗎?Gson使用指南(一)
JSON (官網) 是一種文字形式的資料交換格式,它比XML更輕量、比二進位制容易閱讀和編寫,調式也更加方便。其重要性不言而喻。解析和生成的方式很多,Java中最常用的類庫有:JSON-Java、Gson、Jackson、FastJson等。
該系列其它文章
注:此係列基於Gson 2.4。
本篇文章的主要內容:
- Gson的基本用法
- 屬性重新命名 @SerializedName 註解的使用
- Gson中使用泛型
一、Gson的基本用法
Gson提供了fromJson() 和toJson() 兩個直接用於解析和生成的方法,前者實現反序列化,後者實現了序列化。同時每個方法都提供了過載方法,我常用的總共有5個。
1. 基本資料型別的解析
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行有什麼不一樣沒
2. 基本資料型別的生成
Gson gson = new Gson();
String jsonNumber = gson.toJson(100); // 100
String jsonBoolean = gson.toJson(false); // false
String jsonString = gson.toJson("String"); //"String"
3. POJO類的生成與解析
public class User {
//省略其它
public String name;
public int age;
public String emailAddress;
}
3.1 生成JSON:
Gson gson = new Gson();
User user = new User("怪盜kidou",24);
String jsonObject = gson.toJson(user); // {"name":"怪盜kidou","age":24}
3.2 解析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":"[email protected]"}
實際
{"name":"怪盜kidou","age":24,"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":24,"emailAddress":"[email protected]"}
{"name":"怪盜kidou","age":24,"email_address":"[email protected]"}
{"name":"怪盜kidou","age":24,"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\":\"[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>>
,其它同理。