如何为Kotlinx Serialization设置DataProvider接口的可序列化返回类型？

我正在开发一个插件类型系统，第三方会注册暴露数据的类。我不清楚数据具体结构，但需要枚举插件实例收集数据并使用Kotlinx Serialization进行序列化。当前简化后的接口如下：

interface DataProvider {
  fun getDataThatIsSerializable() : ???
}

我曾考虑返回Pair<Any, KSerializer<*>>，但无法将其传入Json.encodeAsString函数，类型不匹配。请问该将返回类型设置为什么，才能确保可以用Kotlinx Serialization序列化？

以下是几种可行的解决方案：

方案1：基于Pair<Any, KSerializer<*>>适配序列化调用 #

虽然直接将Pair传入Json.encodeAsString会有类型不匹配问题，但可以通过安全类型转换手动调用序列化器，无需额外定义新类型，仅需插件返回数据和对应序列化器：

// 插件侧实现
class MyDataProvider : DataProvider {
    @Serializable
    data class MyData(val value: String)
    
    override fun getDataThatIsSerializable(): Pair<Any, KSerializer<*>> {
        val data = MyData("test")
        return data to MyData.serializer()
    }
}

// 序列化调用逻辑
val (data, serializer) = dataProvider.getDataThatIsSerializable()
// 插件保证序列化器与数据类型匹配，因此转换安全
@Suppress("UNCHECKED_CAST")
val jsonStr = Json.encodeToString(serializer as KSerializer<Any>, data)

方案2：定义通用密封类容器 #

创建带@Serializable注解的密封类作为统一返回类型，插件需将自定义数据包装到密封类的子类中，具备类型安全性，无需手动处理序列化器：

// 统一密封类容器
@Serializable
sealed class SerialContainer {
    @Serializable
    data class Wrapped<T : @Serializable>(val value: T) : SerialContainer()
}

// 调整后的接口
interface DataProvider {
    fun getDataThatIsSerializable(): SerialContainer
}

// 插件侧实现
class MyDataProvider : DataProvider {
    @Serializable
    data class MyData(val value: String)
    
    override fun getDataThatIsSerializable(): SerialContainer {
        return SerialContainer.Wrapped(MyData("test"))
    }
}

// 序列化调用逻辑
val container = dataProvider.getDataThatIsSerializable()
val jsonStr = Json.encodeToString(container)

方案3：返回Any并依赖全局序列化模块 #

如果插件系统支持全局配置SerializersModule，让插件将自定义类型的序列化器注册到全局模块中，接口直接返回Any类型：

// 全局Json配置，插件需将序列化器注册到此处
val globalJson = Json {
    serializersModule = SerializersModule {
        // 示例：注册插件自定义类型的序列化器
        contextual(MyData::class, MyData.serializer())
    }
}

// 调整后的接口
interface DataProvider {
    fun getDataThatIsSerializable(): Any
}

// 序列化调用逻辑
val data = dataProvider.getDataThatIsSerializable()
val serializer = globalJson.serializersModule.serializer(data::class)
val jsonStr = globalJson.encodeToString(serializer, data)

方案4：返回JsonElement转移序列化责任 #

让插件自行完成数据到JsonElement的序列化，接口直接返回JsonElement，我们只需将其转为字符串即可，将序列化控制权完全交给插件：

// 调整后的接口
interface DataProvider {
    fun getDataThatIsSerializable(): JsonElement
}

// 插件侧实现
class MyDataProvider : DataProvider {
    @Serializable
    data class MyData(val value: String)
    
    override fun getDataThatIsSerializable(): JsonElement {
        return Json.encodeToJsonElement(MyData("test"))
    }
}

// 序列化调用逻辑
val jsonElement = dataProvider.getDataThatIsSerializable()
val jsonStr = Json.encodeToString(jsonElement)
// 或直接使用jsonElement.toString()输出JSON字符串

内容的提问来源于stack exchange，提问作者Luke De Feo