Java中Gson的使用詳解

更新時(shí)間：2019年12月13日 14:17:48 作者：【cosmo】

這篇文章主要介紹了Java中Gson的使用詳解，文中通過(guò)示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧

JSON 是一種文本形式的數(shù)據(jù)交換格式，它比XML更輕量、比二進(jìn)制容易閱讀和編寫(xiě)，調(diào)式也更加方便;解析和生成的方式很多，Java中最常用的類(lèi)庫(kù)有：JSON-Java、Gson、Jackson、FastJson等

一、Gson的基本用法

Gson提供了fromJson() 和toJson() 兩個(gè)直接用于解析和生成的方法，前者實(shí)現(xiàn)反序列化，后者實(shí)現(xiàn)了序列化；同時(shí)每個(gè)方法都提供了重載方法

（1）基本數(shù)據(jù)類(lèi)型的解析

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ù)類(lèi)型的生成　

Gson gson = new Gson();
String jsonNumber = gson.toJson(100);    // 100
String jsonBoolean = gson.toJson(false);  // false
String jsonString = gson.toJson("String"); //"String"

（3）POJO類(lèi)的生成與解析

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

期望的json格式：{"name":"張三","age":24,"emailAddress":"zhangsan@ceshi.com"}

實(shí)際：{"name":"張三","age":24,"email_address":"zhangsan@ceshi.com"}

Gson在序列化和反序列化時(shí)需要使用反射，一般各類(lèi)庫(kù)都將注解放到annotations包下，打開(kāi)源碼在com.google.gson包下有一個(gè)annotations，里面有一個(gè)SerializedName的注解類(lèi)。對(duì)于json中email_address這個(gè)屬性對(duì)應(yīng)POJO的屬性則變成：　

@SerializedName("email_address")
public String emailAddress;

為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\":\"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字符串?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ì)泛型的支持，所以將以上的數(shù)據(jù)解析為L(zhǎng)ist<String>時(shí)需要這樣寫(xiě)

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ì)寫(xiě)成new TypeToken<List<String>>() {}.getType() 而不是 new TypeToken<List<String>>().getType()

泛型解析對(duì)接口POJO的設(shè)計(jì)影響

泛型的引入可以減少無(wú)關(guān)的代碼：　　

{"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的類(lèi)型改成XX，很明顯code，和message被重復(fù)定義了多次，通過(guò)泛型可以將code和message字段抽取到一個(gè)Result的類(lèi)中，這樣只需要編寫(xiě)data字段所對(duì)應(yīng)的POJO即可：

public class Result<T> {
  public int code;
  public String message;
  public T data;
} 
//對(duì)于data字段是User時(shí)則可以寫(xiě)為 Result<User> ,當(dāng)是個(gè)列表的時(shí)候?yàn)?Result<List<User>>

四、Gson的流式反序列化

（1）自動(dòng)方式

Gson提供了fromJson()和toJson() 兩個(gè)直接用于解析和生成的方法，前者實(shí)現(xiàn)反序列化，后者實(shí)現(xiàn)了序列化。同時(shí)每個(gè)方法都提供了重載方法　　

Gson.toJson(Object);
Gson.fromJson(Reader,Class);
Gson.fromJson(String,Class);
Gson.fromJson(Reader,Type);
Gson.fromJson(String,Type);

(2)手動(dòng)方式：手動(dòng)的方式就是使用stream包下的JsonReader類(lèi)來(lái)手動(dòng)實(shí)現(xiàn)反序列化，和Android中使用pull解析XML是比較類(lèi)似的

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(); //自動(dòng)轉(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

自動(dòng)方式最終都是通過(guò)JsonReader來(lái)實(shí)現(xiàn)的，如果第一個(gè)參數(shù)是String類(lèi)型，那么Gson會(huì)創(chuàng)建一個(gè)StringReader轉(zhuǎn)換成流操作

五、Gson的流式序列化

（1）自動(dòng)方式

Gson.toJson方法列表

//PrintStream(System.out) 、StringBuilder、StringBuffer和*Writer都實(shí)現(xiàn)了Appendable接口。　　

Gson gson = new Gson();
User user = new User("張三",24,"zhangsan@ceshi.com");
gson.toJson(user,System.out);

(2)手動(dòng)方式

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，兩者可以相互嵌套，注意配對(duì)即可。beginArray后不可以調(diào)用name方法，同樣beginObject后在調(diào)用value之前必須要調(diào)用name方法。

六、使用GsonBuilder導(dǎo)出null值、格式化輸出、日期時(shí)間

一般情況下Gson類(lèi)提供的 API已經(jīng)能滿(mǎn)足大部分的使用場(chǎng)景，但有時(shí)需要更多特殊、強(qiáng)大的功能時(shí)，這時(shí)候就引入一個(gè)新的類(lèi) GsonBuilder。

GsonBuilder從名上也能知道是用于構(gòu)建Gson實(shí)例的一個(gè)類(lèi)，要想改變Gson默認(rèn)的設(shè)置必須使用該類(lèi)配置Gson

GsonBuilder用法：　

//各種配置 //生成配置好的Gson
Gson gson = new GsonBuilder().create();

（1）Gson在默認(rèn)情況下是不動(dòng)導(dǎo)出值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字段是沒(méi)有在json中出現(xiàn)的，當(dāng)在調(diào)試時(shí)需要導(dǎo)出完整的json串時(shí)或API接中要求沒(méi)有值必須用Null時(shí)，就會(huì)比較有用。

使用方法：

Gson gson = new GsonBuilder().serializeNulls() .create();
User user = new User("張三", 24);
System.out.println(gson.toJson(user)); //{"name":"張三","age":24,"email":null}

格式化輸出、日期時(shí)間及其它：

Gson gson = new GsonBuilder()
  //序列化null
  .serializeNulls()
  // 設(shè)置日期時(shí)間格式，另有2個(gè)重載方法
  // 在序列化和反序化時(shí)均生效
  .setDateFormat("yyyy-MM-dd")
  // 禁此序列化內(nèi)部類(lèi)
   .disableInnerClassSerialization()
  //生成不可執(zhí)行的Json（多了 )]}' 這4個(gè)字符）
  .generateNonExecutableJson()
   //禁止轉(zhuǎn)義html標(biāo)簽
  .disableHtmlEscaping()
  //格式化輸出
  .setPrettyPrinting()
  .create();
//：內(nèi)部類(lèi)(Inner Class)和嵌套類(lèi)(Nested Class)的區(qū)別

以上就是本文的全部?jī)?nèi)容，希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

您可能感興趣的文章: