{"id":8755,"date":"2020-06-02T10:01:46","date_gmt":"2020-06-02T17:01:46","guid":{"rendered":"https:\/\/www.couchbase.com\/blog\/?p=8755"},"modified":"2023-09-29T13:48:47","modified_gmt":"2023-09-29T20:48:47","slug":"store-sync-binary-data-attachments-blobs-couchbase-mobile","status":"publish","type":"post","link":"https:\/\/www.couchbase.com\/blog\/es\/store-sync-binary-data-attachments-blobs-couchbase-mobile\/","title":{"rendered":"Manejar adjuntos de datos binarios y blobs con Couchbase Mobile"},"content":{"rendered":"

Couchbase M\u00f3vil<\/a> soporta un modelo de datos NoSQL estilo documento JSON. Adem\u00e1s de soportar los tipos de datos JSON est\u00e1ndar, Couchbase Mobile tambi\u00e9n soporta datos binarios que incluyen im\u00e1genes, audio, v\u00eddeo, archivos PDF, etc. Un documento JSON puede asociarse a uno o m\u00e1s elementos de datos binarios denominados \"adjuntos\" o \"blobs\". Los datos binarios pueden ser sincronizados entre los clientes de Couchbase Lite y el servidor a trav\u00e9s del Sync Gateway. En este post, discutiremos c\u00f3mo crear adjuntos de datos binarios, c\u00f3mo recuperarlos y actualizarlos. Tambi\u00e9n echaremos un vistazo a c\u00f3mo se representan internamente los adjuntos, las idiosincrasias relacionadas y c\u00f3mo lidiar con ellas.<\/p>\n

Todo en este post se aplica a un despliegue basado en Couchbase Mobile 2.x.<\/p>\n

Antecedentes: Adjuntos y Blobs<\/h2>\n

El soporte para asociar datos binarios con documentos JSON dentro de Couchbase Mobile ha evolucionado a lo largo de los a\u00f1os. La representaci\u00f3n interna de datos binarios dentro del documento JSON ha cambiado a trav\u00e9s de las versiones de Couchbase Mobile. En Couchbase Mobile 1.x, los datos binarios se almacenaban en forma de \"adjuntos\" dentro de un documento de nivel superior \"_archivos adjuntos<\/em>\". Couchbase Mobile introdujo el atributo blob<\/a> para almacenar datos binarios. En la mayor\u00eda de los casos, la discrepancia entre las representaciones a trav\u00e9s de versiones es manejada sin problemas por Couchbase Mobile, por lo que los usuarios finales no tienen que hacer nada especial dentro de sus aplicaciones para hacer frente a ella. Sin embargo, hay ciertos casos en los que los desarrolladores de aplicaciones tendr\u00edan que tomar medidas adicionales para hacer frente a la discrepancia. Tambi\u00e9n discutiremos esas medidas en este post y trataremos de responder a algunas de las preguntas m\u00e1s frecuentes.<\/p>\n

Flujo de trabajo #1: Gesti\u00f3n de archivos adjuntos creados en Couchbase Lite<\/h2>\n

Veamos c\u00f3mo puedes crear documentos JSON con datos binarios adjuntos con Couchbase Lite y sincronizarlos con el servidor. Este es el flujo que vamos a describir:<\/p>\n

\"\"<\/figure>\n

Crear adjuntos de datos binarios en Couchbase Lite<\/h3>\n

Los desarrolladores deben utilizar el API de blobs<\/a> para crear datos blob. Un documento puede asociarse con uno o m\u00e1s adjuntos o blobs. He aqu\u00ed un fragmento de c\u00f3digo que muestra el uso de esta API en swift. Consulte la documentaci\u00f3n para desarrolladores para obtener fragmentos de c\u00f3digo equivalentes para otras plataformas.<\/p>\n

\r\n let mutableDoc = MutableDocument.init(id: \"user::priya\")\r\n if let profileImage = UIImage(named: \"profile.jpg\"), let imageData = UIImageJPEGRepresentation(profileImage, 0.75) {\r\n   let blob = Blob(contentType: \"image\/jpeg\", data: imageData)\r\n   mutableDoc.setBlob(blob, forKey: \"image\")\r\n }\r\n \/\/ \u2026 Add other properties\r\n mutableDoc.setString(\"user\", forKey: \"type\")\r\n mutableDoc.setString(\"Priya\", forKey: \"name\")\r\n mutableDoc.setString(\"priya.rajagopal@couchbase.com, forKey: \"email\")\r\n do {\r\n   try? db.saveDocument(mutableDoc)\r\n }\r\n catch {\r\n   print(\"Error in saving document : (error)\")\r\n }\r\n<\/code><\/pre>\n
Representaci\u00f3n interna<\/h3>\n
Cuando el documento se crea en Couchbase Lite, internamente, se ve algo como esto:<\/p>\n
{\r\n  \"email\": \"priya.rajagopal@couchbase.com\",\r\n  \"image\": {\r\n   \"length\": 3888349,\r\n   \"digest\": \"sha1\u20134xlj1AKFgLdzcD7a1pVChrVTJIc=\",\r\n   \"content_type\": \"image\/jpeg\",\r\n   \"@type\": \"blob\"\r\n  },\r\n \"type\": \"user\",\r\n \"name\": \"Priya\",\r\n \"id\": \"user::priya\",\r\n \"rev\": \"1\u20131c8502034001b333cc469fe8c4c39e112eedf8a3\"\r\n}<\/code><\/pre>\n
F\u00edjese en el \"@type\": \"blob\" <\/em>entrada de tipo creada para los datos del tipo de imagen.<\/p>\n
Nota<\/strong> que hay varios metadatos a nivel de sistema como _id<\/em> que se incluyen en el documento. Por brevedad, no se muestra todo en el ejemplo. Las aplicaciones nunca deben hacer suposiciones sobre el formato y la disponibilidad de los metadatos a nivel de sistema y, por esa raz\u00f3n, las aplicaciones nunca deben acceder a esos atributos directamente. Utilice siempre las opciones de recuperaci\u00f3n de metadatos como meta().id<\/em>.<\/p>\n
Sincronizaci\u00f3n de archivos adjuntos con Sync Gateway<\/h3>\n
Sync Gateway es compatible con Couchbase Mobile 1.x. Esto implica que Sync Gateway debe ser capaz de procesar datos binarios utilizando la versi\u00f3n 1.x _. archivos adjuntos<\/em> as\u00ed como la representaci\u00f3n 2.x blob<\/em> tipo. Esto tambi\u00e9n implica que cuando el cliente Couchbase Lite 2.x env\u00eda datos a la puerta de enlace de sincronizaci\u00f3n, necesita enviarlos en un formato que sea compatible con los clientes 1.x.<\/p>\n
Por esa raz\u00f3n, cuando Couchbase Lite sincroniza el documento con la Sync Gateway, a\u00f1ade la propiedad _<\/em><\/strong>archivos adjuntos\u00a0<\/em>en el documento. As\u00ed, el documento, una vez introducido, tendr\u00eda un aspecto similar al del ejemplo siguiente. La lista de anexos asociados al documento se especifica en el campo Adjuntos<\/em> objeto.<\/p>\n
{\r\n  \"attachments\": {\r\n  \"blob\/image\": {\r\n   \"content_type\": \"image\/jpeg\",\r\n   \"digest\": \"sha1\u20134xlj1AKFgLdzcD7a1pVChrVTJIc=\",\r\n   \"length\": 3888349,\r\n   \"revpos\": 1,\r\n   \"stub\": true\r\n   }\r\n  },\r\n  \"email\": \"priya.rajagopal@couchbase.com\",\r\n  \"image\": {\r\n  \"@type\": \"blob\",\r\n  \"content_type\": \"image\/jpeg\",\r\n  \"digest\": \"sha1\u20134xlj1AKFgLdzcD7a1pVChrVTJIc=\",\r\n  \"length\": 3888349\r\n  },\r\n  \"name\": \"Priya\",\r\n  \"type\": \"user\",\r\n  \"id\": \"user::priya\",\r\n  \"rev\": \"1\u20131c8502034001b333cc469fe8c4c39e112eedf8a3\",\r\n}<\/code><\/em><\/pre>\n
Nota<\/strong> que hay varios metadatos a nivel de sistema como _id<\/em> que se incluye en el documento. En aras de la brevedad, no se muestra todo en el ejemplo. Las aplicaciones nunca deben hacer suposiciones sobre el formato y la disponibilidad de los metadatos a nivel de sistema y, por esa raz\u00f3n, las aplicaciones nunca deben acceder a esos atributos directamente. Utilice siempre las opciones de recuperaci\u00f3n de metadatos como meta().id<\/em>.<\/p>\n
Recuperaci\u00f3n de archivos adjuntos en Sync Gateway<\/h3>\n
Los datos adjuntos deben recuperarse a trav\u00e9s de Sync Gateway _archivos adjuntos<\/em> REST<\/a> endpoint. En el momento de escribir este post, los archivos adjuntos no se pueden gestionar directamente utilizando los SDK de Couchbase Server.<\/p>\n
A continuaci\u00f3n se muestra un ejemplo de comando curl para recuperar los archivos adjuntos asociados a un documento utilizando la funci\u00f3n _archivos adjuntos<\/em> REST. Sustituir\u00eda la cabecera de autorizaci\u00f3n por las credenciales adecuadas correspondientes al usuario configurado en su sistema. Adem\u00e1s, f\u00edjese en el nombre del archivo adjunto, \"mancha_<\/em>%2Fimage” is the URL encoded version of \"blob<\/em>\/imagen\"_.<\/p>\n
curl -X GET \r\n 'https:\/\/sync-gateway-url:4984\/dbname\/user::priya\/blob_%2Fimage' \r\n -H 'Accept: application\/json' \r\n -H 'Authorization: Basic ZGVtbzpwYXNzd29yZA=='<\/code><\/pre>\n
Actualizaci\u00f3n de archivos adjuntos en Sync Gateway<\/h3>\n
Los datos adjuntos deben actualizarse a trav\u00e9s de Sync Gateway _archivos adjuntos<\/em> REST<\/a> endpoint. En el momento de escribir este post, los archivos adjuntos m\u00f3viles no se pueden gestionar mediante los SDK de Couchbase Server.<\/p>\n
A continuaci\u00f3n se muestra un ejemplo de comando curl para actualizar un archivo adjunto asociado a un documento utilizando la funci\u00f3n _archivos adjuntos<\/em> REST. Sustituya la cabecera de autorizaci\u00f3n por las credenciales adecuadas correspondientes al usuario configurado en su sistema. Adem\u00e1s, observe que la cabecera \"rev\"<\/em> . Este par\u00e1metro corresponde a la revisi\u00f3n del documento que debe actualizarse. Puede recuperar el revId utilizando la funci\u00f3n GET documento REST<\/a>.<\/p>\n
 curl -i -X PUT 'https:\/\/sync-gateway-url:4984\/dbname\/user::priya\/blob_%2Fimage?rev=12-fa2bf00dab7e811eb562a502429ec633' \r\n -H 'Accept: application\/json' \r\n -H 'Authorization: Basic ZGVtbzE6cGFzc3dvcmQ=' \r\n -H 'Content-Type: image\/png' \r\n -H 'cache-control: no-cache' \r\n \u2013data-binary \"@layered.png\"<\/code><\/pre>\n
Pero... espera... \u00a1un desajuste!<\/h3>\n
Ahora, despu\u00e9s de actualizar el archivo adjunto, si recupera el documento utilizando la funci\u00f3n GET documento REST<\/a>,<\/p>\n
 curl -X GET \r\n 'https:\/\/sync-gateway-url:4984\/dbname\/user::priya\/blob_%2Fimage' \r\n -H 'Accept: application\/json' \r\n -H 'Authorization: Basic ZGVtbzE6cGFzc3dvcmQ=' \r\n -H 'Content-Type: application\/json' \r\n -H 'cache-control: no-cache'<\/code><\/pre>\n
La respuesta correspondiente ser\u00eda algo as\u00ed<\/p>\n
{\r\n  \"attachments\": {\r\n  \"blob\/image\": {\r\n   \"content_type\": \"image\/png\",\r\n   \"digest\": \"sha1-XeeXt0I014+1qpH+s2S2AUSg4II=\",\r\n   \"length\": 3444504,\r\n   \"revpos\": 16,\r\n   \"stub\": true\r\n   }\r\n  },\r\n  \"id\": \"user::demo1\",\r\n  \"rev\": \"13-e61d1a9e63069030212007a8b5eddde9\",\r\n  \"address\": \"\",\r\n  \"email\": \"demo1\",\r\n  \"image\": {\r\n   \"@type\": \"blob\",\r\n   \"content_type\": \"image\/jpeg\",\r\n   \"digest\": \"sha1\u20134xlj1AKFgLdzcD7a1pVChrVTJIc=\",\r\n   \"length\": 3888349\r\n  },\r\n  \"name\": \"Priya Rajagopal\",\r\n  \"type\": \"user\"\r\n}<\/code><\/pre>\n
Observar\u00e1 que el _attachment<\/em> y blob<\/em> no coinciden. Mientras que la _attachment<\/em> apunta a la \u00faltima imagen, la blob<\/em> sigue describiendo la imagen antigua. Pero est\u00e1 bien.<\/em>!<\/p>\n
La raz\u00f3n de esta discrepancia se debe a que Sync Gateway s\u00f3lo trabaja con archivos adjuntos de estilo 1.x.<\/p>\n
\u00bfC\u00f3mo sigue funcionando esto?<\/p>\n
Esto funciona porque en el contexto de la puerta de enlace de sincronizaci\u00f3n, que se ocupa de los archivos adjuntos de estilo 1.x, s\u00f3lo se respeta la entrada del archivo adjunto.<\/p>\n
\u00bfPero qu\u00e9 pasa con Couchbase Lite? \u00bfQu\u00e9 pasa cuando el documento actualizado es sincronizado por el cliente Couchbase Lite 2.x?<\/p>\n
Cuando el documento es replicado por el cliente Couchbase Lite 2.x, Couchbase Lite busca la presencia de Adjuntos<\/em> y manchas<\/em> dentro del documento e implementa la l\u00f3gica adecuada para identificar que se trata de un documento de estilo 2.x creado por un cliente 2.x pero actualizado posteriormente por un cliente 1.x (como la API REST de Sync Gateway). Por lo tanto, trata el Adjuntos<\/em> como el archivo adjunto \"real\" y unifica la entrada blob correspondiente.<\/p>\n
Desde el punto de vista del desarrollador, todo esto se gestiona autom\u00e1ticamente. As\u00ed que realmente no tienes que preocuparte por ninguno de los detalles. Como desarrollador, tendr\u00edas que saber c\u00f3mo recuperar el archivo adjunto actualizado desde dentro de la aplicaci\u00f3n habilitada para Couchbase Lite.<\/p>\n
Recuperaci\u00f3n de archivos adjuntos actualizados en Couchbase Lite<\/h3>\n
Cuando el archivo adjunto actualizado se sincronice con su aplicaci\u00f3n Couchbase Lite, utilice la funci\u00f3n API de Blob<\/a> para recuperar los datos. Aqu\u00ed hay un fragmento de c\u00f3digo que muestra el uso de esta API en swift. Consulte la documentaci\u00f3n para desarrolladores para obtener fragmentos de c\u00f3digo equivalentes para otras plataformas.<\/p>\n
\r\n if let doc = db.document(withID: \"user::priya\") {\r\n     let blobValue = doc.blob(forKey:\"image\")?.content\r\n     \/\/ use the blobValue\r\n }\r\n<\/code><\/pre>\n
Ahora veamos el flujo inverso.<\/p>\n
Flujo de trabajo #2: Gesti\u00f3n de archivos adjuntos creados en Sync Gateway<\/h2>\n
Veamos c\u00f3mo crear documentos JSON con datos binarios adjuntos en Sync Gateway y sincronizarlos con Couchbase Lite.
\nEste es el flujo que vamos a describir -<\/p>\n
\"\"<\/figure>\n
Crear archivos adjuntos de datos binarios en el servidor<\/h3>\n
Para adjuntar datos binarios en el lado del servidor Couchbase que puedan sincronizarse con los clientes a trav\u00e9s de la puerta de enlace de sincronizaci\u00f3n, deber\u00e1 utilizar la puerta de enlace de sincronizaci\u00f3n punto final REST de archivos adjuntos<\/a>. En el momento de escribir este post, los archivos adjuntos compatibles con m\u00f3viles no se pueden crear directamente utilizando los SDK de Couchbase Server. Los datos adjuntos que se crean a trav\u00e9s del punto final REST de Sync Gateway se mantienen en el bucket de Couchbase Server y se sincronizan con los clientes de Couchbase Lite sujetos a las pol\u00edticas de control de acceso configuradas en Sync Gateway.<\/p>\n
Para ello, cree primero un documento (o recupere un documento creado previamente) y, a continuaci\u00f3n, cree el archivo adjunto para el documento. Otra posibilidad es crear un documento de varias partes con datos JSON y binarios. Pero esto podr\u00eda resultar tedioso, ya que tambi\u00e9n habr\u00eda que generar los metadatos pertinentes del archivo adjunto. As\u00ed que los pasos descritos a continuaci\u00f3n es mi opci\u00f3n preferida<\/p>\n