如何在 Kotlin 中使非支持属性可序列化

Question

给定一个数据类，例如：

@Serializable
data class Person(
    val name: String,
    val birthDate: Long,
) {
    val age get() = /* calculate age */
}

如何在序列化中包含

age

？我知道我可以使用

Transient

来 排除 属性。 根据基本序列化指南，示例中只有支持字段是可序列化的。但它没有提到如何使非支持字段（属性）可序列化。有没有什么方法可以将

age

包含在序列化中，而不需要编写自定义序列化程序的巨大解决方案？

另一种方法是使用支持字段并将其分配给

init {}

或将其传递到实例化站点，但这对我来说似乎很老套。

Answer 1

要在序列化中包含 Age 属性，而不需要编写自定义序列化程序或使用支持字段，您可以利用 kotlinx.serialization 库提供的 @Contextual 注释。该注释允许您以简洁灵活的方式定义自定义序列化器。

以下是如何使用 @Contextual 修改 Person 类以在序列化中包含年龄属性：

import kotlinx.serialization.*
import kotlinx.serialization.descriptors.*
import kotlinx.serialization.encoding.*

@Serializable
data class Person(
    val name: String,
    val birthDate: Long,
) {
    @Transient
    val age: Int = calculateAge(birthDate)

    private fun calculateAge(birthDate: Long): Int {
        // Calculate age based on birthDate
        // Example implementation:
        val currentYear = java.time.LocalDate.now().year
        val birthYear = java.time.LocalDate.ofEpochDay(birthDate).year
        return currentYear - birthYear
    }

    @Serializer(forClass = Person::class)
    companion object : KSerializer<Person> {
        override val descriptor: SerialDescriptor = buildClassSerialDescriptor("Person") {
            element<String>("name")
            element<Long>("birthDate")
            element<Int>("age")
        }

        override fun serialize(encoder: Encoder, value: Person) {
            val compositeOutput = encoder.beginStructure(descriptor)
            compositeOutput.encodeStringElement(descriptor, 0, value.name)
            compositeOutput.encodeLongElement(descriptor, 1, value.birthDate)
            compositeOutput.encodeIntElement(descriptor, 2, value.age)
            compositeOutput.endStructure(descriptor)
        }

        override fun deserialize(decoder: Decoder): Person {
            val compositeInput = decoder.beginStructure(descriptor)
            lateinit var name: String
            var birthDate: Long = 0
            var age: Int = 0
            loop@ while (true) {
                when (val index = compositeInput.decodeElementIndex(descriptor)) {
                    CompositeDecoder.DECODE_DONE -> break@loop
                    0 -> name = compositeInput.decodeStringElement(descriptor, index)
                    1 -> birthDate = compositeInput.decodeLongElement(descriptor, index)
                    2 -> age = compositeInput.decodeIntElement(descriptor, index)
                    else -> throw SerializationException("Unknown index: $index")
                }
            }
            compositeInput.endStructure(descriptor)
            return Person(name, birthDate)
        }
    }
}

fun main() {
    val person = Person("John", java.time.LocalDate.of(1990, 5, 15).toEpochDay())
    val jsonString = Json.encodeToString(Person.serializer(), person)
    println(jsonString)
}