高效的 Json 解析框架 kotlinx.serialization
一、引出问题
你是否有在使用 Gson 序列化对象时,见到如下异常:
Abstract classes can't be instantiated! Register an InstanceCreator or a TypeAdapter for this type.
什么时候会出现如此异常。下面举个栗子:
import com.google.gson.Gson
import com.google.gson.reflect.TypeToken
sealed class Gender
object Male: Gender()
object Female: Gender()
data class Student(
val id: Int,
val name: String,
val gender: Gender
)
fun main() {
val list1 = listOf(
Student(1001, "Jimy", Male),
Student(1002, "Lucy", Female),
Student(1003, "HanMeimei", Female),
Student(1004, "LiLei", Male)
)
println("list1: $list1")
val jsonString = Gson().toJson(list1)
println("jsonString: $jsonString")
try {
val typeToken = object : TypeToken<List<Student>>() {}.type
val list2: List<Student> = Gson().fromJson(jsonString, typeToken)
println("list2: $list2")
} catch (ex: Exception) {
println("catch: ${ex.message}")
}
}
上面的代码,执行结果如下:
list1: [Student(id=1001, name=Jimy, gender=serialize.gson.Male@79fc0f2f), Student(id=1002, name=Lucy, gender=serialize.gson.Female@50040f0c), Student(id=1003, name=HanMeimei, gender=serialize.gson.Female@50040f0c), Student(id=1004, name=LiLei, gender=serialize.gson.Male@79fc0f2f)]
jsonString: [{"id":1001,"name":"Jimy","gender":{}},{"id":1002,"name":"Lucy","gender":{}},{"id":1003,"name":"HanMeimei","gender":{}},{"id":1004,"name":"LiLei","gender":{}}]
catch: Abstract classes can't be instantiated! Register an InstanceCreator or a TypeAdapter for this type. Class name: serialize.gson.Gender
从这个输出结果,我们可以看到两个问题:
list1
经过序列化,得到的jsonString
中,gender
属性是空。jsonString
反序列化过程中发生了异常。
二、解决问题
异常信息已经指明了问题的解决方案
Abstract classes can't be instantiated! Register an InstanceCreator or a TypeAdapter for this type.
抽象类无法实例化!为此类型注册 InstanceCreator 或 TypeAdapter。
其实也很好理解。 sealed class
、abstract class
、interface
都是抽象的,不能直接被实例化。对于抽象类的子类或者接口的实现类,应该明确制定序列化和反序列化的规则。由于我们没有注册 TypeAdapter, 默认的 TypeAdapter ,将 Gender 属性序列化为了空对象。在进行反序列化时,空对象不知道应该如何反序列化,所以抛出了如下的异常。
解决办法之一,在序列化和反序列化时,需要使用 Gson 的 registerTypeAdapter
或 registerTypeHierarchyAdapter
方法来处理密封类的子类。
首先为抽象类/接口创建一个 TypeAdapter
class GenderTypeAdapter: TypeAdapter<Gender>() {
override fun write(out: JsonWriter?, value: Gender?) {
out?.value(value?.javaClass?.name)
}
override fun read(`in`: JsonReader?): Gender {
return when(val className = `in`?.nextString()) {
Male::class.java.name -> Male
Female::class.java.name -> Female
else -> throw IllegalArgumentException("Unknown class name: $className")
}
}
}
然后为 Gson 对象注册该 typeAdapter
fun main() {
val list1 = listOf(
Student(1001, "Jimy", Male),
Student(1002, "Lucy", Female),
Student(1003, "HanMeimei", Female),
Student(1004, "LiLei", Male)
)
println("list1: $list1")
// I'm here
val jsonString = GsonBuilder().registerTypeAdapter(Gender::class.java, GenderTypeAdapter()).create().toJson(list1)
println("jsonString: $jsonString")
try {
val typeToken = object : TypeToken<List<Student>>() {}.type
// I'm here
val list2: List<Student> = GsonBuilder().registerTypeAdapter(Gender::class.java, GenderTypeAdapter()).create().fromJson(jsonString, typeToken)
println("list2: $list2")
} catch (ex: Exception) {
println("catch: ${ex.message}")
}
}
此时执行结果如下:
list1: [Student(id=1001, name=Jimy, gender=serialize.gson.Male@79fc0f2f), Student(id=1002, name=Lucy, gender=serialize.gson.Female@50040f0c), Student(id=1003, name=HanMeimei, gender=serialize.gson.Female@50040f0c), Student(id=1004, name=LiLei, gender=serialize.gson.Male@79fc0f2f)]
jsonString: [{"id":1001,"name":"Jimy","gender":"serialize.gson.Male"},{"id":1002,"name":"Lucy","gender":"serialize.gson.Female"},{"id":1003,"name":"HanMeimei","gender":"serialize.gson.Female"},{"id":1004,"name":"LiLei","gender":"serialize.gson.Male"}]
list2: [Student(id=1001, name=Jimy, gender=serialize.gson.Male@79fc0f2f), Student(id=1002, name=Lucy, gender=serialize.gson.Female@50040f0c), Student(id=1003, name=HanMeimei, gender=serialize.gson.Female@50040f0c), Student(id=1004, name=LiLei, gender=serialize.gson.Male@79fc0f2f)]
Ok, 没有问题。
那... registerTypeAdapter
和 registerTypeHierarchyAdapter
两个方法有什么区别呢?
它们的主要区别在于注册对象的范围不同。
registerTypeAdapter 用于为特定的 Java 对象或类型注册自定义的序列化和反序列化逻辑。使用 TypeAdapter,可以在 Gson 序列化或反序列化特定对象或类型时,对其进行自定义处理。TypeAdapter 只会被应用于所注册的对象或类型。
registerTypeHierarchyAdapter 方法则是用于为特定类及其子类注册自定义的序列化和反序列化逻辑。使用 registerTypeHierarchyAdapter 方法,可以为一个类及其子类注册自定义的序列化和反序列化逻辑,这个逻辑将被应用于该类及其所有子类。这在处理一组类继承结构时非常有用。
在使用 registerTypeHierarchyAdapter 方法时,需要注意一点,即 Gson 会遍历所有的子类来找到最合适的 TypeAdapter,因此要确保该 TypeAdapter 能够正确处理所有的子类。如果某个子类没有对应的处理逻辑,或者处理逻辑有误,就可能导致序列化或反序列化失败。
因此,如果要为一组类继承结构注册自定义的序列化和反序列化逻辑,可以使用 registerTypeHierarchyAdapter 方法;如果只需要为某个具体的 Java 对象或类型注册自定义的序列化和反序列化逻辑,则可以使用 TypeAdapter。
三、用 kotlinx.serialization 进行Kotlin JSON序列化
Gson 是针对 java 对象的序列化框架。基于 Kotlin 对象使用 Gson 框架,会失去 Kotlin 的一些重要特性,比如:
- 非空类型安全。比如 Kotlin 类的属性定义为非空类型时,仍然可以将一个 null 赋值给它创建一个对象。
- 参数默认值没有效果。Kotlin 属性可以赋予默认值。但是当使用 Gson 时,将会失去效果。
修改之前的例子:
sealed class Gender
object Male: Gender()
object Female: Gender()
data class Student(
val id: Int,
val name: String = "unknown",
val gender: Gender
)
fun main() {
val json = """
{
"id": 1005
}
""".trimIndent()
try {
val stu = Gson().fromJson(json, Student::class.java)
println("stu: $stu")
} catch (ex: Exception) {
println("catch: ${ex.message}")
}
}
这里我们在定义 Student 类是,给 name 属性指定了一个默认值 unknown
, 在进行反序列化时,没有指定 name 和 gender, 看看执行结果:
stu: Student(id=1005, name=null, gender=null)
结果也表明,name 的默认值没有成功,并且 name 和 gender 都赋值为 null 了。
针对上述问题有很多解决办法。但是这里,我要介绍一个新的 Json 框架,Kotlin 团队开发的一个 native 支持的库 kotlinx.serialization
, 这个库支持JVM,JavaScript,Native所有平台,同时也支持多种格式的序列化——JSON,CBOR,protocol buffers等等。
3.1 kotlinx.serialization 的使用
- plugins 引入:
plugins {
id("org.jetbrains.kotlin.plugin.serialization") version("1.4.30")
}
- dependencies 引入:
dependencies {
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.6.2")
}
- 通过添加
@Serializable
注解,给类进行序列化
package serialize.ktxSerialization
import kotlinx.serialization.Serializable
import kotlinx.serialization.decodeFromString
import kotlinx.serialization.encodeToString
import kotlinx.serialization.json.Json
@Serializable
sealed class Gender
@Serializable
object Male: Gender()
@Serializable
object Female: Gender()
@Serializable
data class Student(
val id: Int,
val name: String = "unknown",
val gender: Gender
)
注意:所涉及到的抽象类极其子类都需要加上该注解。
测试代码:
fun main() {
val json = """
{
"id": 1005
}
""".trimIndent()
try {
val stu = Json.decodeFromString<Student>(json)
println("stu: $stu")
} catch (ex: Exception) {
println("catch: ${ex.message}")
}
}
反序列化的关键方法:
Json.decodeFromString()
执行报错了:
catch: Field 'gender' is required for type with serial name 'serialize.ktxSerialization.Student', but it was missing at path: $
错误信息指出: gender 属性是必须的。那我们应该如何该如何添加 gender 属性呢?
不急,我们先序列化看看生成的是什么。
fun main() {
val student = Student(1006, "James", Male)
val jsonString = Json.encodeToString(student)
println("jsonString: $jsonString")
}
执行结果如下:
jsonString: {"id":1006,"name":"James","gender":{"type":"serialize.ktxSerialization.Male"}}
我们看到,Student 对象序列化之后, gender
对应的 value 是
{"type":"serialize.ktxSerialization.Male"}
这里是完整的包名类名。
到这里,我们再手动构造验证一下:
fun main() {
val json = """
{
"id": 1005,
"gender": {"type": "serialize.ktxSerialization.Female"}
}
""".trimIndent()
try {
val stu = Json.decodeFromString<Student>(json)
println("stu: $stu")
} catch (ex: Exception) {
println("catch: ${ex.message}")
}
}
执行结果:
stu: Student(id=1005, name=unknown, gender=serialize.ktxSerialization.Female@36d64342)
可以看到,反序列化成功,生成的对象,name 属性赋了默认值。
另外需要注意的是:如果在定义 Kotlin 的类中某个属性,没有指定默认值,即便该属性是可空类型,反序列化时也一定要赋值才能执行成功。
修改下例子:
package serialize.ktxSerialization
import kotlinx.serialization.Serializable
import kotlinx.serialization.decodeFromString
import kotlinx.serialization.encodeToString
import kotlinx.serialization.json.Json
@Serializable
sealed class Gender
@Serializable
object Male: Gender()
@Serializable
object Female: Gender()
@Serializable
data class Student(
val id: Int,
val name: String?, // 注意这里
val gender: Gender
)
fun main() {
val json = """
{
"id": 1005,
"gender": {"type": "serialize.ktxSerialization.Female"}
}
""".trimIndent()
try {
val stu = Json.decodeFromString<Student>(json)
println("stu: $stu")
} catch (ex: Exception) {
println("catch: ${ex.message}")
}
}
我把 name 设置为可空类型,但是没有默认值。这时反序列化是会失败的:
catch: Field 'name' is required for type with serial name 'serialize.ktxSerialization.Student', but it was missing at path: $
给 name 属性赋值为 null, 则执行成功
fun main() {
val json = """
{
"id": 1005,
"name", null,
"gender": {"type": "serialize.ktxSerialization.Female"}
}
""".trimIndent()
try {
val stu = Json.decodeFromString<Student>(json)
println("stu: $stu")
} catch (ex: Exception) {
println("catch: ${ex.message}")
}
}
结果:
stu: Student(id=1005, name=null, gender=serialize.ktxSerialization.Female@340f438e)
3.2 用 kotlinx.serialization 解决本文开头的问题
对于本文开头引出的问题,如果使用 kotlinx.serialization,则该问题即可轻松解决。
直接上代码:
fun main() {
val list1 = listOf(
Student(1001, "Jimy", Male),
Student(1002, "Lucy", Female),
Student(1003, "HanMeimei", Female),
Student(1004, "LiLei", Male)
)
println("list1: $list1")
val jsonString = Json.encodeToString(list1)
println("jsonString: $jsonString")
try {
val list2 = Json.decodeFromString<List<Student>>(jsonString)
println("list2: $list2")
} catch (ex: Exception) {
println("catch: ${ex.message}")
}
}
执行结果:
list1: [Student(id=1001, name=Jimy, gender=serialize.ktxSerialization.Male@531d72ca), Student(id=1002, name=Lucy, gender=serialize.ktxSerialization.Female@22d8cfe0), Student(id=1003, name=HanMeimei, gender=serialize.ktxSerialization.Female@22d8cfe0), Student(id=1004, name=LiLei, gender=serialize.ktxSerialization.Male@531d72ca)]
jsonString: [{"id":1001,"name":"Jimy","gender":{"type":"serialize.ktxSerialization.Male"}},{"id":1002,"name":"Lucy","gender":{"type":"serialize.ktxSerialization.Female"}},{"id":1003,"name":"HanMeimei","gender":{"type":"serialize.ktxSerialization.Female"}},{"id":1004,"name":"LiLei","gender":{"type":"serialize.ktxSerialization.Male"}}]
list2: [Student(id=1001, name=Jimy, gender=serialize.ktxSerialization.Male@531d72ca), Student(id=1002, name=Lucy, gender=serialize.ktxSerialization.Female@22d8cfe0), Student(id=1003, name=HanMeimei, gender=serialize.ktxSerialization.Female@22d8cfe0), Student(id=1004, name=LiLei, gender=serialize.ktxSerialization.Male@531d72ca)]
这里很好理解:
在没有给 Gson 注册 TypeAdapter 的时候,使用默认的 TypeAdapter, 把引用类型序列化为了空。反序列化时才会失败。而是用 kotlinx.serialization ,相当于默认提供了一个序列化和反序列方案。所以直接可以成功。无需我们自己定义序列化和反序列化的规则。
四、总结
最后对本文做个总结:
- 在使用 Gson 进行序列化和反序列过程中。要注意多态的情况下。需要自己注册 TypeAdapter。
- 如果使用 Kotlin 开发,优先使用高效的序列化框架:kotlinx.serialization。
kotlinx.serialization 具有如下特性:
- 类型安全:满足 Kotlin 的强制类型安全。可处理 Kotlin 的可空类型。
- 支持属性默认值:解析 JSON 的时候支持 Kotlin 类中属性的默认值。
- 支持泛型类型:API在序列化和反序列化泛型类型的时候非常简单也非常高效。
- 序列化字段名:当 json 的 key 和字段名不一致时,可以通过
@SerialName
给字段进行序列化。 同 Gson 中的@SerializedName
。 - 序列化引用对象:当属性的类型是引用类型时,对该类型也需要使用
@Serializable
注解。 - 数据校验:可以再 json 反序列化时对数据进行校验。
- 支持 Retrofit 库。详见针对Retrofit 2 Converter.Factory的Kotlin序列化的库。
kotlinx.serialization 有很多优秀的特性。本文算是抛砖引玉。更多特性,请自己手动 Coding 体验。
最后附上 kotlinx.serialization 的官方文档:https://github.com/Kotlin/kotlinx.serialization
高效的 Json 解析框架 kotlinx.serialization的更多相关文章
- Spring Boot默认的JSON解析框架设置
方案一:启动类继承WebMvcConfigurerAdapter,覆盖方法configureMessageConverters ... @SpringBootApplication public cl ...
- 十七、springboot配置FastJson为Spring Boot默认JSON解析框架
前提 springboot默认自带json解析框架,默认使用jackson,如果使用fastjson,可以按照下列方式配置使用 1.引入fastjson依赖库: maven: <dependen ...
- springboot使用fastJson作为json解析框架
springboot使用fastJson作为json解析框架 springboot默认自带json解析框架,默认使用jackson,如果使用fastjson,可以按照下列方式配置使用 〇.搭建spri ...
- 移动架构-json解析框架
JSON在现在数据传输中占据着重要地位,相比于xml,其解析和构成都要简单很多,第三方的解析框架也不胜枚举,这里之所以要自定义一个json解析框架,一方面是更好的了解json解析过程,另一方面是有时候 ...
- 4. 使用别的json解析框架【从零开始学Spring Boot】
转载:http://blog.csdn.net/linxingliang/article/details/51585921 此文章已经废弃,请看新版的博客的完美解决方案: 78. Spring Boo ...
- (4)Spring Boot使用别的json解析框架【从零开始学Spring Boot】
此文章已经废弃,请看新版的博客的完美解决方案: 78. Spring Boot完美使用FastJson解析JSON数据[从零开始学Spring Boot] http://412887952-qq-co ...
- 将SpringBoot默认Json解析框架jackson替换成fastjson
步骤一:引入依赖<dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson< ...
- Android JSON解析库Gson和Fast-json的使用对比和图书列表小案例
Android JSON解析库Gson和Fast-json的使用对比和图书列表小案例 继上篇json解析,我用了原生的json解析,但是在有些情况下我们不得不承认,一些优秀的json解析框架确实十分的 ...
- Android总结之json解析(FastJson Gson 对比)
前言: 最近为了统一项目中使用的框架,发现项目中用到了两种json解析框架,他们就是当今非常主流的json解析框架:google的Gson 和阿里巴巴的FastJson,为了废除其中一个所以来个性能和 ...
- 年年出妖事,一例由JSON解析导致的"薛定谔BUG"排查过程记录
前言 做开发这么多年,也碰到无数的bug了.不过再复杂的bug,只要仔细去研读代码,加上debug,总能找到原因. 但是最近公司内碰到的这一个bug,这个bug初看很简单,但是非常妖孽,在一段时间内我 ...
随机推荐
- 蚂蚁集团混沌工程 ChaosMeta V0.5 版本发布
混沌工程 ChaosMeta 的全新版本 V0.5 现已正式发布!该版本包含了许多新特性和增强功能,为用户提供了支撑混沌工程各个阶段的平台能力,以及降低使用门槛的用户界面. ChaosMeta V0. ...
- 在 RedHat Enterprise、CentOS 或 Fedora Linux 上安装 MongoDB
在 RedHat Enterprise.CentOS 或 Fedora Linux 上安装 MongoDB 1.大纲 备注:采用yum安装后,所有进程将自动在/usr/bin下,如下的mongo.mo ...
- 开源XL-LightHouse与Flink、ClickHouse之类技术相比有什么优势
Flink是一款非常优秀的流式计算框架,而ClickHouse是一款非常优秀的OLAP类引擎,它们是各自所处领域的佼佼者,这一点是毋庸置疑的.Flink除了各种流式计算场景外也必然可以用于流式统计,C ...
- window操作系统安装多个版本nodejs版本-控制工具nvm
参考: https://blog.csdn.net/m0_38134431/article/details/118388297 https://juejin.cn/post/7044890876631 ...
- Ubuntu 18.04安装RabbitMQ
1.安装erlang语言环境 sudo apt install erlang-nox 2.更新Ubuntu 源 sudo apt update 3.安装RabbitMQ服务 sudo apt inst ...
- 甲骨文宣布: 也做 PostgreSQL!
PostgreSQL 在开源数据库世界中一直是一个标志性的存在.经过35年的严格开发,它以其可靠性.强大的功能和性能而自豪.DB-engines 的突出显示,其市场份额的增长证明了其适应性强的数据模型 ...
- 第一个 Go 程序"hello,world" 与 main 函数和Go常用基本命令
第一个 Go 程序"hello,world" 与 main 函数和Go常用基本命令 目录 第一个 Go 程序"hello,world" 与 main 函数和Go ...
- Linux第二次周总结
第三章 用户管理 3.1 用户/组概览 Linux系统是多用户.多任务的分时操作系统,系统上每一个进程都有一个特定的文件,每个文件都被一个特定的用户所拥有.每个用户都属于一个用户组或者多个组,系统可以 ...
- 聊聊基于Alink库的特征工程方法
示例代码及相关内容来源于<Alink权威指南(Java版)> 独热编码 OneHotEncoder 是用于将类别型特征转换为独热编码的类.独热编码是一种常用的特征编码方式,特别适用于处理类 ...
- 从零用VitePress搭建博客教程(2) –VitePress默认首页和头部导航、左侧导航配置
2. 从零用VitePress搭建博客教程(2) –VitePress默认首页和头部导航.左侧导航配置 接上一节: 从零用VitePress搭建博客教程(1) – VitePress的安装和运行 四. ...