Gson详解(一）
一.Gson說明
Gson（又稱Google Gson）是Google公司發布的一個開放源代碼的Java庫，主要用途為序列化Java對象為JSON字符串，或反序列化JSON字符串成Java對象。而JSON(JavaScriptObject Notation) 是一種輕量級的數據交換格式，易于人閱讀和編寫，同時也易于機器解析和生成，廣泛應用于各種數據的交互中，尤其是服務器與客戶端的交互。
引入依賴：
<!-- https://mvnrepository.com/artifact/com.google.code.gson/gson --> <dependency><groupId>com.google.code.gson</groupId><artifactId>gson</artifactId><version>2.8.5</version> </dependency>二.Gson使用
2.1Gson的創建
Gson的創建方式一：直接new Gson對象
// 使用new方法 Gson gson = new Gson();// toJson 將bean對象轉換為json字符串 String jsonStr = gson.toJson(user, User.class);// fromJson 將json字符串轉為bean對象 Student user= gson.fromJson(jsonStr, User.class);// 序列化List String jsonStr2 = gson.toJson(list);// 反序列化成List時需要使用到TypeToken getType() List<User> retList = gson.fromJson(jsonStr2,new TypeToken<List<User>>(){}.getType());//type的使用，User代表解析出來的Bean對象，result為后臺返回的json格式字符串， //List<UserBean>代表通過Gson按照type格式解析json格式字符串后返回的對象列表如：Type type = new TypeToken<List<User>>() {}.getType();List<UserBean> UserBeans = gson.fromJson(result, type);Gson的創建方式二：使用GsonBuilder
使用new Gson()，此時會創建一個帶有默認配置選項的Gson實例，如果不想使用默認配置，那么就可以使用GsonBuilder。
//serializeNulls()是GsonBuilder提供的一種配置，當字段值為空或null時，依然對該字段進行轉換 Gson gson = new GsonBuilder().serializeNulls().create();使用GsonBuilder創建Gson實例的步驟：
首先創建GsonBuilder,然后調用GsonBuilder提供的各種配置方法進行配置，
最后調用GsonBuilder的create方法，將基于當前的配置創建一個Gson實例。
GsonBuilder的一些配置：
Gson gson = new GsonBuilder().excludeFieldsWithoutExposeAnnotation() //不對沒有用@Expose注解的屬性進行操作.enableComplexMapKeySerialization() //當Map的key為復雜對象時,需要開啟該方法.serializeNulls() //當字段值為空或null時，依然對該字段進行轉換.setDateFormat("yyyy-MM-dd HH:mm:ss:SSS") //時間轉化為特定格式.setPrettyPrinting() //對結果進行格式化，增加換行.disableHtmlEscaping() //防止特殊字符出現亂碼.registerTypeAdapter(User.class,new UserAdapter()) //為某特定對象設置固定的序列或反序列方式，自定義Adapter需實現JsonSerializer或者JsonDeserializer接口.create();2.2Gson基本使用
Gson提供了fromJson() 和toJson() 兩個直接用于解析和生成的方法，前者實現反序列化，后者實現了序列化；同時每個方法都提供了重載方法
（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）基本數據類型的生成
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);*2.3屬性重命名 @SerializedName 注解的使用*
從上面POJO的生成與解析可以看出json的字段和值是的名稱和類型是一一對應的，但也有一定容錯機制(如第一個例子第3行將字符串的99.99轉成double型)，但有時候也會出現一些不和諧的情況，如：
期望的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數組
注：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\":\"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.com2.4Gson中使用泛型
例如：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.class 是不行的，對于Java來說List 和List 這倆個的字節碼文件只一個那就是List.class，這是Java泛型使用時要注意的問題 泛型擦除
為了解決的上面的問題，Gson提供了TypeToken來實現對泛型的支持，所以將以上的數據解析為List時需要這樣寫
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>>2.5Gson的流式反序列化
（1）自動方式
Gson提供了fromJson()和toJson() 兩個直接用于解析和生成的方法，前者實現反序列化，后者實現了序列化。同時每個方法都提供了重載方法
Gson.toJson(Object); Gson.fromJson(Reader,Class); Gson.fromJson(String,Class); Gson.fromJson(Reader,Type); Gson.fromJson(String,Type);(2)手動方式：手動的方式就是使用stream包下的JsonReader類來手動實現反序列化，和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(); //自動轉換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來實現的，如果第一個參數是String類型，那么Gson會創建一個StringReader轉換成流操作
*2.6Gson的流式序列化*
（1）自動方式
Gson.toJson方法列表
//PrintStream(System.out) 、StringBuilder、StringBuffer和*Writer都實現了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 IOExceptionwriter.flush(); // throws IOException //{"name":"張三","age":24,"email":null} //除了beginObject、endObject還有beginArray和endArray，兩者可以相互嵌套，注意配對即可。beginArray后不可以調用name方法，同樣beginObject后在調用value之前必須要調用name方法。2.7使用GsonBuilder導出null值、格式化輸出、日期時間
一般情況下Gson類提供的 API已經能滿足大部分的使用場景，但有時需要更多特殊、強大的功能時，這時候就引入一個新的類 GsonBuilder。
GsonBuilder從名上也能知道是用于構建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中出現的，當在調試時需要導出完整的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")// 禁此序列化內部類.disableInnerClassSerialization()//生成不可執行的Json（多了 )]}' 這4個字符）.generateNonExecutableJson()//禁止轉義html標簽.disableHtmlEscaping()//格式化輸出.setPrettyPrinting().create(); 創作挑戰賽新人創作獎勵來咯，堅持創作打卡瓜分現金大獎總結
- 上一篇： 第四范式亮相中关村论坛 共话科技创新与技
- 下一篇： 激发新型城市创新动能 第四范式分享智慧城