JSON 编码与解码
转换为 JSON 以及从 JSON 转换
JSON 编码与解码 是 CoddyKit 上的免费 Kotlin Academy 课时。 这是第 3 节课,共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Kotlin Academy 学习路径的一部分,你的进度在网页和 CoddyKit 应用中同步。 Kotlin Academy 课程共包含 4 节课。
Json 对象
Json 对象是编码和解码的核心。默认实例可以直接使用,也可以创建一个经过配置的实例。
import kotlinx.serialization.json.Json
val json = Json编码为字符串
使用 encodeToString 将对象转换为 JSON 字符串。
import kotlinx.serialization.Serializable
import kotlinx.serialization.encodeToString
import kotlinx.serialization.json.Json
@Serializable
data class Book(val title: String, val pages: Int)
fun main() {
val book = Book("Kotlin in Action", 360)
val text = Json.encodeToString(book)
println(text)
}从字符串解码
使用 decodeFromString 将 JSON 解析回对象。目标类型可以自动推断,也可以显式指定。
import kotlinx.serialization.Serializable
import kotlinx.serialization.decodeFromString
import kotlinx.serialization.json.Json
@Serializable
data class Book(val title: String, val pages: Int)
fun main() {
val text = "{\"title\":\"Atomic Kotlin\",\"pages\":500}"
val book = Json.decodeFromString<Book>(text)
println(book.title)
}编码列表
集合会自动进行编码。可序列化对象的列表会变成 JSON 数组。
import kotlinx.serialization.Serializable
import kotlinx.serialization.encodeToString
import kotlinx.serialization.json.Json
@Serializable
data class Tag(val name: String)
fun main() {
val tags = listOf(Tag("kotlin"), Tag("json"))
println(Json.encodeToString(tags))
}美化输出
配置 Json { } 构建器以启用缩进输出,这对记录日志和调试很有帮助。
import kotlinx.serialization.Serializable
import kotlinx.serialization.encodeToString
import kotlinx.serialization.json.Json
@Serializable
data class Point(val x: Int, val y: Int)
val pretty = Json { prettyPrint = true }
fun main() {
println(pretty.encodeToString(Point(1, 2)))
}忽略未知键
默认情况下,如果 JSON 包含类中不存在的键,解码就会失败。设置 ignoreUnknownKeys = true 可跳过这些键,这对不断演进的 API 很有用。
import kotlinx.serialization.json.Json
val lenient = Json { ignoreUnknownKeys = true }编码默认值
默认情况下,等于默认值的属性不会被写入。启用 encodeDefaults = true 后,始终会包含这些属性。
import kotlinx.serialization.json.Json
val withDefaults = Json { encodeDefaults = true }处理 JsonElement
对于动态 JSON,您可以将其解析为 JsonElement 树,而不是解析为有类型的类。
import kotlinx.serialization.json.Json
import kotlinx.serialization.json.JsonElement
fun main() {
val element: JsonElement = Json.parseToJsonElement("{\"a\":1}")
println(element)
}读取 JsonObject 字段
将 JsonElement 转换为 JsonObject,然后按键访问字段,再转换其中的原始值。
import kotlinx.serialization.json.Json
import kotlinx.serialization.json.jsonObject
import kotlinx.serialization.json.jsonPrimitive
import kotlinx.serialization.json.int
fun main() {
val obj = Json.parseToJsonElement("{\"a\":1}").jsonObject
val a = obj["a"]!!.jsonPrimitive.int
println(a)
}往返转换
先编码再解码应该能得到一个相等的对象(这称为往返转换)。这是检查模型是否合理的好方法。
import kotlinx.serialization.Serializable
import kotlinx.serialization.encodeToString
import kotlinx.serialization.decodeFromString
import kotlinx.serialization.json.Json
@Serializable
data class P(val x: Int)
fun main() {
val original = P(42)
val back = Json.decodeFromString<P>(Json.encodeToString(original))
println(original == back)
}常见解码错误
请注意以下运行时异常:
SerializationException: Unexpected JSON token— JSON 格式错误- 缺少必需字段 — JSON 缺少没有默认值的属性
- 未知键 — 使用
ignoreUnknownKeys关闭严格模式
快速检查
您的 API 经常添加新的 JSON 字段。哪项配置可以避免解码中断?
回顾
现在您可以在对象与 JSON 之间进行转换:
encodeToString/decodeFromString- 使用
Json { }进行配置:prettyPrint、ignoreUnknownKeys、encodeDefaults - 通过
JsonElement解析动态 JSON
下一步:为不受支持的类型编写自定义序列化器。
常见问题解答
「JSON 编码与解码」课时是免费的吗?
是的 — 「JSON 编码与解码」的完整文本可在网页上免费阅读。要进行交互式练习(内置代码编辑器和全天候 AI 导师)并解锁 Kotlin Academy 课程的其余内容,请升级到 CoddyKit PRO。 Kotlin Academy 课程共包含 4 节课。
「JSON 编码与解码」这节课中我会学到什么?
转换为 JSON 以及从 JSON 转换 你通过在浏览器中直接运行的动手代码来练习 Kotlin Academy,全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 Kotlin Academy 需要有经验吗?
无需任何先前经验。CoddyKit 上的 Kotlin Academy 课程适合初学者到高级学习者,你可以从这里开始或从头开始,按照自己的节奏学习。 这是第 3 节课,共 4 节。
「JSON 编码与解码」课时需要多长时间?
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动,所以你能稳步进步,并在网页和应用中从离开的地方继续。
我能在这节 Kotlin Academy 课中编写并运行代码吗?
能。每节 Kotlin Academy 课都包含内置代码编辑器,你可以在浏览器中直接编写并运行真实代码,并获得即时 AI 反馈 — 无需本地设置。
此课程中的所有课时
- kotlinx.serialization 配置
- 可序列化类
- JSON 编码与解码
- 自定义序列化器