轉(zhuǎn)自：http://www.itdecent.cn/p/3108f1e44155?nomobile=yes
該系列其它文章
注：此系列基于Gson 2.4。
本次文章的主要內(nèi)容：
TypeAdapter
JsonSerializer與JsonDeserializer
TypeAdapterFactory
@JsonAdapter注解
TypeAdapter與 JsonSerializer、JsonDeserializer對比
TypeAdapter實例
結(jié)語
后期預(yù)告
一、TypeAdapter
TypeAdapter是Gson自2.0（源碼注釋上說的是2.1）開始版本提供的一個抽象類，用于接管某種類型的序列化和反序列化過程，包含兩個注要方法write(JsonWriter,T)和read(JsonReader)其它的方法都是final方法并最終調(diào)用這兩個抽象方法。
publicabstractclassTypeAdapter{publicabstractvoidwrite(JsonWriter out, T value)throwsIOException;publicabstractTread(JsonReader in)throwsIOException;//其它final 方法就不貼出來了，包括`toJson`、`toJsonTree`、`toJson`和`nullSafe`方法。}
注意：TypeAdapter 以及 JsonSerializer 和 JsonDeserializer 都需要與GsonBuilder.registerTypeAdapter示或GsonBuilder.registerTypeHierarchyAdapter配合使用，下面將不再重復(fù)說明。
使用示例：
User user =newUser("怪盜kidou",24);user.emailAddress ="ikidou@example.com";Gson gson =newGsonBuilder()//為User注冊TypeAdapter.registerTypeAdapter(User.class,newUserTypeAdapter())? ? ? ? .create();System.out.println(gson.toJson(user));
UserTypeAdapter的定義：
publicclassUserTypeAdapterextendsTypeAdapter{@Overridepublicvoidwrite(JsonWriter out, User value)throwsIOException{? ? ? ? out.beginObject();? ? ? ? out.name("name").value(value.name);? ? ? ? out.name("age").value(value.age);? ? ? ? out.name("email").value(value.email);? ? ? ? out.endObject();? ? }@OverridepublicUserread(JsonReader in)throwsIOException{? ? ? ? User user =newUser();? ? ? ? in.beginObject();while(in.hasNext()) {switch(in.nextName()) {case"name":? ? ? ? ? ? ? ? ? ? user.name = in.nextString();break;case"age":? ? ? ? ? ? ? ? ? ? user.age = in.nextInt();break;case"email":case"email_address":case"emailAddress":? ? ? ? ? ? ? ? ? ? user.email = in.nextString();break;? ? ? ? ? ? }? ? ? ? }? ? ? ? in.endObject();returnuser;? ? }}
當(dāng)我們?yōu)閁ser.class注冊了TypeAdapter之后，只要是操作User.class那些之前介紹的@SerializedName、FieldNamingStrategy、Since、Until、Expos通通都黯然失色，失去了效果，只會調(diào)用我們實現(xiàn)的UserTypeAdapter.write(JsonWriter, User)方法，我想怎么寫就怎么寫。
再說一個場景，在該系列的第一篇文章就說到了Gson有一定的容錯機(jī)制，比如將字符串"24"轉(zhuǎn)成int 的24,但如果有些情況下給你返了個空字符串怎么辦（有人給我評論問到這個問題）?雖然這是服務(wù)器端的問題，但這里我們只是做一個示范。
int型會出錯是吧，根據(jù)我們上面介紹的，我注冊一個TypeAdapter 把 序列化和反序列化的過程接管不就行了?
Gson gson =newGsonBuilder()? ? ? ? .registerTypeAdapter(Integer.class,newTypeAdapter() {@Overridepublicvoidwrite(JsonWriter out, Integer value)throwsIOException{? ? ? ? ? ? ? ? out.value(String.valueOf(value));? ? ? ? ? ? }@OverridepublicIntegerread(JsonReader in)throwsIOException{try{returnInteger.parseInt(in.nextString());? ? ? ? ? ? ? ? }catch(NumberFormatException e) {return-1;? ? ? ? ? ? ? ? }? ? ? ? ? ? }? ? ? ? })? ? ? ? .create();System.out.println(gson.toJson(100));// 結(jié)果："100"System.out.println(gson.fromJson("\"\"",Integer.class));// 結(jié)果：-1
注：測試空串的時候一定是"\"\""而不是""，""代表的是沒有json串，"\"\""才代表json里的""。
你說這一接管就要管兩樣好麻煩呀，我明明只想管序列化（或反列化）的過程的，另一個過程我并不關(guān)心，難道沒有其它更簡單的方法么? 當(dāng)然有！就是接下來要介紹的JsonSerializer與JsonDeserializer。
二、JsonSerializer與JsonDeserializer
JsonSerializer和JsonDeserializer不用像TypeAdapter一樣，必須要實現(xiàn)序列化和反序列化的過程，你可以據(jù)需要選擇，如只接管序列化的過程就用JsonSerializer，只接管反序列化的過程就用JsonDeserializer，如上面的需求可以用下面的代碼。
Gson gson =newGsonBuilder()? ? ? ? .registerTypeAdapter(Integer.class,newJsonDeserializer() {? ? ? ? ? ? @OverridepublicIntegerdeserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context)throws JsonParseException{try{returnjson.getAsInt();? ? ? ? ? ? ? ? }catch(NumberFormatException e) {return-1;? ? ? ? ? ? ? ? }? ? ? ? ? ? }? ? ? ? })? ? ? ? .create();System.out.println(gson.toJson(100));//結(jié)果：100System.out.println(gson.fromJson("\"\"", Integer.class));//結(jié)果-1
下面是所有數(shù)字都轉(zhuǎn)成序列化為字符串的例子
JsonSerializer numberJsonSerializer =newJsonSerializer() {@OverridepublicJsonElementserialize(Number src, Type typeOfSrc, JsonSerializationContext context){returnnewJsonPrimitive(String.valueOf(src));? ? }};Gson gson =newGsonBuilder()? ? ? ? .registerTypeAdapter(Integer.class, numberJsonSerializer)? ? ? ? .registerTypeAdapter(Long.class, numberJsonSerializer)? ? ? ? .registerTypeAdapter(Float.class, numberJsonSerializer)? ? ? ? .registerTypeAdapter(Double.class, numberJsonSerializer)? ? ? ? .create();System.out.println(gson.toJson(100.0f));//結(jié)果："100.0"
注：registerTypeAdapter必須使用包裝類型，所以int.class,long.class,float.class和double.class是行不通的。同時不能使用父類來替上面的子類型，這也是為什么要分別注冊而不直接使用Number.class的原因。
上面特別說明了registerTypeAdapter不行，那就是有其它方法可行咯?當(dāng)然！換成registerTypeHierarchyAdapter就可以使用Number.class而不用一個一個的當(dāng)獨(dú)注冊啦！
registerTypeAdapter與registerTypeHierarchyAdapter的區(qū)別：
registerTypeAdapterregisterTypeHierarchyAdapter
支持泛型是否
支持繼承否是
注：如果一個被序列化的對象本身就帶有泛型，且注冊了相應(yīng)的TypeAdapter，那么必須調(diào)用Gson.toJson(Object,Type)，明確告訴Gson對象的類型。
Type type =newTypeToken>() {}.getType();TypeAdapter typeAdapter =newTypeAdapter>() {//略};Gson gson =newGsonBuilder()? ? ? ? .registerTypeAdapter(type, typeAdapter)? ? ? ? .create();List list =newArrayList<>();list.add(newUser("a",11));list.add(newUser("b",22));//注意，多了個type參數(shù)String result = gson.toJson(list, type);
三、TypeAdapterFactory
TypeAdapterFactory,見名知意，用于創(chuàng)建TypeAdapter的工廠類，通過對比Type，確定有沒有對應(yīng)的TypeAdapter，沒有就返回null，與GsonBuilder.registerTypeAdapterFactory配合使用。
Gsongson =newGsonBuilder()? ? .registerTypeAdapterFactory(newTypeAdapterFactory() {@Overridepublic TypeAdapter create(Gsongson,TypeTokentype) {returnnull;? ? ? ? }? ? })? ? .create();
四、@JsonAdapter注解
JsonAdapter相較之前介紹的SerializedName、FieldNamingStrategy、Since、Until、Expos這幾個注解都是比較特殊的，其它的幾個都是用在POJO的字段上，而這一個是用在POJO類上的，接收一個參數(shù)，且必須是TypeAdpater，JsonSerializer或JsonDeserializer這三個其中之一。
上面說JsonSerializer和JsonDeserializer都要配合GsonBuilder.registerTypeAdapter使用，但每次使用都要注冊也太麻煩了，JsonAdapter就是為了解決這個痛點(diǎn)的。
使用方法（以User為例）：
@JsonAdapter(UserTypeAdapter.class)//加在類上publicclassUser{publicUser(){? ? }publicUser(String name,intage){this.name = name;this.age = age;? ? }publicUser(String name,intage, String email){this.name = name;this.age = age;this.email = email;? ? }publicString name;publicintage;@SerializedName(value ="emailAddress")publicString email;}
使用時不用再使用GsonBuilder去注冊UserTypeAdapter了。
注：@JsonAdapter僅支持TypeAdapter或TypeAdapterFactory
Gson gson =newGson();User user =newUser("怪盜kidou",24,"ikidou@example.com");System.out.println(gson.toJson(user));//結(jié)果：{"name":"怪盜kidou","age":24,"email":"ikidou@example.com"}//為區(qū)別結(jié)果，特意把email字段與@SerializedName注解中設(shè)置的不一樣
注意：JsonAdapter的優(yōu)先級比GsonBuilder.registerTypeAdapter的優(yōu)先級更高。
五、TypeAdapter與 JsonSerializer、JsonDeserializer對比
TypeAdapterJsonSerializer、JsonDeserializer
引入版本2.01.x
Stream API支持不支持*，需要提前生成JsonElement
內(nèi)存占用小比TypeAdapter大
效率高比TypeAdapter低
作用范圍序列化和反序列化序列化或反序列化
六、TypeAdapter實例
注：這里的TypeAdapter泛指TypeAdapter、JsonSerializer和JsonDeserializer。
這里的TypeAdapter 上面講了一個自動將 字符串形式的數(shù)值轉(zhuǎn)換成int型時可能出現(xiàn) 空字符串的問題，下面介紹一個其它讀者的需求：
服務(wù)器返回的數(shù)據(jù)中data字段類型不固定，比如請求成功data是一個List,不成功的時候是String類型，這樣前端在使用泛型解析的時候，怎么去處理呢？
其實這個問題的原因主要由服務(wù)器端造成的，接口設(shè)計時沒有沒有保證數(shù)據(jù)的一致性，正確的數(shù)據(jù)返回姿勢：同一個接口任何情況下不得改變返回類型，要么就不要返，要么就返空值，如null、[],{}。
但這里還是給出解決方案：
方案一：
Gson gson =newGsonBuilder().registerTypeHierarchyAdapter(List.class,newJsonDeserializer>() {? ? @OverridepublicList deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {if(json.isJsonArray()){//這里要自己負(fù)責(zé)解析了Gson newGson =newGson();returnnewGson.fromJson(json,typeOfT);? ? ? ? }else{//和接口類型不符，返回空ListreturnCollections.EMPTY_LIST;? ? ? ? }? ? }}).create();
方案二：
Gson gson =newGsonBuilder().registerTypeHierarchyAdapter(List.class,newJsonDeserializer>() {? ? @OverridepublicList deserialize(JsonElement json, Type typeOfT, JsonDeserializationContext context) throws JsonParseException {if(json.isJsonArray()) {? ? ? ? ? ? JsonArrayarray= json.getAsJsonArray();? ? ? ? ? ? Type itemType = ((ParameterizedType) typeOfT).getActualTypeArguments()[0];Listlist=newArrayList<>();for(int i =0; i
要注意的點(diǎn)：
必須使用registerTypeHierarchyAdapter方法，不然對List的子類無效，但如果POJO中都是使用List，那么可以使用registerTypeAdapter。
對于是數(shù)組的情況，需要創(chuàng)建一個新的Gson，不可以直接使用context,不然gson又會調(diào)我們自定義的JsonDeserializer造成遞歸調(diào)用，方案二沒有重新創(chuàng)建Gson，那么就需要提取出List中E的類型，然后分別反序列化適合為E手動注冊了TypeAdaper的情況。
從效率上推薦方案二，免去重新實例化Gson和注冊其它TypeAdapter的過程。
結(jié)語
Gson系列總算是完成了，感覺寫得越來越差了，我怕我寫得太啰嗦，也不能總是大片大片的貼代碼，所以可能有的地方寫得并不詳細(xì)，排版也不美觀，但都些都不重點(diǎn)，重點(diǎn)是Gson里我們能用上的都一一介紹一遍，只要你確確實實把我這幾篇文章上的內(nèi)容都學(xué)會的話，以后Gson上的任何問題都不再是問題，當(dāng)然可能很多內(nèi)容對于實際的開發(fā)中用的并不多，但下次有什么疑難雜癥就難不倒你了。
本系列不提供Demo源碼，最重要的是自己實驗。
寫一篇文章還是要花不少時間和精力，要寫示例、調(diào)式、組織語言、碼字等等，加上關(guān)注的人在慢慢的增加的同時既給了我動力也給我不少壓力，如有紕漏或者更好的例子都可以和我交流。
后期預(yù)告：
之前有人給我評論說 出一點(diǎn) retrofit 相關(guān)內(nèi)容，我想了想，出是會出，但在此之前我想先出大概3～4篇文章用于介紹泛型、反射、注解和HTTP的相關(guān)內(nèi)容，當(dāng)你確實掌握之后，我打包票你只需要看一遍Retrofit官方教程的代碼示例，都不用看其它英文說明，就可以輕松玩轉(zhuǎn)Retrofit。不服來戰(zhàn)！
文／怪盜kidou（簡書作者）
原文鏈接：http://www.itdecent.cn/p/3108f1e44155
著作權(quán)歸作者所有，轉(zhuǎn)載請聯(lián)系作者獲得授權(quán)，并標(biāo)注“簡書作者”。
