Introducción al controlador de sincronización de Kotlin

Crea un proyecto de Kotlin.

Primero, asegúrese de que su sistema tenga Kotlin instalado y ejecutándose en JDK 1.8 o posterior.

Le recomendamos que utilice un entorno de desarrollo integrado (IDE) como IntelliJ IDEA o Eclipse IDE para configurar Gradle o Maven para compilar y ejecutar su proyecto.

Para obtener más información sobre cómo comenzar a usar Kotlin y crear su primer proyecto, consulte Comenzar a usar Kotlin/JVM en la documentación del lenguaje Kotlin.

Añade la Bill of Materials del Driver.

En su IDE, cree un nuevo proyecto Maven o Gradle. Agregue la Lista de Materiales (BOM) de los artefactos de la JVM de MongoDB a su proyecto para organizar las versiones de las dependencias. La BOM simplifica la gestión de dependencias, garantizando el mantenimiento de versiones consistentes y compatibles, como entre el controlador de sincronización de Kotlin y la biblioteca principal de controladores. Use la BOM para evitar conflictos de versiones y simplificar las actualizaciones.

Seleccione entre las siguientes opciones Maven y Gradle pestañas para ver instrucciones para agregar la lista de materiales para cada administrador de dependencia:

<dependencyManagement>
    <dependencies>
        <dependency>
            <groupId>org.mongodb</groupId>
            <artifactId>mongodb-driver-bom</artifactId>
            <version>5.6.1</version>
            <type>pom</type>
            <scope>import</scope>
        </dependency>
    </dependencies>
</dependencyManagement>

dependencies {
    implementation(platform("org.mongodb:mongodb-driver-bom:5.6.1"))
}

Para ver una lista de dependencias que gestiona el BOM, consulta la mongodb-driver-bom dependency listing en el sitio web de Maven Repositorio.

Agrega MongoDB como una dependencia.

Si utilizas Gradle para administrar tus paquetes, agrega la siguiente entrada a tu lista de dependencias de build.gradle.kts:

dependencies {
    implementation("org.mongodb:mongodb-driver-kotlin-sync")
}

Si está utilizando Maven para administrar sus paquetes, agregue la siguiente entrada a su lista de dependencias pom.xml:

<dependencies>
    <dependency>
        <groupId>org.mongodb</groupId>
        <artifactId>mongodb-driver-kotlin-sync</artifactId>
    </dependency>
</dependencies>

Dado que instaló la BOM, puede omitir una versión en la entrada de dependencia del controlador de sincronización de Kotlin. La versión que especifique en la BOM determinará las versiones de dependencia que se instalarán.

Después de configurar tus dependencias, se debe garantizar de que estén disponibles para el proyecto ejecutando el administrador de dependencias y actualizando el proyecto en el IDE.

Agregue las dependencias de la biblioteca de serialización.

Para permitir que el controlador convierta entre objetos Kotlin y BSON, el formato de datos de los documentos en MongoDB, también debe agregar uno o ambos de los siguientes paquetes de serialización a su aplicación:

• bson-kotlinx (Recomendado)

• bson-kotlin

Si está utilizando Gradle para administrar sus paquetes, agregue una de las siguientes entradas a su lista de dependencias build.gradle.kts:

implementation("org.mongodb:bson-kotlinx")
// OR
implementation("org.mongodb:bson-kotlin")

Si está utilizando Maven para administrar sus paquetes, agregue una de las siguientes entradas a su lista de dependencias pom.xml:

<dependency>
    <groupId>org.mongodb</groupId>
    <artifactId>bson-kotlinx</artifactId>
</dependency>
<!--OR-->
<dependency>
    <groupId>org.mongodb</groupId>
    <artifactId>bson-kotlin</artifactId>
</dependency>

Después de configurar tus dependencias, se debe garantizar de que estén disponibles para el proyecto ejecutando el administrador de dependencias y actualizando el proyecto en el IDE.

Para obtener más información sobre estos paquetes, consulte Serialización de datos.

Cree una implementación gratuita de MongoDB en Atlas.

Complete la guía de inicio de MongoDB para configurar una nueva cuenta de Atlas y cargar datos de muestra en una nueva implementación de MongoDB de nivel gratuito.

Guarda tus credenciales.

Después de crear el usuario de su base de datos, guarde el nombre de usuario y la contraseña del usuario en una ubicación segura para usarlos en un próximo paso.

Encuentra tu cadena de conexión de MongoDB Atlas.

Para recuperar la cadena de conexión para la implementación que creó en el paso anterior, inicie sesión en su cuenta de Atlas y navegue a la página Clusters bajo la sección Database. Haga clic en el botón Connect para la nueva implementación.

Si aún no tienes un usuario de base de datos configurado, MongoDB te pedirá que crees y configures un nuevo usuario.

Haga clic en el botón Drivers debajo de la sección Connect to your application y seleccione "Kotlin" en el menú de selección Driver y la versión que mejor coincida con la versión que instaló en el menú de selección Version.

Asegúrate de que la opción View full code sample esté desmarcada para ver solo la cadena de conexión.

Copie su cadena de conexión.

Se debe hacer clic en el botón a la derecha de la cadena de conexión para copiarla al portapapeles, como se muestra en la siguiente captura de pantalla:

Actualiza el marcador de posición de la contraseña.

Pega esta cadena de conexión en un archivo en tu editor de texto preferido y reemplaza el marcador de posición <db_password> con la contraseña de tu usuario de base de datos. La cadena de conexión ya está completada con el nombre de usuario de tu usuario de base de datos.

Guarda este archivo en una ubicación segura para usarlo en el siguiente paso.

Crea el archivo de aplicación.

Crea un archivo llamado DemoDataClassExample.kt en tu proyecto.

Copie el siguiente código de muestra en el archivo y reemplace el valor del marcador de posición <connection URI string> con la cadena de conexión de MongoDB Atlas que guardó en el paso anterior.

import com.mongodb.client.model.Filters.eq
import com.mongodb.kotlin.client.MongoClient
// Create data class to represent a MongoDB document
data class Movie(val title: String, val year: Int, val directors: List<String>)
fun main() {
    // Replace the placeholder with your MongoDB deployment's connection string
    val uri = "<connection string URI>"
    val mongoClient = MongoClient.create(uri)
    val database = mongoClient.getDatabase("sample_mflix")
    val collection = database.getCollection<Movie>("movies")
    // Find a document with the specified title
    val doc = collection.find(eq(Movie::title.name, "Before Sunrise")).firstOrNull()
    if (doc != null) {
        // Print the matching document
        println(doc)
    } else {
        println("No matching documents found.")
    }
}

Ejecute la aplicación.

Cuando se ejecuta la aplicación, se imprimen los detalles de un documento de película que coincide con la consulta, como se muestra en la siguiente salida:

Movie(title=Before Sunrise, year=1995, directors=[Richard Linklater])

Si no ve ningún resultado o recibe un error, compruebe si incluyó la cadena de conexión correcta en su aplicación. Además, confirme que cargó correctamente el conjunto de datos de muestra en su clúster de MongoDB Atlas.

Después de completar este paso, dispones de una aplicación funcional que utiliza el driver Kotlin sincronizar para conectarse a su clúster de MongoDB, ejecutar una query sobre los datos de muestra e imprimir el resultado.

Utilice la clase Documento para modelar datos (alternativa).

El paso anterior demuestra cómo ejecutar una consulta en una colección de muestra para recuperar datos mediante una clase de datos de Kotlin. Esta sección muestra cómo usar la clase Document para almacenar y recuperar datos de MongoDB.

En el archivo DemoDocumentExample.kt, pegue el siguiente código de ejemplo para ejecutar una consulta en su conjunto de datos de ejemplo en MongoDB Atlas. Reemplace el valor del marcador <connection URI string> con su cadena de conexión de MongoDB Atlas:

import com.mongodb.client.model.Filters.eq
import com.mongodb.kotlin.client.MongoClient
import org.bson.Document
fun main() {
    // Replace the placeholder with your MongoDB deployment's connection string
    val uri = "<connection URI string>"
    val mongoClient = MongoClient.create(uri)
    val database = mongoClient.getDatabase("sample_mflix")
    val collection = database.getCollection<Document>("movies")
    // Find a document with the specified title
    val doc = collection.find(eq("title", "Before Sunrise")).firstOrNull()
    if (doc != null) {
        // Print the matching document
        println(doc)
    } else {
        println("No matching documents found.")
    }
}

Cuando se ejecuta la aplicación, se imprimen los detalles de un documento de película que coincide con la consulta, como se muestra en la siguiente salida:

Document{{_id=..., plot=A young man and woman ..., genres=[Drama, Romance], ...}}

Si no ve ningún resultado o recibe un error, compruebe si incluyó la cadena de conexión correcta en su aplicación. Además, confirme que cargó correctamente el conjunto de datos de muestra en su clúster de MongoDB Atlas.