IgnoreUnknownKeys 仅用于 Kotlinx 和 Ktor 的一种类型

问题描述

我在 Ktor 应用程序中使用 Kotlinx 序列化，并寻找与 Jacksons @JsonIgnoreProperties(ignoreUnkNown = true) 等效的注释。我知道

install(ContentNegotiation) {
     json(Json{ ignoreUnkNownKeys = true })
 }

我有许多类注释为 @Serializable。有没有办法将 ignoreUnkNownKeys 仅应用于一种类型的类/类型，就像我对 Jackson 所做的那样？

解决方法

您可以使用以下技巧：

1. 保留 ignoreUnknownKeys 格式实例的 false 属性 (Json) 的默认值，您提供给 Ktor。
2. 对于您希望以特殊方式处理的特定类，创建额外的自定义序列化程序，这将在幕后使用另一个格式实例。
3. 将这些序列化程序连接到 Json 格式实例，您将提供给 Ktor。

为方便起见，您可以为 KSerializer<T> 定义以下扩展函数：

fun <T> KSerializer<T>.withJsonFormat(json: Json) : KSerializer<T> = object : KSerializer<T> by this {
    override fun deserialize(decoder: Decoder): T {
        // Cast to JSON-specific interface
        val jsonInput = decoder as? JsonDecoder ?: error("Can be deserialized only by JSON")
        // Read the whole content as JSON
        val originalJson = jsonInput.decodeJsonElement().jsonObject
        return json.decodeFromJsonElement(this@withJsonFormat,originalJson)
    }
}

用法：

install(ContentNegotiation) {
    json(Json {
        serializersModule = SerializersModule {
            contextual(MyDataClass.serializer().withJsonFormat(Json { ignoreUnknownKeys = true }))
        }
    })
}