Couchbase Server and Couchbase Mobile together with Node.js

Crear aplicaciones web y aplicaciones móviles que compartan los mismos datos suele considerarse una tarea ardua. ¿Cómo diseñas tu aplicación web para que encaje con tu aplicación móvil y viceversa? ¿Qué pasa cuando quieres usar Couchbase para sincronizar tus datos entre dispositivos móviles en tiempo real, pero también tenerlos disponibles en un navegador web?

Hay varias maneras de llevar a cabo esta tarea con Couchbase, pero vamos a explorar una de mis favoritas en esta guía en particular. Vamos a utilizar un SDK del lado del servidor para consultar datos y una API RESTful para escribir datos.

Requisitos

Para este ejemplo en particular vamos a usando Node.jspero realmente no importa el lenguaje que utilices siempre y cuando haya un SDK de Couchbase Server disponible. Los requisitos para este proyecto son los siguientes:

Servidor Couchbase 4.1+
Pasarela de sincronización Couchbase 1.3+
Node.js 4.0+

Desde el punto de vista de los componentes, Couchbase Server albergará todos nuestros datos. Además, será responsable del trabajo pesado que conlleva la consulta. No escribiremos directamente a Couchbase Server desde el SDK de Node.js, sino que usaremos Couchbase Sync Gateway. Sync Gateway guardará los datos en Couchbase Server y los pasará entre dispositivos móviles. Node.js será la capa de aplicación web.

No vamos a construir una aplicación móvil en este ejemplo en particular, pero una aplicación móvil se comunicaría con Sync Gateway y se utilizaría de manera similar. Las aplicaciones móviles no se comunican directamente con Couchbase Server.

Configuración de Couchbase Server y Couchbase Sync Gateway

Antes de poder desarrollar la aplicación, es necesario instalar y configurar tanto Couchbase Server como Couchbase Sync Gateway.

Descargar Couchbase Server para tu sistema operativo y procede a su instalación, asegurándote de que el servicio de consultas (N1QL) está habilitado. Para este ejemplo voy a utilizar un bucket de Couchbase llamado ejemplopero siéntete libre de llamarlo como quieras.

Con el ejemplo debe añadirse un índice N1QL para poder consultar los datos. Desde el Query Workbench o CBQ, ejecute lo siguiente:

CREATE PRIMARY INDEX ON `example` USING GSI;

1	CREAR PRIMARIO ÍNDICE EN `ejemplo` USO DE GSI;

Query Workbench está disponible en Couchbase Server Enterprise Edition, pero la herramienta de línea de comandos CBQ está disponible en ambas adiciones.

En este punto Couchbase Server está listo para funcionar.

Descarga e instala Couchbase Sync Gateway para tu sistema operativo. Sync Gateway en sí no estará configurado, pero tendremos un archivo de configuración del proyecto con el siguiente aspecto en ejecución:

{
    "log":["CRUD+", "REST+", "Changes+", "Attach+"],
    "databases": {
        "example": {
            "server":"http://localhost:8091",
            "sync":`
                function (doc) {
                    channel (doc.channels);
                }
            `,
            "users": {
                "GUEST": {
                    "disabled": false,
                    "admin_channels": ["*"]
                }
            }
        }
    },
    "CORS": {
        "Origin": ["http://localhost:3000"],
        "LoginOrigin": ["http://localhost:3000"],
        "Headers": ["Content-Type"],
        "MaxAge": 17280000
    }
}

{

"log":["CRUD+", "REST+", "Cambios+", "Adjuntar+"],

"bases de datos": {

"ejemplo": {

"servidor":"http://localhost:8091",

"sync":`

función (doc) {

canal (doc.canales);

}

"usuarios": {

"INVITADO": {

"desactivado": falso,

"admin_canales": ["*"]

}

"CORS": {

"Origen": ["http://localhost:3000"],

"LoginOrigin": ["http://localhost:3000"],

"Cabeceras": ["Tipo de contenido"],

"MaxAge": 17280000

}

Llamar al archivo anterior sync-gateway-config.json y almacenarlo en su proyecto. Básicamente, estamos diciendo a Sync Gateway que queremos conectarnos a un clúster de Couchbase Server en particular y utilizar el bucket ejemplo. Debido a que estaremos usando peticiones RESTful desde la misma máquina necesitamos permitir CORS en el puerto 3000.

Para simplificar las cosas, la lógica de sincronización permitirá que todos los documentos se transmitan sin reglas de lectura o escritura.

Creación de la aplicación web

Todavía no estamos ejecutando Sync Gateway, pero tanto Couchbase Server como Sync Gateway están listos para su uso. Ahora podemos centrarnos en crear nuestro proyecto Node.js.

El proyecto en sí va a ser un ejemplo muy simple. Vamos a crear una API RESTful con dos endpoints, uno para crear datos y otro para listar datos. El truco aquí es que un endpoint consultará Couchbase Server con el SDK de Node.js directamente y otro endpoint escribirá datos a Couchbase Sync Gateway a través de la API RESTful de Sync Gateway.

Antes de adelantarnos, empecemos a crear el proyecto.

Creación de un nuevo proyecto y arranque del código

Como estamos usando Node.js, todo se realizará desde el Símbolo del sistema (Windows) o Terminal (Mac y Linux). Usando uno de ellos, ejecuta lo siguiente:

npm init --y

1	npm init --y

El comando anterior creará un nuevo paquete.json para nuestro proyecto. Todas las dependencias de nuestro proyecto se almacenarán en este archivo.

A continuación ejecute lo siguiente para obtener todas las dependencias que necesitamos:

npm install couchbase express body-parser request --save

1	npm instale couchbase express cuerpo-analizador solicitar --guardar

Vamos a utilizar couchbase para comunicarse con nuestra base de datos, express para Express Framework, body-parser para aceptar datos del cuerpo en las solicitudes, y solicitar para hacer peticiones HTTP desde dentro de Node.js, no a Node.js.

En este punto podemos empezar a arrancar la aplicación.

Cree un archivo llamado index.js dentro del proyecto. Vamos a utilizarlo para toda nuestra aplicación. En aplicaciones más grandes o de producción podría considerar dividirlo en archivos más precisos para su mantenimiento, pero para este ejemplo está bien.

Abrir index.js e incluyen las siguientes importaciones:

var Couchbase = require("couchbase");
var Express = require("express");
var BodyParser = require("body-parser");
var Request = require("request");

var Couchbase = requiere("couchbase");

var Express = requiere("express");

var BodyParser = requiere("body-parser");

var Solicitar = requiere("solicitud");

Las dependencias que habíamos descargado anteriormente se han importado al proyecto. Sin embargo, no se han inicializado.

var app = Express();
var N1qlQuery = Couchbase.N1qlQuery;

app.use(BodyParser.json());
app.use(BodyParser.urlencoded({ extended: true }));

var aplicación = Express();

var N1qlQuery = Couchbase.N1qlQuery;

aplicación.utilice(BodyParser.json());

aplicación.utilice(BodyParser.urlencoded({ ampliado: verdadero }));

Las líneas anteriores inicializan Express Framework, preparan N1QL dentro de la aplicación, y habilitan la aceptación de datos codificados en JSON y URL dentro de los cuerpos de las peticiones.

Aunque N1QL está prácticamente listo para funcionar, no nos hemos conectado al cluster de servidores ni hemos abierto nuestro bucket. Esto se puede lograr de la siguiente manera:

var bucket = (new Couchbase.Cluster("couchbase://localhost")).openBucket("example");

1	var cubo = (nuevo Couchbase.Grupo("couchbase://localhost")).openBucket("ejemplo");

Una vez más, estamos utilizando un cubo que he llamado ejemplo en un paso anterior.

Finalmente, como última parte del bootstrapping de nuestro proyecto, podemos empezar a servir la aplicación:

var server = app.listen(3000, function() {
    console.log("Listening on port %s...", server.address().port);
});

var servidor = aplicación.escuche(3000, función() {

consola.registro("Escuchando en el puerto %s...", servidor.dirección().puerto);

});

Cuando se ejecute, la aplicación web será accesible desde http://localhost:3000 en un navegador web y en otros lugares.

Añadiendo el SDK Node.js de Couchbase y la lógica RESTful Sync Gateway

Como se mencionó anteriormente, esta aplicación va a seguir siendo simple para que sea fácil de entender. Sólo vamos a tener dos endpoints, uno que utiliza el SDK de Couchbase Server, y otro que utiliza la API RESTful de Sync Gateway.

Estos dos puntos finales tendrán el siguiente aspecto:

GET /list
POST /create

1 2	GET /lista POST /crear

Empezando por el /lista endpoint tenemos el siguiente código:

app.get("/list", function(req, res) {
    bucket.query(N1qlQuery.fromString("SELECT type, firstname, lastname FROM `" + bucket._name + "` WHERE type = 'person'"), function(error, result) {
        if(error) {
            return res.status(400).send(error);
        }
        res.send(result);
    });
});

aplicación.consiga("/lista", función(consulte, res) {

cubo.consulta(N1qlQuery.fromString("SELECT type, firstname, lastname FROM `" + cubo.Nombre + "WHERE type = 'person'"), función(error, resultado) {

si(error) {

devolver res.estado(400).enviar(error);

}

res.enviar(resultado);

});

Cuando se realiza una petición GET a este endpoint se ejecutará una consulta N1QL contra Couchbase Server. Esta consulta obtendrá el tipo, nombrey apellido de cada documento del bucket en cuestión, siempre y cuando dichos documentos tengan una propiedad tipo que es igual a persona. Si hay un error, devuelve un error al usuario, de lo contrario devuelve los datos que se recuperaron.

El siguiente endpoint hace uso de peticiones HTTP dentro de Node.js. Antes de saltar directamente al endpoint, puede tener sentido crear un método de ayuda para hacer estas peticiones:

var makePostRequest = function(url, body, callback) {
    Request.post(url, { json: body },
        function (error, response, body) {
            if (!error &amp;&amp; response.statusCode == 200) {
                callback(null, body);
            } else {
                callback(error, null);
            }
        }
    );
}

var makePostRequest = función(url, cuerpo, devolución de llamada) {

Solicitar.Correo electrónico:(url, { json: cuerpo },

función (error, respuesta, cuerpo) {

si (!error && respuesta.statusCode == 200) {

devolución de llamada(null, cuerpo);

} si no {

devolución de llamada(error, null);

}

);

}

El método anterior hará una petición POST contra una URL particular, pasando un objeto JavaScript como cuerpo. Si tiene éxito, la respuesta será devuelta, de lo contrario un error.

En makePostRequest puede verse en acción en lo que sigue:

app.post("/create", function(req, res) {
    if(!req.body.firstname) {
        return res.status(400).send({"status": "error", "message": "A firstname is required"});
    } else if(!req.body.lastname) {
        return res.status(400).send({"status": "error", "message": "A lastname is required"});
    }
    makePostRequest("http://localhost:4984/" + bucket._name + "/", {type: "person", firstname: req.body.firstname, lastname: req.body.lastname}, function(error, result) {
        if(error) {
            return res.status(400).send(error);
        }
        res.send(req.body);
    });
});

aplicación.Correo electrónico:("/crear", función(consulte, res) {

si(!consulte.cuerpo.nombre) {

devolver res.estado(400).enviar({"status": "error", "mensaje": "Se requiere un nombre"});

} si no si(!consulte.cuerpo.apellido) {

devolver res.estado(400).enviar({"status": "error", "mensaje": "Se requiere un apellido"});

}

makePostRequest("http://localhost:4984/" + cubo.Nombre + "/", {tipo: "persona", nombre: consulte.cuerpo.nombre, apellido: consulte.cuerpo.apellido}, función(error, resultado) {

si(error) {

devolver res.estado(400).enviar(error);

}

res.enviar(consulte.cuerpo);

});

En el código anterior, cuando se realiza una solicitud POST contra el archivo /crear primero comprobamos que ciertas propiedades existen en el cuerpo, de lo contrario lanzamos un error. Si existen, hacemos uso de la propiedad makePostRequest pasando la dirección URL del Documentación de la API RESTful de Sync Gateway.

En este punto, si tiene éxito, los datos se guardarán de Sync Gateway a Couchbase Server y se pasarán a todos los dispositivos conectados.

El código fuente completo de la aplicación

Si desea ver la aplicación completa, a continuación encontrará el código fuente:

var Couchbase = require("couchbase");
var Express = require("express");
var BodyParser = require("body-parser");
var Request = require("request");

var app = Express();
var N1qlQuery = Couchbase.N1qlQuery;

app.use(BodyParser.json());
app.use(BodyParser.urlencoded({ extended: true }));

var bucket = (new Couchbase.Cluster("couchbase://localhost")).openBucket("example");

var makePostRequest = function(url, body, callback) {
    Request.post(url, { json: body },
        function (error, response, body) {
            if (!error &amp;&amp; response.statusCode == 200) {
                callback(null, body);
            } else {
                callback(error, null);
            }
        }
    );
}

app.get("/list", function(req, res) {
    bucket.query(N1qlQuery.fromString("SELECT type, firstname, lastname FROM `" + bucket._name + "` WHERE type = 'person'"), function(error, result) {
        if(error) {
            return res.status(400).send(error);
        }
        res.send(result);
    });
});

app.post("/create", function(req, res) {
    if(!req.body.firstname) {
        return res.status(400).send({"status": "error", "message": "A firstname is required"});
    } else if(!req.body.lastname) {
        return res.status(400).send({"status": "error", "message": "A lastname is required"});
    }
    makePostRequest("http://localhost:4984/" + bucket._name + "/", {type: "person", firstname: req.body.firstname, lastname: req.body.lastname}, function(error, result) {
        if(error) {
            return res.status(400).send(error);
        }
        res.send(req.body);
    });
});

var server = app.listen(3000, function() {
    console.log("Listening on port %s...", server.address().port);
});

var Couchbase = requiere("couchbase");

var Express = requiere("express");

var BodyParser = requiere("body-parser");

var Solicitar = requiere("solicitud");

var aplicación = Express();

var N1qlQuery = Couchbase.N1qlQuery;

aplicación.utilice(BodyParser.json());

aplicación.utilice(BodyParser.urlencoded({ ampliado: verdadero }));

var cubo = (nuevo Couchbase.Grupo("couchbase://localhost")).openBucket("ejemplo");

var makePostRequest = función(url, cuerpo, devolución de llamada) {

Solicitar.Correo electrónico:(url, { json: cuerpo },

función (error, respuesta, cuerpo) {

si (!error && respuesta.statusCode == 200) {

devolución de llamada(null, cuerpo);

} si no {

devolución de llamada(error, null);

}

);

}

aplicación.consiga("/lista", función(consulte, res) {

cubo.consulta(N1qlQuery.fromString("SELECT type, firstname, lastname FROM `" + cubo.Nombre + "WHERE type = 'person'"), función(error, resultado) {

si(error) {

devolver res.estado(400).enviar(error);

}

res.enviar(resultado);

});

aplicación.Correo electrónico:("/crear", función(consulte, res) {

si(!consulte.cuerpo.nombre) {

devolver res.estado(400).enviar({"status": "error", "mensaje": "Se requiere un nombre"});

} si no si(!consulte.cuerpo.apellido) {

devolver res.estado(400).enviar({"status": "error", "mensaje": "Se requiere un apellido"});

}

makePostRequest("http://localhost:4984/" + cubo.Nombre + "/", {tipo: "persona", nombre: consulte.cuerpo.nombre, apellido: consulte.cuerpo.apellido}, función(error, resultado) {

si(error) {

devolver res.estado(400).enviar(error);

}

res.enviar(consulte.cuerpo);

});

var servidor = aplicación.escuche(3000, función() {

consola.registro("Escuchando en el puerto %s...", servidor.dirección().puerto);

});

Vamos a explorar la ejecución de esta aplicación en el siguiente paso.

Ejecutar la aplicación

Hay muchas piezas en movimiento en este ejemplo en particular. Tenemos una aplicación Node.js, Couchbase Server y Couchbase Sync Gateway. Más adelante es probable que también tengas una aplicación móvil.

Lo primero que queremos hacer es lanzar Sync Gateway y hacer que se conecte a nuestro clúster Couchbase Server ya en ejecución. Ejecute lo siguiente desde su línea de comandos:

/path/to/sync_gateway /path/to/sync-gateway-config.json

1	/ruta/a/sync_gateway /ruta/a/sincronizar-pasarela-config.json

Con Sync Gateway en marcha puede ejecutar la aplicación Node.js ejecutando:

node index.js

1	nodo índice.js

La aplicación debería ser ahora accesible en http://localhost:3000 en las rutas de los extremos concretos.

Conclusión

Acabas de ver una posible forma de unir tus aplicaciones Couchbase Mobile y Couchbase Server. Aunque en realidad no creamos una aplicación móvil en esta guía, usamos todos los componentes que la harían posible como paso final. Creamos una aplicación Node.js que usaba tanto el SDK Node.js de Couchbase Server como Couchbase Sync Gateway.

Nic Raboy, Defensor del Desarrollador, Couchbase

Comparte este artículo

3 Comentarios

glenn junio 6, 2017 a 5:36 am

Hola, señor,

Nos gustaría utilizar su enfoque, pero hay una consideración que nos encontramos. Se trata de casos offline para dispositivos móviles. Dado que no podía hacer una llamada, entonces, ¿cómo podemos superar este problema? ¿Deberíamos escribir cambios en couchbase lite y luego, cuando Internet esté disponible, hacer una llamada api a nuestro servidor?

En segundo lugar, ha mencionado que existen otros enfoques posibles para utilizar couchbase mobile y couchbase server. ¿Podría darnos información al respecto?

Gracias.

Inicia sesión para responder
1. Nic Raboy, Defensor del Desarrollador, Couchbase junio 6, 2017 a 6:01 am
  
  No tendrás que preocuparte por los casos extremos con Couchbase mobile porque por defecto Couchbase Lite se comunicará con Sync Gateway siempre que haya una conexión a Internet disponible.
  
  Con Node y Couchbase Lite comunicándose con Sync Gateway, todo irá bien.
  
  Cuando se publique Couchbase 5.0, no tendrás que comunicarte de esta manera, ya que todo estará integrado en los SDK.
  
  Inicia sesión para responder
  1. glenn junio 6, 2017 a 6:18 am
    
    Así, en nuestro caso, si Internet está activo, se realiza una llamada al servidor de aplicaciones que recibe la solicitud y se comunica con la pasarela de sincronización. Por otro lado, si no hay internet, la aplicación móvil inserta los datos en su propio couchbase lite local. Cuando la conexión a Internet está disponible, las operaciones de sincronización se manejan y mantenemos los datos.
    
    Gracias.
    
    Inicia sesión para responder

Deja un comentario Cancelar respuesta

Lo siento, debes estar conectado para publicar un comentario.

Platform

Self-Managed

Services

Capabilities

Why Couchbase?

Migrate to Capella

By Use Case

By Industry

By Application Need

Popular Docs

By Developer Role

Quickstart

Resource Center

About

Partnerships

Our Services

Partners: Register a Deal

Ready to register a deal with Couchbase?

Marriott

Uso de Couchbase Server y Couchbase Mobile en el mismo proyecto con Node.js

Requisitos

Configuración de Couchbase Server y Couchbase Sync Gateway

Creación de la aplicación web

Creación de un nuevo proyecto y arranque del código

Añadiendo el SDK Node.js de Couchbase y la lógica RESTful Sync Gateway

El código fuente completo de la aplicación

Ejecutar la aplicación

Conclusión

Recibe actualizaciones del blog de Couchbase en tu bandeja de entrada

Autor

Publicado por Nic Raboy, Defensor del Desarrollador, Couchbase

3 Comentarios

Deja un comentario Cancelar respuesta

¿Listo para empezar con Couchbase Capella?

Empezar a construir

Utilizar Capella gratis

Póngase en contacto