Java中Gson的使用詳解
JSON 是一種文本形式的數(shù)據(jù)交換格式，它比XML更輕量、比二進制容易閱讀和編寫，調(diào)式也更加方便;解析和生成的方式很多，Java中最常用的類庫有：JSON-Java、Gson、Jackson、FastJson等
一、Gson的基本用法
Gson提供了fromJson() 和toJson() 兩個直接用于解析和生成的方法，前者實現(xiàn)反序列化，后者實現(xiàn)了序列化；同時每個方法都提供了重載方法
（1）基本數(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）基本數(shù)據(jù)類型的生成
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;
}
生成JSON：
Gson gson = new Gson();
User user = new User("張三",24);
String jsonObject = gson.toJson(user); // {"name":"張三kidou","age":24}
解析JSON：
Gson gson = new Gson();
String jsonString = "{\"name\":\"張三\",\"age\":24}";
User user = gson.fromJson(jsonString, User.class);
二、屬性重命名 @SerializedName 注解的使用
從上面POJO的生成與解析可以看出json的字段和值是的名稱和類型是一一對應的，但也有一定容錯機制(如第一個例子第3行將字符串的99.99轉(zhuǎn)成double型)，但有時候也會出現(xiàn)一些不和諧的情況，如：
期望的json格式：{"name":"張三","age":24,"emailAddress":"zhangsan@ceshi.com"}
實際：{"name":"張三","age":24,"email_address":"zhangsan@ceshi.com"}
Gson在序列化和反序列化時需要使用反射，一般各類庫都將注解放到annotations包下，打開源碼在com.google.gson包下有一個annotations，里面有一個SerializedName的注解類。對于json中email_address這個屬性對應POJO的屬性則變成：
@SerializedName("email_address")
public String emailAddress;
為POJO字段提供備選屬性名：SerializedName注解提供了兩個屬性，上面用到了其中一個，別外還有一個屬性alternate，接收一個String數(shù)組
注：alternate需要2.4版本
@SerializedName(value = "emailAddress", alternate = {"email", "email_address"})
public String emailAddress;
//當三個屬性(email_address、email、emailAddress)都中出現(xiàn)任意一個時均可以得到正確的結(jié)果
//當多種情況同時出時，以最后一個出現(xiàn)的值為準。
Gson gson = new Gson();
String json = "{\"name\":\"張三kidou\",\"age\":24,\"emailAddress\":\"zhangsan@ceshi.com\",\"email\":\"zhangsan_2@ceshi.com\",\"email_address\":\"zhangsan_3@ceshi.com\"}";
User user = gson.fromJson(json, User.class);
System.out.println(user.emailAddress); // zhangsan_3@example.com
三、Gson中使用泛型
例如：JSON字符串數(shù)組：["Android","Java","PHP"]
當要通過Gson解析這個json時，一般有兩種方式：使用數(shù)組，使用List；而List對于增刪都是比較方便的，所以實際使用是還是List比較多
數(shù)組比較簡單：
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> 這倆個的字節(jié)碼文件只一個那就是List.class，這是Java泛型使用時要注意的問題 泛型擦除
為了解決的上面的問題，Gson提供了TypeToken來實現(xiàn)對泛型的支持，所以將以上的數(shù)據(jù)解析為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的構(gòu)造方法是protected修飾的,所以上面才會寫成new TypeToken<List<String>>() {}.getType() 而不是 new TypeToken<List<String>>().getType()
泛型解析對接口POJO的設計影響
泛型的引入可以減少無關的代碼：
{"code":"0","message":"success","data":{}}
{"code":"0","message":"success","data":[]}
我們真正需要的data所包含的數(shù)據(jù)，而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的流式反序列化
（1）自動方式
Gson提供了fromJson()和toJson() 兩個直接用于解析和生成的方法，前者實現(xiàn)反序列化，后者實現(xiàn)了序列化。同時每個方法都提供了重載方法
Gson.toJson(Object); Gson.fromJson(Reader,Class); Gson.fromJson(String,Class); Gson.fromJson(Reader,Type); Gson.fromJson(String,Type);
(2)手動方式：手動的方式就是使用stream包下的JsonReader類來手動實現(xiàn)反序列化，和Android中使用pull解析XML是比較類似的
String json = "{\"name\":\"張三\",\"age\":\"24\"}";
User user = new User();
JsonReader reader = new JsonReader(new StringReader(json));
reader.beginObject();
while (reader.hasNext()) {
String s = reader.nextName();
switch (s) {
case "name":
user.name = reader.nextString();
break;
case "age":
user.age = reader.nextInt(); //自動轉(zhuǎn)換
break;
case "email":
user.email = reader.nextString();
break;
}
}
reader.endObject(); // throws IOException
System.out.println(user.name); //張三
System.out.println(user.age); // 24
System.out.println(user.email); //zhangsan@ceshi.com
自動方式最終都是通過JsonReader來實現(xiàn)的，如果第一個參數(shù)是String類型，那么Gson會創(chuàng)建一個StringReader轉(zhuǎn)換成流操作
五、Gson的流式序列化
（1）自動方式
Gson.toJson方法列表
//PrintStream(System.out) 、StringBuilder、StringBuffer和*Writer都實現(xiàn)了Appendable接口?！ ?
Gson gson = new Gson();
User user = new User("張三",24,"zhangsan@ceshi.com");
gson.toJson(user,System.out);
(2)手動方式
JsonWriter writer = new JsonWriter(new OutputStreamWriter(System.out));
writer.beginObject() // throws IOException
.name("name").value("張三")
.name("age").value(24)
.name("email").nullValue() //演示null
.endObject(); // throws IOException
writer.flush(); // throws IOException
//{"name":"張三","age":24,"email":null}
//除了beginObject、endObject還有beginArray和endArray，兩者可以相互嵌套，注意配對即可。beginArray后不可以調(diào)用name方法，同樣beginObject后在調(diào)用value之前必須要調(diào)用name方法。
六、 使用GsonBuilder導出null值、格式化輸出、日期時間
一般情況下Gson類提供的 API已經(jīng)能滿足大部分的使用場景，但有時需要更多特殊、強大的功能時，這時候就引入一個新的類 GsonBuilder。
GsonBuilder從名上也能知道是用于構(gòu)建Gson實例的一個類，要想改變Gson默認的設置必須使用該類配置Gson
GsonBuilder用法：
//各種配置 //生成配置好的Gson Gson gson = new GsonBuilder().create();
（1）Gson在默認情況下是不動導出值null的鍵的，如：
public class User {
public String name;
public int age;
//省略
public String email;
}
Gson gson = new Gson();
User user = new User(張三",24);
System.out.println(gson.toJson(user)); //{"name":"張三","age":24}
//email字段是沒有在json中出現(xiàn)的，當在調(diào)試時需要導出完整的json串時或API接中要求沒有值必須用Null時，就會比較有用。
使用方法：
Gson gson = new GsonBuilder().serializeNulls() .create();
User user = new User("張三", 24);
System.out.println(gson.toJson(user)); //{"name":"張三","age":24,"email":null}
格式化輸出、日期時間及其它：
Gson gson = new GsonBuilder()
//序列化null
.serializeNulls()
// 設置日期時間格式，另有2個重載方法
// 在序列化和反序化時均生效
.setDateFormat("yyyy-MM-dd")
// 禁此序列化內(nèi)部類
.disableInnerClassSerialization()
//生成不可執(zhí)行的Json（多了 )]}' 這4個字符）
.generateNonExecutableJson()
//禁止轉(zhuǎn)義html標簽
.disableHtmlEscaping()
//格式化輸出
.setPrettyPrinting()
.create();
//：內(nèi)部類(Inner Class)和嵌套類(Nested Class)的區(qū)別
以上就是本文的全部內(nèi)容，希望對大家的學習有所幫助，也希望大家多多支持腳本之家。
相關文章
詳解使用IntelliJ IDEA新建Java Web后端resfulAPI模板
這篇文章主要介紹了詳解使用IntelliJ IDEA新建Java Web后端resfulAPI模板，小編覺得挺不錯的，現(xiàn)在分享給大家，也給大家做個參考。一起跟隨小編過來看看吧2018-08-08
protobuf對象不能直接使用jsonlib去轉(zhuǎn)，因為protobuf生成的對象的get方法返回的類型有byte[]，而只有String類型可以作為json的key，protobuf提供方法進行轉(zhuǎn)換2017-07-07
本文主要介紹了java構(gòu)造http請求的幾種方式，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2023-02-02
這篇文章主要介紹了Java 使用Docker時經(jīng)常遇到的五個問題的相關資料,需要的朋友可以參考下2016-10-10
如何解決 Java 中的 IndexOutOfBoundsException 異
當我們在 Java 中使用 List 的時候,有時候會出現(xiàn)向 List 中不存在的位置設置新元素的情況,從而導致 IndexOutOfBoundsException 異常,本文將會介紹這個問題的產(chǎn)生原因以及解決方案2023-10-10
這篇文章主要為大家詳細介紹了JS+Struts2多文件上傳實例，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-08-08
這篇文章主要介紹了Mac下如何查看已安裝的jdk版本及其安裝目錄問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-11-11
JAVA編程實現(xiàn)TCP網(wǎng)絡通訊的方法示例
這篇文章主要介紹了JAVA編程實現(xiàn)TCP網(wǎng)絡通訊的方法,簡單說明了TCP通訊的原理并結(jié)合具體實例形式分析了java實現(xiàn)TCP通訊的步驟與相關操作技巧,需要的朋友可以參考下2017-08-08
Mybatis工具類JdbcTypeInterceptor運行時自動添加jdbcType屬性
今天小編就為大家分享一篇關于Mybatis工具類JdbcTypeInterceptor運行時自動添加jdbcType屬性，小編覺得內(nèi)容挺不錯的，現(xiàn)在分享給大家，具有很好的參考價值，需要的朋友一起跟隨小編來看看吧2018-12-12
springboot使用TaskScheduler實現(xiàn)動態(tài)增刪啟停定時任務方式
這篇文章主要介紹了springboot使用TaskScheduler實現(xiàn)動態(tài)增刪啟停定時任務方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-08-08