kotlinx.serialization 中的可选字段与空值

如何解决kotlinx.serialization 中的可选字段与空值

如何区分反序列化 JSON 时 kotlinx.serialization 中的 {data: null} 和 {}？

@Serializable
class MyClass(val data: String?)

解决方法

您需要一个自定义的 setter 和一个私有的布尔字段来指示是否触摸了该字段值。所以像：

@Serializable
class MyClass {
    private var isDataTouched = false

    val data: String
        set(value) {        
            field = value
            isDataTouched = true
        }
}

注意，您不能在默认构造函数中定义字段。

您可以利用 polymorphism 与 JsonContentPolymorphicSerializer 结合来区分您正在反序列化的响应类型：

@Serializable(with = MyResponseSerializer::class)
sealed class MyResponse

@Serializable
class MyEmptyClass : MyResponse()

@Serializable
class MyClass(val data: String?) : MyResponse()

// this serializer is reponsible for determining what class we will receive
// by inspecting json structure
object MyResponseSerializer : JsonContentPolymorphicSerializer<MyResponse>(MyResponse::class) {
    override fun selectDeserializer(element: JsonElement) = when {
        "data" in element.jsonObject -> MyClass.serializer()
        else -> MyEmptyClass.serializer()
    }
}

使用 MyResponse 类反序列化之后，您将收到 MyEmptyClass 或 MyClass：

val e = Json.decodeFromString<MyResponse>("""{}""")             // returns MyEmptyClass object
val o = Json.decodeFromString<MyResponse>("""{"data": null}""") // returns MyClass object

println(Json.encodeToString(e)) // {}
println(Json.encodeToString(o)) // {"data": null}

// since sealed class is the parent we can have exhaustive when:
when(e) {
    is MyClass -> TODO("handle response with data")
    is MyEmptyClass -> TODO("handle empty response")
}