广告位 · 页头(后台-模块管理-新建模块后替换此区域)

如何实现Kotlinx.Serialization接口多态序列化

Kotlinx.Serialization是Kotlin官方提供的序列化框架,在处理接口类型的多态序列化场景时,需要额外的配置才能正确保留和识别子类的类型信息,否则会出现序列化数据丢失或者反序列化失败的问题。

如何实现Kotlinx.Serialization接口多态序列化

接口多态序列化的核心问题

当我们要序列化的变量声明为接口类型,实际赋值是接口的某个子类实例时,默认的序列化流程只会按照接口的字段进行处理,不会记录具体的子类类型。反序列化时框架不知道要将数据还原成哪个子类,就会抛出异常。比如下面这个场景:

// 定义接口
interface Shape {
    val area: Double
}
// 两个子类
@Serializable
class Circle(val radius: Double) : Shape {
    override val area: Double
        get() = Math.PI * radius * radius
}
@Serializable
class Rectangle(val width: Double, val height: Double) : Shape {
    override val area: Double
        get() = width * height
}

如果直接声明val shape: Shape = Circle(2.0)然后尝试序列化,框架无法识别实际类型是Circle,就会出现问题。

使用PolymorphicSerializer实现多态

Kotlinx.Serialization提供了PolymorphicSerializer来专门处理多态场景,我们需要显式指定使用这个序列化器来处理接口类型。

import kotlinx.serialization.*
import kotlinx.serialization.json.*
fun main() {
    // 声明接口类型的变量
    val shape: Shape = Circle(2.0)
    // 使用PolymorphicSerializer指定序列化器
    val json = Json
    val shapeSerializer = PolymorphicSerializer(Shape::class)
    // 序列化
    val jsonString = json.encodeToString(shapeSerializer, shape)
    println(jsonString)
    // 反序列化
    val decodedShape: Shape = json.decodeFromString(shapeSerializer, jsonString)
    println(decodedShape.area)
}

运行上面的代码,会发现序列化后的字符串中包含了类型信息,反序列化也能正确还原成Circle实例。

通过序列化模块注册子类

如果子类的数量不确定,或者需要动态添加支持的子类类型,可以通过配置Json的序列化模块来注册所有需要支持的子类,这样就不需要每次都显式指定PolymorphicSerializer。

val jsonWithModule = Json {
    serializersModule = SerializersModule {
        // 注册Shape接口下的所有子类
        polymorphic(Shape::class) {
            subclass(Circle::class)
            subclass(Rectangle::class)
        }
    }
}
fun main() {
    val shape: Shape = Rectangle(3.0, 4.0)
    // 现在可以直接序列化接口类型,不需要显式指定PolymorphicSerializer
    val jsonString = jsonWithModule.encodeToString(shape)
    println(jsonString)
    val decodedShape: Shape = jsonWithModule.decodeFromString(jsonString)
    println(decodedShape.area)
}

这种方式更适合有多个子类,或者子类类型可能扩展的场景,维护性更好。

自定义类型鉴别器

默认情况下,Kotlinx.Serialization会在序列化数据中添加type字段来标记子类的类型,格式是包名.类名。如果觉得默认的鉴别器太长,或者想要自定义鉴别器的字段名和值,可以通过@SerialName注解来修改。

// 自定义子类的鉴别器值
@Serializable
@SerialName("circle")
class Circle(val radius: Double) : Shape {
    override val area: Double
        get() = Math.PI * radius * radius
}
@Serializable
@SerialName("rectangle")
class Rectangle(val width: Double, val height: Double) : Shape {
    override val area: Double
        get() = width * height
}

修改之后,序列化后的type字段值会变成circle或者rectangle,更简洁也更符合自定义需求。

注意事项

  • 所有参与多态序列化的子类都必须添加@Serializable注解,否则框架无法识别。
  • 如果接口本身有@Serializable注解,那么默认会启用多态处理,不需要额外配置PolymorphicSerializer,但最好还是通过模块注册子类避免遗漏。
  • 自定义鉴别器的时候要保证值的唯一性,否则反序列化时会出现类型匹配错误。
  • 如果需要和非Kotlinx.Serialization的系统交互,要确认对方是否能识别框架默认添加的类型字段,必要时可以自定义序列化格式适配。
实现方式适用场景优点缺点
PolymorphicSerializer显式指定子类数量少且固定配置简单,不需要额外模块每次序列化都要指定序列化器,复用性差
序列化模块注册子类子类多或可能扩展全局配置,使用便捷需要提前知道所有子类类型
自定义类型鉴别器需要自定义类型标记格式鉴别器简洁,适配性好需要保证鉴别器唯一性

通过以上几种方式,就可以灵活实现Kotlinx.Serialization的接口多态序列化需求,开发者可以根据实际的项目场景选择合适的实现方案。

广告位 · 文章底部(后台-模块管理替换此区域)