在 Kotlinx 序列化中将字段设置为可选

Question

这是我的 pojo 类

@Serializable
data class Response(
    @SerialName("message") val message: String?,
    @SerialName("parameters") val parameters: Map<String, String>?
)

这是 Json，我试图从以下位置解码：

{
   "message": "Some text"
}

此处，该字段parameters是可选的。当我尝试解码时

Json.decodeFromString<Response>(response)

我收到以下异常：

kotlinx.serialization.MissingFieldException：序列名“Response”的类型需要字段“parameters”，但它丢失了

我期待将该字段设置parameters为null，如果该字段在Json

Answer 1

您需要为您的parameters属性指定一个默认值，如下所示：

@Serializable
data class Response(
    @SerialName("message") val message: String?,
    @SerialName("parameters") val parameters: Map<String, String>? = null
)

您可以在这里阅读更多相关信息：https://github.com/Kotlin/kotlinx.serialization/blob/master/docs/basic-serialization.md#optical-properties