Serialización de Kotlin

Overview

El controlador Kotlin admite el kotlinx.serialization Biblioteca para serializar y deserializar objetos Kotlin.

El controlador proporciona un serializador Bson eficiente que puede utilizar con clases marcadas como @Serializable para manejar la serialización de objetos Kotlin en datos BSON.

También puede instalar la bson-kotlinx biblioteca para admitir códecs personalizados con configuraciones para codificar valores predeterminados, codificar valores nulos y definir discriminadores de clase.

Aunque puedes usar el controlador de Kotlin con la librería de serialización de Kotlin Json, el serializador Json no admite directamente tipos de valores BSON como ObjectId. Debes proporcionar un serializador personalizado que pueda gestionar la conversión entre BSON y JSON.

Agregue la serialización de Kotlin a su proyecto

El soporte para la serialización en el controlador Kotlin depende de la biblioteca de serialización oficial de Kotlin.

Seleccione una de las siguientes pestañas para ver cómo agregar las dependencias de serialización a su proyecto mediante el uso de Gradle y Maven administradores de paquetes:

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>

Anotar clases de datos

Para declarar una clase como serializable, anote sus clases de datos Kotlin con la anotación @Serializable del marco de serialización Kotlin.

Puedes usar tus clases de datos en tu código con normalidad después de marcarlas como serializables. El controlador y el framework de serialización de Kotlin gestionan la serialización y deserialización de BSON.

Este ejemplo muestra una clase de datos simple anotada con lo siguiente:

• @Serializable para marcar la clase como serializable.

• @SerialName Para especificar el nombre de las propiedades id y manufacturer en el documento BSON. Esto puede usarse en lugar de las anotaciones @BsonId y @BsonProperty, que no son compatibles con las clases serializables.

• @Contextual Para marcar la propiedad BSON id y usar la propiedad integrada ObjectIdSerializer. Esta anotación es necesaria para que los tipos BSON se serialicen correctamente.

@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
)

Para obtener más información sobre las clases serializables y las clases de anotación disponibles,consulte la documentación oficial de serialización de Kotlin.

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,
)

Personalizar la configuración del serializador

Puede utilizar la clase KotlinSerializerCodec del paquete org.bson.codecs.kotlinx para crear un códec para sus clases de datos @Serializable y personalizar lo que se almacena.

Utilice la clase BsonConfiguration para definir la configuración, incluso si desea codificar valores predeterminados, codificar valores nulos o definir discriminadores de clase.

Para crear un códec personalizado, instale la dependencia bson-kotlinx en su proyecto. Seleccione una de las siguientes pestañas para ver cómo agregar la dependencia a su proyecto usando los administradores de paquetes Gradle y 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>

Luego, puede definir su códec utilizando el método KotlinSerializerCodec.create() y agregarlo al registro.

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
)