Kotlin Serialization怎么序列化为XML

Kotlin Serialization 官方不支持 XML，需用第三方库如 kotlin-xml-serialization（1.4.0）实现；定义 @Serializable 类后，通过 Xml 格式器 encodeToString/decodeFromString 完成序列化与反序列化，支持 @SerialName 映射、缩进及空值处理。

Kotlin Serialization 本身不直接支持 XML 序列化，官方库 kotlinx.serialization 默认只提供 JSON、CBOR 和 Protobuf 的编解码器。要将 Kotlin 数据类序列化为 XML，需借助第三方库或手动桥接。

使用 kotlinx-xml-serialization（推荐）

这是目前最主流的兼容方案，由社区维护，专为 Kotlin Serialization 设计，支持注解驱动的 XML 序列化。

• 添加依赖（Gradle）：

implementation "com.charleskorn.kaml:kaml:0.56.0" // 注意：这不是它 —— 正确是下面这个

✅ 正确依赖（Maven Central 上最新稳定版）：

implementation "com.github.microutils:kotlin-xml-serialization:1.4.0"

（注意：该库基于 kotlinx.serialization 扩展，要求 Kotlin ≥ 1.9，Serialization ≥ 1.6）

• 定义可序列化的数据类（带 @Serializable）：

@Serializable
data class Person(
    val name: String,
    val age: Int,
    @SerialName("is-active") val isActive: Boolean = true
)

• 创建 XML 格式器并序列化：

val xml = Xml { indent = "  " } // 可选缩进
val person = Person("Alice", 30)
val xmlString = xml.encodeToString(Person.serializer(), person)
// 输出示例：
// 
//   Alice
//   30
//   true
// 

用 Jackson + Kotlin Serialization 桥接（备选）

如果你已有 Jackson XML 支持（jackson-dataformat-xml），可通过适配器把 Kotlin Serialization 的对象转成 Map 或 JsonElement，再交给 Jackson 处理。但这种方式失去原生注解支持，且较繁琐，仅适合已有 Jackson 生态的项目。

• 不推荐新手使用，需手动处理类型擦除、泛型嵌套、命名策略等细节
• 无法直接识别 @SerialName 或 @EncodeDefault 等 kotlinx.serialization 注解

注意事项与常见问题

• 根元素名默认来自类名，如 Person → ；可用 @XmlSerialName("user")（若库支持）或自定义 XmlConfiguration 覆盖
• 集合类型需显式标注泛型，例如：@Serializable data class Users(val list: List)，否则反序列化可能失败
• XML 属性暂不被主流 Kotlin XML 库原生支持（如 ），多数只支持元素内容；如有需求，建议改用 JAXB 或纯 Jackson XML
• 空值默认被忽略，如需输出 或 ，需配置 encodeDefaults = true

  

  并配合命名空间支持

反序列化 XML 同样简单

只要 XML 结构与数据类字段匹配（名称或通过 @SerialName 映射），调用 xml.decodeFromString() 即可：

val xmlStr = "Bob25"
val person: Person = xml.decodeFromString(Person.serializer(), xmlStr)

自动跳过未知字段，支持部分字段缺失（前提是字段可空或有默认值）。