Serialização Kotlin

Visão geral

O driver do Kotlin suporta a biblioteca kotlinx.serialization para serializar e desserializar objetos do Kotlin.

O driver fornece um serializador Bson eficiente que você pode usar com classes marcadas como @Serializable para lidar com a serialização de objetos Kotlin em dados BSON.

Você também pode instalar a biblioteca bson-kotlinx para oferecer suporte a codecs personalizados com configurações para codificar padrões, codificar nulos e definir discriminadores de classe.

Embora você possa usar o driver Kotlin com a biblioteca de Json de serialização Kotlin, o serializador Json não oferece suporte direto a tipos de valor BSON, como ObjectId. Você deve fornecer um serializador personalizado que possa lidar com a conversão entre BSON e JSON.

Adicionar serialização de Kotlin ao seu projeto

O suporte para serialização no driver Kotlin depende da biblioteca oficial de serialização do Kotlin .

Selecione uma das abas abaixo para ver como adicionar as dependências de serialização ao seu projeto usando os gerenciadores de pacotes Gradle e 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>

Anotar classes de dados

Para declarar uma classe como serializável, anote suas classes de dados do Kotlin com a anotação @Serializable da estrutura de serialização do Kotlin.

Você pode utilizar suas classes de dados em seu código normalmente após marcá-las como serializáveis. O driver do Kotlin e a estrutura de serialização do Kotlin gereciam a serialização e desserialização do BSON.

Este exemplo mostra uma classe de dados simples anotada com o seguinte:

• @Serializable para marcar a classe como serializável.

• @SerialName para especificar o nome das propriedades id e manufacturer no documento BSON. Pode ser usado no lugar das anotações do @BsonId e @BsonProperty, que não são compatíveis com classes serializáveis.

• @Contextual para marcar a propriedade BSON id para utilizar o ObjectIdSerializer embutido. Esta anotação é necessária para que os tipos BSON sejam serializados corretamente.

@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 mais informações sobre classes serializáveis e classes de anotação disponíveis, consulte a documentação Serialização oficial 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 a Configuração do Serializador

Você pode utilizar a classe KotlinSerializerCodec do pacote org.bson.codecs.kotlinx para criar um codec para suas classes de dados do @Serializable e personalizar o que é armazenado.

Use a classe BsonConfiguration para definir a configuração, incluindo se deseja codificar padrões, codificar nulos ou definir discriminadores de classe.

Para criar um codec personalizado, instale a dependência do bson-kotlinx no seu projeto. Selecione uma das abas abaixo para ver como adicionar a dependência ao seu projeto usando os gerenciadores de pacotes Gradle e 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>

Em seguida, você pode definir seu codec usando o método KotlinSerializerCodec.create() e adicioná-lo ao 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
)