巧用 Kotlin Serialization 拦截器实现多态反序列化

2024-03-20 15:24:57

灵活运用 Kotlin Serialization 实现多态反序列化

简介

Kotlin Serialization 提供了强大的多态类型支持，但如何针对特定条件选择不同子类的反序列化器呢？本文将探究如何使用 JsonContentPolymorphicSerializer 作为拦截器，灵活实现密封类层次结构的多态反序列化。

密封类与多态反序列化

密封类是表示具有明确子类的类型层次结构的好方法。多态反序列化时，编译器会使用类型鉴别器（如 type 属性）来识别每个子类的类型。

拦截器模式

JsonContentPolymorphicSerializer 是一种特殊序列化器，它能根据内容动态选择其他序列化器。这非常适合根据 JSON 元素中的属性值进行反序列化决策。

代码示例

考虑一个包含已删除消息的密封类层次结构。使用拦截器模式，我们可以针对已删除消息进行特殊处理：

sealed class BaseChatMessageDto {
    val id: Int
    data class DeletedMessageDto(
        // 属性覆盖...
    ): BaseChatMessageDto()
}

object DeletedMessageInterceptorSerializer: JsonContentPolymorphicSerializer<BaseChatMessageDto>(BaseChatMessageDto::class) {
    override fun selectDeserializer(element: JsonElement): DeserializationStrategy<BaseChatMessageDto> {
        val status = // 从 JSON 元素中解析状态
        return when (status) {
            RemoteStatus.DELETED -> DeletedChatMessageDto.serializer()
            else -> PolymorphicSerializer(BaseChatMessageDto::class)
        }
    }
}

// 在 sealed class 上应用拦截器
@Serializable(with = DeletedMessageInterceptorSerializer::class)
sealed class BaseChatMessageDto {
    // ...
}

使用方法

在 JSON 配置中注册序列化器模块：

serializersModule += SerializersModule {
    polymorphic(BaseChatMessageDto::class) {
        defaultDeserializer {
            UnknownChatMessageDto.serializer()
        }
    }
}