JSON 序列化概述
Kotlin serialization 允许你轻松地将 Kotlin 对象与 JSON 进行相互转换。 Json 类是实现此功能的主要工具,它在 JSON 的生成和解析方式上提供了极大的灵活性。 你可以配置 Json 实例以处理特定的 JSON 行为,也可以使用其默认实例来处理基础任务。
借助 Json 类,你可以:
- 使用
encodeToString()函数将 Kotlin 对象序列化为 JSON 字符串。 - 使用
decodeFromString()函数将 JSON 字符串反序列化回 Kotlin 对象。 - 在处理复杂的 JSON 结构时,通过
encodeToJsonElement()和decodeFromJsonElement()函数直接操作JsonElement。 - 使用实验性扩展函数在不创建中间字符串的情况下序列化和反序列化 I/O 源,包括 JVM 流以及
kotlinx-io和 Okio 类型。
在开始之前,请从序列化库中导入以下声明:
kotlin
import kotlinx.serialization.*
import kotlinx.serialization.json.*下面是一个使用默认 Json 实例展示 Kotlin 中 JSON 序列化如何工作的简单示例:
kotlin
// 从序列化库导入声明
import kotlinx.serialization.*
import kotlinx.serialization.json.*
@Serializable
data class User(val name: String, val age: Int)
fun main() {
// 使用默认的 Json 实例
val json = Json
// 创建一个 User 对象
val user = User("Alice", 30)
// 将 User 对象转换为 JSON 字符串
val jsonString = json.encodeToString(user)
println(jsonString)
// {"name":"Alice","age":30}
// 将 JSON 字符串转换回 User 对象
val deserializedUser = json.decodeFromString<User>(jsonString)
println(deserializedUser)
// User(name=Alice, age=30)
}除了使用默认配置外,你还可以针对特定用例自定义 Json 实例, 例如忽略未知键:
kotlin
// 从序列化库导入声明
import kotlinx.serialization.*
import kotlinx.serialization.json.*
@Serializable
data class Project(val name: String)
// 配置 Json 实例以忽略未知键
val customJson = Json {
ignoreUnknownKeys = true
}
fun main() {
val data = customJson.decodeFromString<Project>("""
{"name":"kotlinx.serialization","language":"Kotlin"}
""")
println(data)
// Project(name=kotlinx.serialization)
}后续步骤
- 了解如何自定义
Json实例以应对序列化和反序列化的不同用例。 - 探索高级 JSON 元素处理,以便在解析或序列化之前操作和处理 JSON 数据。
- 了解如何在序列化和反序列化期间转换 JSON,从而更好地控制你的数据。
