序列化

添加插件和依赖项

开始之前, 你需要配置你的构建脚本, 使你的项目能够使用 Kotlin 序列化工具:

1. 应用 Kotlin 序列化 Gradle 插件 org.jetbrains.kotlin.plugin.serialization (在 Kotlin Gradle DSL 中是 kotlin("plugin.serialization")).

   plugins { kotlin("jvm") version "2.0.21" kotlin("plugin.serialization") version "2.0.21" }

   plugins { id 'org.jetbrains.kotlin.jvm' version '2.0.21' id 'org.jetbrains.kotlin.plugin.serialization' version '2.0.21' }

2. 添加 JSON 序列化库的依赖项: org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.3

   dependencies { implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.3") }

   dependencies { implementation 'org.jetbrains.kotlinx:kotlinx-serialization-json:1.7.3' }

现在, 可以在你的代码中使用序列化 API 了. API 所在的包是 kotlinx.serialization, 以及各个格式专用的子包, 比如 kotlinx.serialization.json.

序列化和反序列化 JSON

1. 对一个类添加 @Serializable 注解, 使它可以被序列化.

   import kotlinx.serialization.Serializable @Serializable data class Data(val a: Int, val b: String)

2. 调用函数 Json.encodeToString(), 序列化这个类的实例.

   import kotlinx.serialization.Serializable import kotlinx.serialization.json.Json import kotlinx.serialization.encodeToString @Serializable data class Data(val a: Int, val b: String) fun main() { val json = Json.encodeToString(Data(42, "str")) }

   结果, 你会得到一个 JSON 格式的字符串, 其中包含这个对象的状态: {"a": 42, "b": "str"}

3. 使用 decodeFromString() 函数, 从 JSON 字符串中反序列化对象:

   import kotlinx.serialization.Serializable import kotlinx.serialization.json.Json import kotlinx.serialization.decodeFromString @Serializable data class Data(val a: Int, val b: String) fun main() { val obj = Json.decodeFromString<Data>("""{"a":42, "b": "str"}""") }

就是这样! 你已经成功的将对象序列化为 JSON 字符串, 然后将 JSON 字符串反序列化为对象.