接口返回的JSON，再离谱也有办法，谈谈JSON容错！

GSON 提供了注解的方式&＃xff0c;来配置最简单的灵活性&＃xff0c;这里介绍两个注解 &＃64;SerializedName 和 &＃64;Expose。

&＃64;SerializedName 可以用来配置 JSON 字段的名字&＃xff0c;最常见的场景来自不同语言的命名方式不统一&＃xff0c;有些使用下划线分割&＃xff0c;有些使用驼峰命名法。

还是拿 User 类来举例&＃xff0c;Java 对象中定义的用户名称&＃xff0c;使用的是 userName&＃xff0c;而返回的 JSON 数据中&＃xff0c;用的是 user_name&＃xff0c;这样的差异就可以用 &＃64;SerializedName 来解决。

class User{&＃64;SerializedName("user_name")var userName :String? &＃61; nullvar gender &＃61; 0var age &＃61; 0
}


而在前文中&＃xff0c;针对同一个 User 对象中的用户名称&＃xff0c;现在不同的接口返回有差异&＃xff0c;分别为&＃xff1a;name、user_name、username&＃xff0c;这种差异也可以用 &＃64;SerializedName 来解决。

在 &＃64;SerializedName 中&＃xff0c;还有一个 alternate 字段&＃xff0c;可以对同一个字段配置多个解析名称。

class User{&＃64;SerializedName(value &＃61; "user_name",alternate &＃61; arrayOf("name","username"))var userName :String? &＃61; nullvar gender &＃61; 0var age &＃61; 0
}


再来看看 &＃64;Expose&＃xff0c;它是用来配置一些例外的字段。

在序列化和反序列化的过程中&＃xff0c;总有一些字段是和本地业务相关的&＃xff0c;并不需要从 JSON 中序列化出来&＃xff0c;也不需要在传递 JSON 数据的时候&＃xff0c;将其序列化。

这样的情况用 &＃64;Expose 就很好解决。从字面上理解&＃xff0c;将这个字段暴露出去&＃xff0c;就是参与序列化和反序列化。而一旦使用 &＃64;Expose&＃xff0c;那么常规的 new Gson() 的方式已经不适用了&＃xff0c;需要 GsonBuilder 配合.excludeFieldsWithoutExposeAnnotation() 方法使用。

&＃64;Expose 有两个配置项&＃xff0c;分别是 serialize 和 deserialize&＃xff0c;他们用于指定序列化和反序列化是否包含此字段&＃xff0c;默认值均为 True。

class User{&＃64;SerializedName(value &＃61; "user_name",alternate &＃61; arrayOf("name","username"))&＃64;Exposevar userName :String? &＃61; null&＃64;Exposevar gender &＃61; 0var age &＃61; 0&＃64;Expose(serialize &＃61; true,deserialize &＃61; false)var genderDesc &＃61; ""
}fun User.gsonTest(){// 序列化val user &＃61; User()user.userName &＃61; "Android开发架构"user.age &＃61; 18user.gender &＃61; 1user.genderDesc &＃61; "男"val gson &＃61; GsonBuilder().excludeFieldsWithoutExposeAnnotation().create()val jsonStr &＃61; gson.toJson(user)Log.i("cxmydev","json:$jsonStr")// json:{"gender":1,"genderDesc":"男","user_name":"承香墨影"}val newUser &＃61; gson.fromJson(jsonStr,User::class.java)Log.i("cxmydev","genderDesc:${newUser.genderDesc}")// genderDesc:
}


可以看到上面的例子中&＃xff0c;genderDesc 用于说明性别的描述&＃xff0c;使用&＃64;Expose(serialize &＃61; true,deserialize &＃61; false) 标记后&＃xff0c;这个字段只参与序列化(serialize &＃61; true)&＃xff0c;而不参与反序列化(deserialize &＃61; false)。

需要注意的是&＃xff0c;一旦开始使用 &＃64;Expose 后&＃xff0c;所有的字段都需要显式的标记是否“暴露”出来。上例中&＃xff0c;age 字段没有 &＃64;Expose 注解&＃xff0c;所以它在序列化和反序列化的时候&＃xff0c;均不会存在。

GSON 中的两个重要的字段注解&＃xff0c;就介绍完了&＃xff0c;正确的使用他们可以解决 80% 关于 GSON 解析数据的问题&＃xff0c;更灵活的使用方式&＃xff0c;就不是注解可以解决的了。

2.3 GsonBuilder 灵活解析

就像前面的例子中看到的一样&＃xff0c;想要构造一个 Gson 对象&＃xff0c;有两种方式&＃xff0c;new Gson() 和利用 GsonBuilder 构造。

这两种方式都可以构造一个 Gson 对象&＃xff0c;但是在这个 Builder 对象&＃xff0c;还提供一些快捷的方法&＃xff0c;方便我们更灵活的解析 JSON。

例如默认情况下&＃xff0c;GSON 是不会解析为 null 的字段的&＃xff0c;而我们可以通过.serializeNulls() 方法&＃xff0c;来让 GSON 序列化为 null 的字段。

// 序列化
val user &＃61; User()
user.age &＃61; 18
user.gender &＃61; 1val jsonStr &＃61; GsonBuilder().create().toJson(user)
Log.i("cxmydev","json:$jsonStr")
// json:{"age":18,"gender":1}val jsonStr1 &＃61; GsonBuilder().serializeNulls().create().toJson(user)
Log.i("cxmydev","json1:$jsonStr1")
// json1:{"age":18,"gender":1,"userName":null}


GsonBuilder 还提供了更多的操作&＃xff1a;

1. .serializeNulls() &＃xff1a;序列化为 null 的字段。

2. .setDateFormat()&＃xff1a;设置日期格式&＃xff0c;例如&＃xff1a;setDateFormat("yyyy-MM-dd")。

3. .disableInnerClassSerialization()&＃xff1a;禁止序列化内部类。

4. .generateNonExcutableJson()&＃xff1a;生成不可直接解析的 JSON&＃xff0c;会多 )]}&＃39; 这 4 个字符。

5. .disableHtmlEscaping()&＃xff1a;禁止转移 HTML 标签

6. .setPrettyPrinting()&＃xff1a;格式化输出

无论是注解还是 GsonBuilder 中提供的一些方法&＃xff0c;都是 GSON 针对一些特殊场景下&＃xff0c;为我们提供的便捷  API&＃xff0c;更复杂一些的场景&＃xff0c;就不是它们所能解决的了。

2.4 TypeAdapter

如果前面介绍的规则&＃xff0c;都满足不了业务了&＃xff0c;没关系&＃xff0c;Gson 还有大招&＃xff0c;就是使用 TypeAdapter。

这里讲的 TypeAdapter 是一个泛指&＃xff0c;它虽然确实是一个 GSON 库中的抽象类&＃xff0c;但在 GSON 的使用中&＃xff0c;它又不是一个类。

使用 TypeAdapter 就需要用到 GsonBuilder 类中的 registerTypeAdapter()&＃xff0c;我们先来看看这个类的方法实现。

public GsonBuilder registerTypeAdapter(Type type, Object typeAdapter) {$Gson$Preconditions.checkArgument(typeAdapter instanceof JsonSerializer|| typeAdapter instanceof JsonDeserializer|| typeAdapter instanceof InstanceCreator|| typeAdapter instanceof TypeAdapter);if (typeAdapter instanceof InstanceCreator) {instanceCreators.put(type, (InstanceCreator) typeAdapter);}if (typeAdapter instanceof JsonSerializer || typeAdapter instanceof JsonDeserializer) {TypeToken typeToken &＃61; TypeToken.get(type);factories.add(TreeTypeAdapter.newFactoryWithMatchRawType(typeToken, typeAdapter));}if (typeAdapter instanceof TypeAdapter) {factories.add(TypeAdapters.newFactory(TypeToken.get(type), (TypeAdapter)typeAdapter));}return this;}


可以看到注册方法&＃xff0c;需要制定一个数据类型&＃xff0c;并且它除了支持 TypeAdapter 之外&＃xff0c;还支持 JsonSerializer 和 JsonDeserializer。InstanceCreator 的使用场景太少了&＃xff0c;就不谈了。

TypeAdapter(抽象类)、JsonSerializer(接口)、JsonDeserializer(接口) 都可以理解成我们前面说的 TypeAdapter 的泛指&＃xff0c;他们具体有什么区别呢&＃xff1f;

TypeAdapter 中包含两个主要的方法 write() 和 read() 方法&＃xff0c;分别用于接管序列化和反序列化。而有时候&＃xff0c;我们并不需要处理这两种情况&＃xff0c;例如我们只关心 JSON 是如何反序列化成对象的&＃xff0c;那就只需要实现 JsonDeserializer 接口的 deserialize() 方法&＃xff0c;反之则实现 JsonSerializer 接口的 serialize() 方法&＃xff0c;这让我们的接管更灵活、更可控。

需要注意的是&＃xff0c;TypeAdapter 之所以称之为大招&＃xff0c;是因为它会导致前面介绍的所有配置都失效。但并不是使用了 TypeAdapter 之后&＃xff0c;所有的规则都需要我们自己实现。注意看 registerTypeAdapter() 方法的第一个参数是指定了类型的&＃xff0c;它只会针对某个具体的类型进行接管。

举个例子就清楚了&＃xff0c;例如前文中提到&＃xff0c;当一个 "" 的 JSON 字段&＃xff0c;碰上一个 Int 类型的字段时&＃xff0c;就会导致解析失败&＃xff0c;并抛出异常。

// 序列化
val user &＃61; User()
user.age &＃61; 18
user.gender &＃61; 1val jsonStr &＃61; "{\"gender\":\"\",\"user_name\":\"Android开发架构\"}"val newUser &＃61; GsonBuilder().create().fromJson(jsonStr,User::class.java)
Log.i("cxmydev","gender:${gender}")


在上面的例子中&＃xff0c;gender 字段应该是一个 Int 值&＃xff0c;而 JSON 字符串中的gender 为 ""&＃xff0c;这样的代码&＃xff0c;跑起来会抛JsonSyntaxException: java.lang.NumberFormatException: empty String 异常。

我们实现 JsonDeserializer 接口&＃xff0c;来接管反序列化的操作。

class IntegerDefault0Adapter : JsonDeserializer {override fun deserialize(json: JsonElement?, typeOfT: Type?, context: JsonDeserializationContext?): Int {try {return json!!.getAsInt()} catch (e: NumberFormatException) {return 0}}
}


当转 Int 出现异常时&＃xff0c;返回默认值 0。然后使用 registerTypeAdapter() 方法加入其中。

val newUser &＃61; GsonBuilder().registerTypeAdapter(Int::class.java, IntegerDefault0Adapter()).create().fromJson(jsonStr,User::class.java)
Log.i("cxmydev","gender : ${newUser.gender}")
// gender : 0


TypeAdapter 的使用&＃xff0c;到这里就介绍完了&＃xff0c;这个大招只要放出来&＃xff0c;所有 JSON 解析的问题都不再是问题。TypeAdapter 的适用场景还很多&＃xff0c;可以根据具体的需求具体实现&＃xff0c;这里就不再过多介绍了。

另外再补充几个 TypeAdapter 的细节。

1. registerTypeHierarchyAdapter() 的区别

看看源码&＃xff0c;细心的朋友应该发现了&＃xff0c;注册 TypeAdapter 的时候&＃xff0c;还有registerTypeHierarchyAdapter() 方法&＃xff0c;它和 registerTypeAdapter() 方法有什么区别呢&＃xff1f;

区别就在于&＃xff0c;接管的类型类&＃xff0c;是否支持继承。例如前面例子中&＃xff0c;我们只接管了 Int 类型&＃xff0c;而数字类型还有其他的例如 Long、Float、Double 等并不会命中到。那假如我们注册的是这些数字类型的父类 Number 呢&＃xff1f;使用 registerTypeAdapter() 也不会被命中&＃xff0c;因为类型不匹配。

此时就可以使用 registerTypeHierarchyAdapter() 方法来注册&＃xff0c;它是支持继承的。

2. TypeAdapterFactory 工厂类的使用

使用 registerXxx() 方法可以链式调用&＃xff0c;注册各种 Adapter。

如果嫌麻烦&＃xff0c;还可以使用 TypeAdapterFacetory 这个 Adapter 工厂&＃xff0c;配合registerTypeAdapterFactory() 方法&＃xff0c;根据类型来返回不同的 Adapter。

其实只是换个了实现方式&＃xff0c;并没有什么太大的区别。

3. &＃64;JsonAdapter 注解

&＃64;JsonAdapter 和前面介绍的 &＃64;SerializedName、&＃64;Expose 不同&＃xff0c;不是作用在字段上&＃xff0c;而是作用在 Java 类上的。

它指定一个“Adapter” 类&＃xff0c;可以是 TypeAdapter、JsonSerializer 和 JsonDeserializer 这三个中的一个。

&＃64;JsonAdapter 注解只是一个更灵活的配置方式而已&＃xff0c;了解一下即可。

三、小结时刻

GSON 很好用&＃xff0c;但是也是建立在使用正确的基础上。我见识过一些丑陋的代码&＃xff0c;例如多字段场景下&＃xff0c;也在 Java 对象中配套写上多个字段&＃xff0c;再增加一个方法用于返回多个字段中不会 null 的字段。又或者为了一个 JSON 数据返回的格式&＃xff0c;和后端开发“沟通”一下午规范的问题。

坚持规范当然没有错&＃xff0c;但是因为别人的问题导致自己的工作无法继续&＃xff0c;就不符合精益思维了。

不抽象&＃xff0c;就无法深入思考&＃xff0c;我们还是就今天的内容做一个简单的小结。

1. GSON 可以提供了 toJson() 和 fromJson() 两个简便的方法序列化和反序列化 JSON 数据。

2. 通过注解 &＃64;SerializedName 可以解决解析字段不一致的问题以及多字段的问题。

3. 通过注解 &＃64;Expose 可以解决字段在序列化和反序列化时&＃xff0c;字段排除的问题。

4. GsonBuilder 提供了一些便捷的 API&＃xff0c;方便我们解析数据&＃xff0c;例如

5. 更灵活的解析&＃xff0c;使用 TypeAdapter&＃xff0c;可以精准定制序列化和反序列化的全过程。

就总结五条吧&＃xff0c;多了也记不住。