kotlinx.serialization 1.2发布，JSON的高性能解析，值类的支持，文档的翻修等等

Lei

Read this post in other languages:

• English
,
• Deutsch
,
• Español
,
• Français
,
• 日本語
,
• 한국어
,
• Русский
,
• Português do Brasil

• JSON序列化速度远超以往。在1.2版本将JSON解析为类型安全的Kotlin对象和将Kotlin对象解析为文本形式时，其速度是以前版本的两倍。
• 现已支持Kotlin 1.5的类型系统。值类和无符号数可以像其他Kotlin类一样转换为JSON并返回。
• 新的API文档让查找kotlinx.serialization提供的所有功能更加容易。

1.2版还新增对 JSON 字段候选名称的支持，以及提供了一种新的实验方案，可以自动从 Kotlin 类中生成 Protobuf 的 schema，为此，我们期待您的反馈！

开始使用 kotlinx.serialization 1.2!

Subscribe to Kotlin YouTube!

远超以往的 JSON 编解码

kotlinx.serialization最常用的功能是将 Kotlin 类编码为 JSON 字符串，以及将 JSON 字符串转换为 Kotlin 类，并且我们一直在努力提高其性能。

@Serializable
data class User(val name: String, val yearOfBirth: Int)

fun main() {
// Faster encoding...
val data = User("Louis", 1901)
val string = Json.encodeToString(data)
println(string) // {"name":"Louis","yearOfBirth":1901}

// ...and faster decoding!
val obj = Json.decodeFromString(string)
println(obj) // User(name=Louis, yearOfBirth=1901)
}

值类和无符号数字类型的稳定JSON(反)序列化

对值类的支持

@Serializable
value class Color(val rgb: Int)

@Serializable
data class NamedColor(val color: Color, val name: String)

fun main() {
println(Json.encodeToString(NamedColor(Color(0), "black")))
}

// {"color": 0, "name": "black"}

对无符号整型的支持

• UByte，其值范围从 0 到 255
• UShort，其值范围从 0 到 65535
• UInt，其值范围从 0 到 2^32 – 1
• ULong，其值范围从 0 到 2^64 – 1

@Serializable
class Counter(val counted: UByte, val description: String)

@Serializable
class BigCounter(val counted: ULong)

val counted = 239.toUByte()
println(Json.encodeToString(Counter(counted, "tries")))
// {"counted":239,"description":"tries"}

println(Json.encodeToString(BigCounter(ULong.MAX_VALUE)))
// {"counted":18446744073709551615}

如果您想紧跟最新版本的kotlinx.serialization和Kotlin编程语言，请通过该博客旁边的表格订阅Kotlin产品更新资讯。

有关更多kotlinx.serialization中使用值类和无符号类型的详细信息，请查看GitHub上的文档。

JSON 字段的支持候选名称

{"name":"kotlinx.serialization"}
/* ...or: */
{"title":"kotlinx.serialization"}

@Serializable
data class Project(@JsonNames("title") val name: String)

请注意与@SerialName注解的不同在于，这个注解（<0>@SerialName）允许您编解码时重命名字段，但不允许您指定候选值。

请注意与@SerialName注解的不同在于，这个注解（<0>@SerialName）允许您编解码时重命名字段，但不允许您指定候选值。

新的API文档

探索新的 kotlinx.serialization API 文档！

Protobuf: 从 Kotlin 类中生成 schema(试验中)

Protocol Buffers(Protobuf) 是Google创建的二进制序列化数据结构。 作为二进制格式，它比JSON或XML更节省空间，同时其结构与语言无关，您可以将其用于应用程序到应用程序间的通信。

@Serializable
data class Project(val name: String, val language: String)

fun main() {
val data = Project("kotlinx.serialization", "Kotlin")
val bytes = ProtoBuf.encodeToByteArray(data)
println(bytes.toAsciiHexString())
val obj = ProtoBuf.decodeFromByteArray(bytes)
println(obj)
}

将您的Kotlin类作为明确的来源(以及您可能用到的定制化)， kotlinx.serialization 能够推断出数据二进制的schema，让Protobuf在多个Kotlin应用程序之间的通信简洁且方便。

有关开始使用新的 schema 生成器的说明，请参阅文档中的相应说明。

• Kotlin的类和属性名需要符合protobuf规范，并且不得包含非法字符。
• Kotlin的可空性没有反映在schema中(因为proto2没有语义)。根据Kotlin的属性是否定义了默认值，使用protocol buffers提供的可选字段。
• Kotlin默认值未包含在schema中。(这意味着您必须确保不同语言实现中默认值设置的一致性。)

开始使用 kotlinx.serialization 1.2!

plugins {
kotlin("jvm") version "1.5.0" // or kotlin("multiplatform") or any other kotlin plugin
kotlin("plugin.serialization") version "1.5.0"
}

然后，更新您的dependencies和运行时库，包括您要在应用程序中使用的格式：

dependencies {
implementation("org.jetbrains.kotlinx:kotlinx-serialization-json:1.2.1")
implementation("org.jetbrains.kotlinx:kotlinx-serialization-protobuf:1.2.1")
// . . .
}

更多的观看及阅读材料

• kotlinx.serialization 1.2 视频
• GitHubsh 上的库
• kotlinx.serialization 指南
• API 文档
• Kotlin 1.5.0 发布博文

如果您遇到任何问题

• 向GitHub问题跟踪器报告问题。
• 在Kotlin Slack上的#serialization频道中寻求帮助(获得邀请)。

订阅 Kotlin 的 YouTube! Happy (de)serializing!

Subscribe to Kotlin Blog updates

Subscribe form

By submitting this form, I agree to the JetBrains Privacy Policy Notification icon

By submitting this form, I agree that JetBrains s.r.o. ("JetBrains") may use my name, email address, and location data to send me newsletters, including commercial communications, and to process my personal data for this purpose. I agree that JetBrains may process said data using third-party services for this purpose in accordance with the JetBrains Privacy Policy. I understand that I can revoke this consent at any time in my profile. In addition, an unsubscribe link is included in each email.

Submit

Thanks, we've got you!