千呼万唤始出来，Kotlin官方序列化库终相见(一)(2)

最新推荐文章于 2025-06-17 07:32:33 发布

原创最新推荐文章于 2025-06-17 07:32:33 发布 · 1.1k 阅读

16 ·

CC 4.0 BY-SA版权

文章标签：

#kotlin #微信 #开发语言

程序员专栏收录该内容

197 篇文章

订阅专栏

本文详细介绍了Kotlin中的`@Serializable`注解及其在类定义、构造函数、属性序列化方面的使用，包括幕后字段、默认值、可选属性验证、泛型类和套娃序列化等内容。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

}

再次提醒，并不是只有数据类才能序列化，只是为了反序列化时能把类直接打印出来。敲黑板，@Serializable，可以加参数指定我们自定义的序列化器，无参数时使用系统给的Serializer。幕后字段序列化仅对有后备字段的类的属性进行序列化，因此具有getter / setter但却没有幕后字段的属性不会被序列化，被委托的属性也不会被序列化。

@Serializable

class Project(

// name is a property with backing field – serialized

var name: String

) {

var stars: Int = 0 // property with a backing field – serializedval

path: String // getter only, no backing field – not serialized

get() = “kotlin/$name”

var id by ::name // delegated property – not serialized

}

fun main() {

val data = Project(“kotlinx.serialization”).apply { stars = 9000 }

println(Json.encodeToString(data))

//{“name”:“kotlinx.serialization”,“stars”:9000}

}

如果我们想定义Project类，使其采用路径字符串，然后将其解构为相应的属性，则我们可能很想编写类似以下代码的内容:

@Serializable

class Project(path: String) {

val owner: String = path.substringBefore(‘/’)

val name: String = path.substringAfter(‘/’)

}

此类无法编译，因为@Serializable注解要求该类的主构造函数的所有参数均为属性。一个简单的解决方法是使用类的属性定义一个私有的主构造函数，然后将所需的构造函数转换为辅助构造函数。

@Serializable

class Project private constructor(val owner: String, val name: String) {

constructor(path: String) : this(

owner = path.substringBefore(‘/’),

name = path.substringAfter(‘/’)

)

val path: String

get() = “ $o w n er /$ name”

}

fun main() {

println(Json.encodeToString(Project(“kotlin/kotlinx.serialization”)))

//{“owner”:“kotlin”,“name”:“kotlinx.serialization”}

}

path不具有幕后字段，不会被序列化。数据验证另一种情况是你可能想引入不带属性的主构造函数参数，在将其值存储到属性之前对其进行验证。为了使其可序列化，应该在主构造函数中将其替换为属性，然后将验证移至init {…}块中：

@Serializable

class Project(val name: String) {

init {

require(name.isNotEmpty()) { “name cannot be empty” }

}

fun main() {

val data = Json.decodeFromString(“”"

{“name”:“”}

“”")//Exception in thread “main” java.lang.IllegalArgumentException: name cannot be empty

println(data)

}

默认值

默认值属性反序列化时会被自动填充，序列化时不会被写入json，目的还是节省空间和带宽，在大多数实际场景中，此类配置可以减少视觉混乱，并节省要序列化的数据量。

0@Serializable

data class Project(val name: String, val language: String = “Kotlin”)

fun main() {

val data = Json.decodeFromString(“”"

{“name”:“kotlinx.serialization”}

“”")

println(data)//Project(name=kotlinx.serialization, language=Kotlin)

val data1 = Project(“kotlinx.serialization”)

println(Json.encodeToString(data1))//{“name”:“kotlinx.serialization”}

}

另一种类似情况是可空属性默认值为null

@Serializable

class Project(val name: String, val renamedTo: String? = null)

fun main() {

val data = Project(“kotlinx.serialization”)

println(Json.encodeToString(data))//{“name”:“kotlinx.serialization”}

}

当输入中存在可选属性时，该属性的相应初始化器不会调用。此功能是为提高性能而设计的，因此请注意不要依赖初始化程序中的副作用。

fun computeLanguage(): String {

println(“Computing”)

return “Kotlin”

}

@Serializable

data class Project(val name: String, val language: String = computeLanguage())

fun main() {

val data = Json.decodeFromString(“”"

{“name”:“kotlinx.serialization”,“language”:“Kotlin”}

“”")

println(data)//Project(name=kotlinx.serialization, language=Kotlin)

}

由于在输入中指定了language属性，因此在输出中看不到“计算”字符串。

@Required修饰的属性其值必须显式指明。

@Serializable

data class Project(val name: String, @Required val language: String = “Kotlin”)

fun main() {

val data = Json.decodeFromString(“”"

{“name”:“kotlinx.serialization”}

“”")

println(data)//Exception in thread “main” kotlinx.serialization.MissingFieldException: Field ‘language’ is required, but it was missing

}

@Transient修饰的属性不会被序列化，反序列化时也不能被指定。

@Serializable

data class Project(val name: String, @Transient val language: String = “Kotlin”)

fun main() {

val data = Json.decodeFromString(“”"

{“name”:“kotlinx.serialization”,“language”:“Kotlin”}

“”")/**

*Exception in thread “main” kotlinx.serialization.json.internal.JsonDecodingException:

*Unexpected JSON token at offset 60: Encountered an unknown key ‘language’.

*Use ‘ignoreUnknownKeys = true’ in ‘Json {}’ builder to ignore unknown keys.

println(data)

}

Kt的序列化框架是严格支持Kt的类型系统的，所以下面的代码有异常：

@Serializable

data class Project(val name: String, val language: String = “Kotlin”)

fun main() {

val data = Json.decodeFromString(“”"

{“name”:“kotlinx.serialization”,“language”:null}

“”")//Exception in thread “main” kotlinx.serialization.json.internal.JsonDecodingException: Unexpected JSON token at offset 52: Expected string literal but ‘null’ literal was found.

//Use ‘coerceInputValues = true’ in 'Json {}` builder to coerce nulls to default values.

println(data)

}