シリアライゼーション
シリアライゼーション(Serialization)とは、アプリケーションが使用するデータを、ネットワーク経由で転送したりデータベースやファイルに保存したりできる形式に変換するプロセスのことです。デシリアライゼーション(Deserialization)はその逆で、外部データをランタイムオブジェクトへと復元するプロセスです。これらはどちらも、サードパーティとデータをやり取りするほとんどのアプリケーションにとって不可欠です。
JSON や Protocol Buffers など、特に広く普及しているデータシリアライゼーションフォーマットもあります。これらのフォーマットは言語やプラットフォームに依存しないため、任意のモダンな言語で書かれたシステム間でのデータ交換に使用できます。Kotlin では、複数のプラットフォームおよびデータフォーマットをサポートする kotlinx.serialization ライブラリ を通じてこの機能を提供しています。
Kotlin でのシリアライゼーションを初めて扱う場合は、シリアライゼーション入門(Get Started with Serialization) チュートリアルから始めることをお勧めします。このチュートリアルでは、プロジェクトへの 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 プロジェクトは、さまざまなシリアライゼーションフォーマット用のライブラリを提供しています。
| フォーマット | アーティファクト ID | プラットフォーム | ステータス |
|---|---|---|---|
| JSON | kotlinx-serialization-json | サポートされているすべてのプラットフォーム | Stable |
| HOCON | kotlinx-serialization-hocon | JVM のみ | Experimental |
| Protocol Buffers | kotlinx-serialization-protobuf | サポートされているすべてのプラットフォーム | Experimental |
| CBOR | kotlinx-serialization-cbor | サポートされているすべてのプラットフォーム | Experimental |
| Properties | kotlinx-serialization-properties | サポートされているすべてのプラットフォーム | Experimental |
JSON シリアライゼーションライブラリ(kotlinx-serialization-json)を除くすべてのシリアライゼーションフォーマットライブラリは、Experimental(実験的) です。それらの API はいつでも変更される可能性があります。 JSON シリアライゼーションの詳細については、JSON シリアライゼーションの概要を参照してください。
また、YAML や Apache Avro など、さらに多くのシリアライゼーションフォーマットをサポートするコミュニティ主導のライブラリも存在します。
代替フォーマットおよびカスタムの実験的シリアライゼーションフォーマットの詳細については、カスタムシリアライゼーションフォーマットを参照してください。
サポートされているシリアライゼーション型
Kotlin シリアライゼーションは、すべてのプリミティブ型や、List 型など Kotlin 標準ライブラリのほとんどの複合型を含む、さまざまな組み込み型をサポートしています。 詳細については、組み込み型のシリアライズを参照してください。
さらに、@Serializable アノテーションが付加されたクラスはシリアライゼーションを完全にサポートしており、クラスインスタンスと JSON などのフォーマットとの相互変換が可能です。 詳細については、クラスのシリアライズを参照してください。
次のステップ
- シリアライゼーション入門チュートリアルで Kotlin シリアライゼーションの基本を学ぶ。
- Kotlin シリアライゼーションがプリミティブ、コレクション、その他の組み込み型をどのように処理するかを確認する。
- JSON シリアライゼーションの概要で、より複雑な JSON シリアライゼーションのシナリオを探索する。
- クラスのシリアライズを確認し、クラスをシリアライズする方法や
@Serializableアノテーションのデフォルトの動作を変更する方法を学ぶ。 - シリアライザーの作成と使用で、生成されたシリアライザーを取得する方法、カスタムシリアライザーを作成する方法、およびシリアライザーを適用する方法を学ぶ。
- ポリモーフィックなクラスのシリアライズで、共通の基底型を通じて異なる型をシリアライズする方法を確認する。
- カスタムシリアライゼーションフォーマットで、カスタムフォーマットの作成方法を学ぶ。
- CBOR や ProtoBuf などの実験的シリアライゼーションフォーマットを探索する。
