json - JSON 字段的多个名称

Question

我使用 kotlinx.serialization用于序列化/反序列化 JSON 的库。有一个JSON字符串:

{"id":"1"}

也可以表示为

{"uid":"1"}

我想用一个属性处理两个名字，例如:

@Serializable
data class User(val id: String)

是否可以仅使用一个 data 类及其属性来解析两个 JSON？

Answer 1

是的，您可以使用 @JsonNames 注释来提供除属性名称之外的替代名称(参见 doc)。您还可以在注释中定义多个附加名称。

@OptIn(ExperimentalSerializationApi::class)
@Serializable
data class User(
    @JsonNames("uid")
    val id: String,
)

对于序列化，将使用属性名称。对于反序列化，JSON 可能包含属性名称或附加名称，两者都映射到 id 属性。