Kotlin 直列化

Overview

Kotlin ドライバーは、 Kotlin オブジェクトを直列化および逆直列化するための kotlinx.serializationライブラリをサポートしています。

このドライバーは効率的なBsonシリアライザーを提供し、 @Serializableとしてマークされたクラスで使用して、 Kotlin オブジェクトの BSON データへの直列化を処理します。

また、 bson-kotlinxライブラリをインストールして、デフォルトのエンコード、null のエンコード、クラス弁別子を定義する構成でカスタム コーデックをサポートすることもできます。

Kotlin ドライバーは Kotlin シリアル化Jsonライブラリで使用できますが、 JsonシリアライザーはObjectIdなどの BSON 値型を直接サポートしていません。 BSON と JSON の間の変換を処理できるカスタム シリアライザーを提供する必要があります。

Kotlin 直列化をプロジェクトに追加する

Support for serialization in the Kotlin driver depends on the official Kotlin serialization library.

GradleとMavenパッケージ マネージャーを使用してプロジェクトにシリアル化の依存関係を追加する方法を確認するには、次のタブから選択します。

implementation("org.jetbrains.kotlinx:kotlinx-serialization-core:1.6.0")
implementation("org.mongodb:bson-kotlinx:5.0.0")

<dependency>
    <groupId>org.jetbrains.kotlinx</groupId>
    <artifactId>kotlinx-serialization-core</artifactId>
    <version>1.6.0</version>
</dependency>
<dependency>
    <groupId>org.mongodb</groupId>
    <artifactId>bson-kotlinx</artifactId>
    <version>5.0.0</version>
</dependency>

データクラスの注釈

クラスをシリアル化可能として宣言するには、 Kotlin シリアル化フレームワークからの@Serializableアノテーションで Kotlin データクラスを注釈を付けます。

データ クラスは、シリアル化可能としてマークすると、コード内で通常どおり使用できます。 Kotlin ドライバーと Kotlin 直列化フレームワークは BSON の直列化と逆直列化を処理します。

この例では、次の注釈が付けられた単純なデータ クラスを示しています。

• @Serializable クラスをシリアル化可能なものとしてマークします。

• @SerialName で、BSON ドキュメント内の プロパティと プロパティの名前を指定します。idmanufacturerこれは、シリアル化可能なクラスでサポートされていない@BsonIdと@BsonPropertyアノテーションの代わりに使用できます。

• @Contextual BSON idプロパティをマークし、組み込みのObjectIdSerializerを使用します。 この注釈は、BSON types を正しく直列化するのに必要です。

@Serializable
data class PaintOrder(
    @SerialName("_id") // Use instead of @BsonId
    @Contextual val id: ObjectId?,
    val color: String,
    val qty: Int,
    @SerialName("brand")
    val manufacturer: String = "Acme" // Use instead of @BsonProperty
)

For more information on serializable classes and available annotation classes, see the official Kotlin Serialization documentation.

object InstantAsBsonDateTime : KSerializer<Instant> {
    override val descriptor: SerialDescriptor = PrimitiveSerialDescriptor("InstantAsBsonDateTime", PrimitiveKind.LONG)
    override fun serialize(encoder: Encoder, value: Instant) {
        when (encoder) {
            is BsonEncoder -> encoder.encodeBsonValue(BsonDateTime(value.toEpochMilliseconds()))
            else -> throw SerializationException("Instant is not supported by ${encoder::class}")
        }
    }
    override fun deserialize(decoder: Decoder): Instant {
        return when (decoder) {
            is BsonDecoder -> Instant.fromEpochMilliseconds(decoder.decodeBsonValue().asDateTime().value)
            else -> throw SerializationException("Instant is not supported by ${decoder::class}")
        }
    }
}

@Serializable
data class PaintOrder(
    val color: String,
    val qty: Int,
    @Serializable(with = InstantAsBsonDateTime::class)
    val orderDate: Instant,
)

シリアライザー構成をカスタマイズする

org.bson.codecs.kotlinxパッケージのKotlinSerializerCodecクラスを使用して、 @Serializableデータ クラスのコーデックを作成し、保存する内容をカスタマイズできます。

BsonConfigurationクラスを使用して、デフォルトをエンコードするか、null をエンコードするか、クラス弁別子を定義するかなどの構成を定義します。

カスタム コーデックを作成するには、プロジェクトにbson-kotlinx依存関係をインストールします。 GradleとMavenパッケージ マネージャーを使用してプロジェクトに依存関係を追加する方法を確認するには、次のタブから を選択します。

implementation("org.mongodb:bson-kotlinx:5.0.0")

<dependency>
    <groupId>org.jetbrains.kotlinx</groupId>
    <artifactId>bson-kotlinx</artifactId>
    <version>5.0.0</version>
</dependency>

Then, you can define your codec using the KotlinSerializerCodec.create() method and add it to the registry.

import org.bson.codecs.configuration.CodecRegistries
import org.bson.codecs.kotlinx.BsonConfiguration
import org.bson.codecs.kotlinx.KotlinSerializerCodec

val myCustomCodec = KotlinSerializerCodec.create<PaintOrder>(
    bsonConfiguration = BsonConfiguration(encodeDefaults = false)
)
val registry = CodecRegistries.fromRegistries(
    CodecRegistries.fromCodecs(myCustomCodec), collection.codecRegistry
)