Skip to content

序列化 ​

序列化 (Serialization) 是將應用程式所使用的資料轉換為可透過網路傳輸,或儲存於資料庫或檔案之格式的過程。反序列化 (Deserialization) 則是相反的過程,將外部資料轉回執行階段物件。 兩者相輔相成,對於大多數需要與第三方交換資料的應用程式而言不可或缺。

某些資料序列化格式特別常見,例如 JSON 與 Protocol Buffers。 這些格式具備語言中立性與平台中立性,因此你可以使用它們在以任何現代語言編寫的系統之間交換資料。 Kotlin 透過支援多平台與資料格式的 kotlinx.serialization 程式庫 提供此功能性。

如果你是 Kotlin 序列化的新手,我們建議從開始使用序列化教學開始。 它會引導你在專案中設定 Kotlin 序列化,並展示如何序列化與反序列化你的第一個類別。

開始使用序列化

Kotlin 序列化程式庫 ​

Kotlin 序列化支援所有平台,包括 JVM、JavaScript 和 Native。 無論目標平台為何,你都可以使用相同的相依性宣告。

Kotlin 序列化透過不同的序列化格式程式庫,支援多種序列化格式,例如 JSON、CBOR 和 Protocol buffers。 這些程式庫建置於 kotlinx-serialization-core 程式庫之上。 如需受支援序列化格式的完整清單,請參閱受支援的序列化格式。

所有 kotlinx.serialization 格式程式庫均屬於 org.jetbrains.kotlinx: 群組,其名稱以 kotlinx-serialization- 開頭,並帶有反映序列化格式的後綴。 例如:

  • org.jetbrains.kotlinx:kotlinx-serialization-json 提供 JSON 序列化。
  • org.jetbrains.kotlinx:kotlinx-serialization-cbor 提供 CBOR 序列化。

kotlinx.serialization 程式庫遵循其獨立於 Kotlin 的版本控制。 你可以在 GitHub 上找到最新的釋出版本。

當你不使用特定格式程式庫時(例如編寫自己的序列化格式時), 請使用 kotlinx-serialization-core 程式庫作為相依性。

受支援的序列化格式 ​

kotlinx.serialization 專案為各種序列化格式提供了相應的程式庫:

格式Artifact ID平台狀態
JSONkotlinx-serialization-json所有受支援的平台穩定 (Stable)
HOCONkotlinx-serialization-hocon僅限 JVM實驗性 (Experimental)
Protocol Bufferskotlinx-serialization-protobuf所有受支援的平台實驗性 (Experimental)
CBORkotlinx-serialization-cbor所有受支援的平台實驗性 (Experimental)
Propertieskotlinx-serialization-properties所有受支援的平台實驗性 (Experimental)

除 JSON 序列化程式庫 (kotlinx-serialization-json) 外,所有序列化格式程式庫均處於實驗性 (Experimental)階段。其 API 可能隨時變更。 如需有關 JSON 序列化的更多詳細資訊,請參閱 JSON 序列化概觀。

此外也有社群維護的程式庫支援更多序列化格式,例如 YAML 或 Apache Avro。

你可以在自訂序列化格式中進一步了解其他替代與自訂的實驗性序列化格式。

受支援的序列化型別 ​

Kotlin 序列化支援多種內建型別,包括所有基本型別以及 Kotlin 標準庫中的大多數複合型別(例如 List 型別)。 如需詳細資訊,請參閱序列化內建型別。

此外,標註有 @Serializable 的類別完全支援序列化,從而實現類別執行個體與 JSON 等格式之間的相互轉換。 如需詳細資訊,請參閱序列化類別。

後續步驟 ​