Overview
En esta guía, puede aprender cómo almacenar y recuperar datos en el controlador Kotlin de MongoDB utilizando clases de datos Kotlin.
Serializar y deserializar una clase de datos
El controlador admite de forma nativa la codificación y decodificación de clases de datos Kotlin para operaciones de lectura y escritura en MongoDB mediante el registro de códecs predeterminado. Este registro es una colección de clases denominadas códecs que definen cómo codificar y decodificar tipos de Kotlin y Java.
Clase de datos de ejemplo
Los ejemplos de código de esta sección hacen referencia a la siguiente clase de datos de muestra, que describe un dispositivo de almacenamiento de datos:
data class DataStorage(val productName: String, val capacity: Double)
Insertar una clase de datos
Puedes insertar un DataStorage instancia como se muestra en el siguiente código:
val collection = database.getCollection<DataStorage>("data_storage") val record = DataStorage("tape", 5.0) collection.insertOne(record)
Recuperar una clase de datos
Puede recuperar documentos como instancias DataStorage e imprimirlos como se muestra en el siguiente código:
val collection = database.getCollection<DataStorage>("data_storage_devices") // Retrieve and print the documents as data classes val resultsFlow = collection.find() resultsFlow.collect { println(it) }
DataStorage(productName=tape, capacity=5.0)
Debe especificar una clase para los documentos devueltos desde una colección, incluso si es diferente de la clase que especificó al recuperar la colección.
El siguiente ejemplo actualiza el documento representado por la clase de datos DataStorage en el ejemplo anterior y devuelve el documento actualizado como tipo NewDataStorage. La operación añade el campo releaseDate al documento con un valor name de tape:
// Define a data class for returned documents data class NewDataStorage( val productName: String, val capacity: Double, val releaseDate: LocalDate ) val filter = Filters.eq(DataStorage::productName.name, "tape") val update = Updates.currentDate("releaseDate") val options = FindOneAndUpdateOptions().returnDocument(ReturnDocument.AFTER) // Specify the class for returned documents as the type parameter in withDocumentClass() val result = collection .withDocumentClass<NewDataStorage>() .findOneAndUpdate(filter, update, options) println("Updated document: ${result}")
Updated document: NewDataStorage(productName=tape, capacity=5.0, releaseDate=2023-06-15)
Para obtener más información sobre esta función, consulte Especifique el tipo de retorno en la guía Bases de datos y colecciones.
Especificar la conversión de componentes mediante anotaciones
Esta sección describe las anotaciones que puede utilizar para configurar el comportamiento de serialización de las clases de datos y proporciona un ejemplo para demostrar el comportamiento de la anotación.
Puede utilizar las siguientes anotaciones en las clases de datos:
Nombre de la anotación | Descripción |
|---|---|
| Marca una propiedad para serializar como la propiedad _id. |
| Especifica un nombre de campo de documento personalizado al convertir el campo de clase de datos a BSON. |
| Especifica el tipo BSON que MongoDB utiliza para almacenar el valor. Use esta anotación solo cuando necesite almacenar un valor con un tipo BSON diferente al de la propiedad de la clase de datos. ADVERTENCIA: Su código puede generar una excepción si incluye la |
Para obtener información de referencia sobre estas anotaciones de propiedad, consulte org.bson.codecs.pojo.annotations .
Ejemplo de clase de datos anotados
Los ejemplos de código de esta sección hacen referencia a la siguiente clase de datos de muestra, que describe un dispositivo de red:
data class NetworkDevice( val deviceId: String, val name: String, val deviceType: String )
Insertar una clase de datos anotada
Puede insertar una instancia NetworkDevice como se muestra en el siguiente código:
val collection = database.getCollection<NetworkDevice>("network_devices") // Insert the record val deviceId = ObjectId().toHexString() val device = NetworkDevice(deviceId, "Enterprise Wi-fi", "router") collection.insertOne(device)
El documento insertado en MongoDB debería parecerse al siguiente:
{ _id: ObjectId("fedc..."), name: 'Enterprise Wi-fi', type: 'router' }
Recuperar una clase de datos anotados
Puede recuperar documentos como instancias NetworkDevice e imprimirlos como se muestra en el siguiente código:
val collection = database.getCollection<NetworkDevice>("network_devices") // Return all documents in the collection as data classes val resultsFlow = collection.find() resultsFlow.collect { println(it) }
NetworkDevice(deviceId=645cf..., name=Enterprise Wi-fi, deviceType=router)
Operaciones con tipos recursivos
El controlador admite de forma nativa la codificación y decodificación de clases de datos definidas recursivamente sin causar recursión en tiempo de ejecución. Esta compatibilidad se extiende a ciclos de múltiples tipos de clases de datos en las definiciones de tipo. El siguiente código proporciona un ejemplo de diseño de una clase de datos recursiva:
data class DataClassTree( val content: String, val left: DataClassTree?, val right: DataClassTree? )
Puedes realizar operaciones de lectura y escritura en clases de datos definidas recursivamente de la misma forma que lo harías con otras clases de datos. El siguiente código muestra cómo ejecutar una operación de búsqueda en una colección de tipos DataClassTree:
val collection = database.getCollection<DataClassTree>("myCollection") val filter = Filters.eq("left.left.right.content", "high german") val resultsFlow = collection.find(filter) resultsFlow.collect { println(it) }
DataClassTree(content=indo-european, left=DataClassTree(content=germanic, left=DataClassTree(content=german, left=null, right=DataClassTree(content=high german, ...)), right=...)