Gson 解析 Json 容错才是关键,举几个常用的实例!,android 开发视频百度网盘
{"name":"承香墨影","age":18 // "age":"18"}
那假如服务端说,这个用户没有填年龄的信息,所以直接返回了一个空串 ""
,那这个时候客户端用 Gson 解析就悲剧了。
这当然是服务端的问题,如果数据明确为 Int 类型,那么就算是默认值也应该是 0 或者 -1。
但遇到这样的情况,你还用默认的 GSON 策略去解析,你将得到一个 Crash。
Caused by: com.google.gson.JsonSyntaxException:
java.lang.NumberFormatException:-- empty String
没有一点意外也没有一点惊喜的 Crash 了,那接下来看看如何解决这样的数据容错问题?
因为这里的场景中,只需要反序列化的操作,所以我们实现 JsonDeserializer 接口即可,接管的是 Int 类型。直接上例子吧。
class IntDefaut0Adapter : JsonDeserializer<Int> {override fun deserialize(json: JsonElement?,typeOfT: Type?,context: JsonDeserializationContext?): Int {if (json?.getAsString().equals("")) {return 0}try {return json!!.getAsInt()} catch (e: NumberFormatException) {return 0}}}
fun intDefault0(){val jsonStr = """{"name":"承香墨影","age":""}""".trimIndent()val user = GsonBuilder().registerTypeAdapter(Int::class.java,IntDefaut0Adapter()).create().fromJson<User>(jsonStr,User::class.java)Log.i("cxmydev","user: ${user.toString()}")}
在 IntDefaut0Adapter 中,首先判断数据字符串是否为空字符串 ""
,如果是则直接返回 0,否则将其按 Int 类型解析。在这个例子中,将整型 0 作为一个异常参数进行处理。
2.3 null、[]、List 转 List
还有一些小伙伴比较关心的,对于 JSONObject 和 JSONArray 兼容的问题。
例如需要返回一个 List,翻译成 JSON 数据就应该是方括号 []
包裹的 JSONArray。但是在列表为空的时候,服务端返回的数据,什么情况都有可能。
{"name":"承香墨影","languages":["EN","CN"] // 理想的数据// "languages":""// "languages":null// "languages":{}}
例子的 JSON 中,languages
字段表示当前用户所掌握的语言。当语言字段没有被设置的时候,服务端返回的数据不一致,如何兼容呢?
我们在原本的 User 类中,增加一个 languages 的字段,类型为 ArrayList。
var languages = ArrayList<String>()
在 Java 中,列表集合都会实现 List 接口,所以我们在实现 JsonDeserializer 的时候,解析拦截的应该是 List。
在这个情况下,可以使用 JsonElement 的 isJsonArray()
方法,判断当前是否是一个合法的 JSONArray 的数组,一旦不正确,就直接返回一个空的集合即可。
class ArraySecurityAdapter:JsonDeserializer<List<>>{override fun deserialize(json: JsonElement, typeOfT: Type?, context: JsonDeserializationContext?): List<> {
if(json.isJsonArray()){val newGson = Gson()return newGson.fromJson(json, typeOfT)}else{return Collections.EMPTY_LIST}}}
fun listDefaultEmpty(){val jsonStr = """{"name":"承香墨影","age":"18","languages":{}}""".trimIndent()val user = GsonBuilder().registerTypeHierarchyAdapter(List::class.java,ArraySecurityAdapter()).create().fromJson<User>(jsonStr,User::class.java)Log.i("cxmydev","user: ${user.toString()}")}
其核心就是 isJsonArray()
方法,判断当前是否是一个 JSONArray,如果是,再具体解析即可。到这一步就很灵活了,你可以直接用 Gson 将数据反序列化成一个 List,也可以将通过一个 for 循环将其中的每一项单独反序列化。
需要注意的是,如果依然想用 Gson 来解析,需要重新创建一个新的 Gson 对象,不可以直接复用 JsonDeserializationContext,否则会造成递归调用。
另外还有一个细节,在这个例子中,调用的是 registerTypeHierarchyAdapter()
方法来注册 TypeAdapter,它和我们前面介绍的 registerTypeAdapter()
有什么区别呢?
通常我们会根据不同的场景,选择不同数据结构实现的集合类,例如 ArrayList 或者 LinkedList。但是 registerTypeAdapter()
方法,要求我们传递一个明确的类型,也就是说它不支持继承,而 registerTypeHierarchyAdapter()
则可以支持继承。
我们想用 List 来替代所有的 List 子类,就需要使用 registerTypeHierarchyAdapter()
方法,或者我们的 Java Bean 中,只使用 List。这两种情况都是可以的。
2.4 保留原 Json 字符串
看到这个小标题,可能会有疑问,保留原 Json 字符串是一个什么情况?得到的 Json 数据,本身就是一个字符串,且挺我细细说来。
举个例子,前面定义的 User 类,需要存到 SQLite 数据库中,语言(languages)字段也是需要存储的。说到 SQLite,当然优先使用一些开源的 ORM 框架了,而不少优秀的 ORM-SQLite 框架,都通过外键的形式支持了一对多的存储。例如一篇文章对应多条评论,一条用户信息对应对应多条语言信息。
这种场景下我们当然可以使用 ORM 框架本身提供的一对多的存储形式。但是如果像现在的例子中,只是简单的存储一些有
限的数据,例如用户会的语言(languages),这种简单的有限数据,用外键有一些偏重了。
此时我们就想,要是可以直接在 SQLite 中存储 languages 字段的 JSON,将其当成一个字符串去存储,是不是就简单了?把一个多级的结构拉平成一级,剩下的只需要扩展出一个反序列化的方法,对业务来说,这些操作都是透明的。
那拍脑袋想,如果 Gson 有简单的容错,那我们将这个解析的字段类型定义成 String,是不是就可以做到了?
@SerializedName("languages")var languageStr = ""
很遗憾,这并没有办法做到,如果你这样使用,你将得到一个 IllegalStateException 的异常。
Caused by: com.google.gson.JsonSyntaxException: java.lang.IllegalStateException: Expected a string but was BEGIN_ARRAY at line 4 column 18 path $.languages
之所以会出现这样的情况,简单来说,虽然 deserialize()
方法传递的参数都是 JsonElement,但是 JsonElement 只是一个抽象类,最终会根据数据的情况,转换成它的几个实现类的其中之一,这些实现类都是 final class,分别是 JsonObject、JsonArray、JsonPrimitive、JsonNull,这些从命名上就很好理解了,它们代表了不通的 JSON 数据场景,就不过多介绍了。
使用了 Gson 之后,遇到花括号 {}
会生成一个 JsonObject,而字符串则是基本类型的 JsonPrimitive 对象,它们在 Gson 内部的解析流程是不一样的,这就造成了 IllegalStateException 异常。
那么接下来看看如何解决这个问题。
既然 TypeAdapter 是 Gson 解析的银弹,找不到解决方案,用它就对了。思路继续是用 JsonDeserializer 来接管解析,这一次将 User 类的整个解析都接管了。
class UserGsonAdapter:JsonDeserializer<User>{override fun deserialize(json: JsonElement,typeOfT: Type?,context: JsonDeserializationContext?): User {
var user = User()if(json.isJsonObject){val jsonObject = JSONObject(json.asJsonObject.toString())user.name = jsonObject.optString("name")user.age = jsonObject.optInt("age")
评论