{"id":13174,"date":"2022-05-03T09:49:42","date_gmt":"2022-05-03T16:49:42","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=13174"},"modified":"2023-05-22T08:01:08","modified_gmt":"2023-05-22T15:01:08","slug":"couchbase-kotlin-api-released","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/es\/couchbase-kotlin-api-released\/","title":{"rendered":"Dise\u00f1o de la API Kotlin de Couchbase\u00a0"},"content":{"rendered":"

Me complace anunciar el lanzamiento de la versi\u00f3n 1.0 del SDK de Couchbase Kotlin. La verdad es que estoy encantado. Este proyecto ha sido un trabajo de amor. Despu\u00e9s de trabajar con Java durante d\u00e9cadas, tengo un nuevo lenguaje favorito.<\/span><\/p>\n

En este art\u00edculo, dir\u00e9 algunas cosas buenas sobre Kotlin, y luego mostrar\u00e9 c\u00f3mo usar el SDK de Couchbase Kotlin para conectarse a la base de datos como servicio de Capella. Finalmente, compartir\u00e9 algunas decisiones de dise\u00f1o que dieron forma a la API p\u00fablica del SDK. Espero que te quedes para esta \u00faltima parte, especialmente si est\u00e1s dise\u00f1ando la API de tu propia librer\u00eda Kotlin.<\/span><\/p>\n

\u00bfPor qu\u00e9 Kotlin?<\/span><\/h2>\n

Kotlin cambi\u00f3 nuestra forma de pensar sobre la programaci\u00f3n as\u00edncrona en la JVM. Las coroutines y las funciones de suspensi\u00f3n de Kotlin son la prueba de que la programaci\u00f3n reactiva podr\u00eda ser un pelda\u00f1o hacia algo mejor, algo que no requiera sacrificar c\u00f3digo legible en el altar de la escalabilidad. Kotlin ha demostrado que hay una forma mejor de escribir c\u00f3digo as\u00edncrono de alto rendimiento, y no necesitamos esperar a las fibras y continuaciones del Proyecto Loom.<\/span><\/p>\n

Capella + Kotlin<\/span><\/h2>\n

Couchbase Capella<\/span><\/a> es la base de datos como servicio (DBaaS) para Couchbase Server. Es una tecnolog\u00eda s\u00f3lida, y cuando me registr\u00e9 para una prueba gratuita hace unas semanas, el proceso fue completamente indoloro.<\/span><\/p>\n

Digamos que usted tiene un cluster de prueba Capella y ha a\u00f1adido su IP a la lista de permitidos, y ha creado un usuario de base de datos que puede leer el pre-instalado viaje-muestra<\/em> cubo. A continuaci\u00f3n te explicamos c\u00f3mo conectarte a tu cl\u00faster utilizando el SDK de Kotlin:\u00a0<\/span><\/p>\n

 \u00a0\u00a0\u00a0val address = \"--your-cluster--.cloud.couchbase.com\"\r\n\u00a0\u00a0\u00a0\u00a0val cluster = Cluster.connect(\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0connectionString = \"couchbases:\/\/$address\",\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0username = \"harpo\",\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0password = \"swordfish\",\r\n\u00a0\u00a0\u00a0\u00a0)<\/pre>\n
Una vez que tenga un objeto Cluster, puede ejecutar una consulta N1QL:<\/span><\/p>\n
 \u00a0\u00a0\u00a0val queryResult = cluster\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0.query(\"SELECT * FROM `travel-sample` LIMIT 3\")\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0.execute()\r\n\u00a0\u00a0\u00a0\u00a0queryResult.rows.forEach { println(it) }\r\n\u00a0\u00a0\u00a0\u00a0println(queryResult.metadata)<\/pre>\n
O consiga una referencia a una Colecci\u00f3n y lea un documento espec\u00edfico:<\/span><\/p>\n
 \u00a0\u00a0\u00a0val collection = cluster\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0.bucket(\"travel-sample\")\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0.defaultCollection()\r\n\r\n\u00a0\u00a0\u00a0\u00a0val getResult = collection.get(\"airline_10\")\r\n\u00a0\u00a0\u00a0\u00a0println(getResult)\r\n\u00a0\u00a0\u00a0\u00a0println(getResult.contentAs<Map<String, Any?>>())<\/pre>\n
La versi\u00f3n completa de este ejemplo se incluye en el archivo <\/span>Documentaci\u00f3n del SDK de Kotlin<\/span><\/a>junto con varios otros.<\/span><\/p>\n
Decisiones de dise\u00f1o de la API del SDK<\/span><\/h2>\n
El resto de este art\u00edculo est\u00e1 dedicado a compartir algunas notas sobre las decisiones que tomamos al dise\u00f1ar la API p\u00fablica del SDK Kotlin de Couchbase. En algunos casos, comparar\u00e9 el SDK de Kotlin con su hermano mayor, el SDK de Java.<\/span><\/p>\n
Extensi\u00f3n frente a SDK independiente<\/span><\/h3>\n
El SDK de Couchbase Kotlin depende del mismo core-io<\/em> como el SDK de Java, pero no depende de \u00e9ste.<\/span><\/p>\n
Alternativas rechazadas<\/span><\/h4>\n
Nos planteamos dar soporte a Kotlin proporcionando funciones de extensi\u00f3n para las clases del SDK de Java. Por desgracia, algunas decisiones de dise\u00f1o que tomamos para el SDK de Java no se trasladaron bien a Kotlin y no se pudieron compensar solo con funciones de extensi\u00f3n.<\/span><\/p>\n
Tambi\u00e9n consideramos la posibilidad de proporcionar una envoltura nativa completa de la API de Kotlin que simplemente delegara en el SDK de Java, pero nos preocupaba que tener dos versiones de todas las clases (una para Kotlin y otra para Java) resultara confuso para los usuarios.<\/span><\/p>\n
\u00a1Suspender o reventar!<\/span><\/h3>\n
El SDK de Kotlin no proporciona una API de bloqueo; los m\u00e9todos que realizan E\/S de red son todos suspender<\/em> funciones.<\/span><\/p>\n
Alternativas rechazadas<\/span><\/h4>\n
Consideramos la posibilidad de a\u00f1adir variantes \"bloqueantes\" de Cluster, Bucket, Scope, Collection, etc., pero parece algo que los usuarios pueden hacer por s\u00ed mismos con muy poco esfuerzo, simplemente envolviendo las llamadas a las funciones de suspensi\u00f3n con runBlocking<\/em>.<\/span><\/p>\n
Par\u00e1metros opcionales<\/span><\/h3>\n
Como Java no tiene par\u00e1metros opcionales, el SDK Java de Couchbase los emula con un \"bloque de opciones\" construido usando el patr\u00f3n constructor.\u00a0<\/span><\/p>\n
En el siguiente ejemplo, withExpiry<\/em>\u00a0es un par\u00e1metro booleano opcional cuyo valor por defecto es false. Los fragmentos de c\u00f3digo muestran un sitio de llamada en el que el desarrollador desea pasar true en su lugar.<\/span><\/p>\n
Java:<\/span><\/p>\n
 \u00a0\u00a0\u00a0GetOptions options = GetOptions.getOptions().withExpiry(true);\r\n\u00a0\u00a0\u00a0\u00a0collection.get(documentId, options);<\/pre>\n
El SDK de Kotlin aprovecha el soporte nativo de Kotlin para par\u00e1metros por defecto:<\/span><\/p>\n
Kotlin:<\/span><\/p>\n
\u00a0\u00a0\u00a0\u00a0collection.get(documentId, withExpiry = true)<\/pre>\n
Alternativas rechazadas<\/span><\/h4>\n
Tambi\u00e9n consideramos la posibilidad de utilizar bloques de opciones espec\u00edficos de m\u00e9todo para Kotlin, que habr\u00edan tenido un aspecto similar:<\/span><\/p>\n
\u00a0\u00a0\u00a0\u00a0collection.get(documentId, GetOptions(withExpiry = true))<\/pre>\n
Se rechaz\u00f3 porque era engorroso para los usuarios y dif\u00edcil de mantener para los desarrolladores del SDK (considere el impacto de a\u00f1adir una nueva opci\u00f3n com\u00fan a todos los m\u00e9todos).<\/span><\/p>\n
Tambi\u00e9n consideramos la posibilidad de utilizar un lambda\/mini-DSL para las opciones, que habr\u00eda sido algo as\u00ed:<\/span><\/p>\n
 \u00a0\u00a0\u00a0collection.get(documentId) {\r\n\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0\u00a0withExpiry = true\r\n\u00a0\u00a0\u00a0\u00a0}<\/pre>\n
Esta era la m\u00e1s tentadora de las alternativas rechazadas porque habr\u00eda sido excelente para la compatibilidad binaria (las firmas de los m\u00e9todos no cambiar\u00edan al a\u00f1adir nuevos par\u00e1metros opcionales). Tambi\u00e9n \"se siente como Kotlin\". Fue rechazada porque:<\/span><\/p>\n