序列化 Kotlin 数据类时排除非空属性

Question

我经常会在 Kotlin 中创建一个内部用于数据模型的数据类。示例：

data class MyDataModel(
    var id: String? = null,
    var ownerId: String,
    var name: String,
    var isPrivate: Boolean = false,
)

我经常需要将这些类序列化为 JSON。问题是某些类属性不可为空，并且在某些情况下我需要在序列化中排除这些字段。我还没有找到一种干净简单的方法来做到这一点。我目前使用的解决方案是不使用不可为空的属性，然后将那些我不想序列化的属性设置为空。

还有其他方法吗？

Answer 1

使用kotlinx.serialization的解决方案：

1. 定义类，包括你要序列化的所有字段，标记为@Serializable

@Serializable
open class MyDataModelSerializable(
    open var id: String? = null
)

1. 将您的数据类设为其子类型：

data class MyDataModel(
    var ownerId: String,
    var name: String,
    var isPrivate: Boolean = false,
    override var id: String? = null
) : MyDataModelSerializable(id)

1. 使用MyDataModelSerializable 的序列化程序序列化MyDataModel 类的实例：

val s = serializer<MyDataModelSerializable>()
println(Json.encodeToString(s, MyDataModel(ownerId = "1", name = "2", id = "3", isPrivate = true))) //{"id":"3"}
println(Json.encodeToString(s, MyDataModel(ownerId = "1", name = "2", isPrivate = true))) //{}
println(Json{encodeDefaults = true}.encodeToString(s, MyDataModel(ownerId = "1", name = "2"))) //{"id":null}