Descripción general de la API de Blobstore para Java 8

Nota: Debes considerar usar Google Cloud Storage, en lugar de Blobstore, para almacenar datos de BLOB.

La API de Blobstore permite que tu aplicación entregue objetos de datos, llamados blobs, que son mucho más grandes que el tamaño permitido para los objetos en el servicio de Datastore. Los blobs son útiles para entregar archivos grandes, como archivos de video o imágenes, y para que los usuarios suban archivos de datos grandes. Los blobs se crean subiendo un archivo a través de una solicitud HTTP. Por lo general, para hacerlo tus aplicaciones presentarán un formulario con un campo de subida de archivos para el usuario. Cuando se envía el formulario, Blobstore crea un blob a partir del contenido del archivo y muestra una referencia opaca al blob, llamada clave de blob, que luego puede usar para entregar el blob. La aplicación puede entregar el valor completo del blob en respuesta a una solicitud del usuario, o puede leer el valor directamente mediante una interfaz similar a un archivo de transmisión.

Presentación de Blobstore

Google App Engine incluye el servicio Blobstore, que permite a las aplicaciones entregar objetos de datos limitados solo por la cantidad de datos que se pueden subir o descargar a través de una única conexión HTTP. Estos objetos se denominan valores de Blobstore, o blobs. Los valores de Blobstore se entregan como respuestas a la solicitud de los controladores y se crean como subidas a través de formularios web. Las aplicaciones no crean datos de blob directamente; en cambio, los blobs se crean indirectamente mediante un formulario web enviado o una solicitud POST de HTTP. Los valores de Blobstore se pueden entregar al usuario, o la aplicación puede acceder a ellos en una secuencia similar a un archivo, con la API de Blobstore.

Para solicitar a un usuario que suba un valor de Blobstore, tu aplicación presenta un formulario web con un campo de subida de archivos. La aplicación genera la URL de acción del formulario llamando a la API de Blobstore. El navegador del usuario sube el archivo directamente en Blobstore a través de la URL generada. Luego, Blobstore almacena el blob, vuelve a escribir la solicitud para que contenga la clave del blob y la pasa a una ruta en tu aplicación. Un controlador de solicitudes en esa ruta de tu aplicación puede realizar un procesamiento de formulario adicional.

Para entregar un blob, tu aplicación establece un encabezado en la respuesta saliente y App Engine reemplaza la respuesta con el valor de blob.

Los blobs no se pueden modificar después de que se crean, pero sí borrar. Cada blob tiene un registro de información de blob correspondiente, guardado en el almacén de datos, que proporciona detalles sobre el blob, como su hora de creación y tipo de contenido. Puedes usar la clave de BLOB para buscar registros de información de BLOB y consultar sus propiedades.

Una aplicación puede leer un valor de Blobstore de a una parte a la vez con una llamada a la API. El tamaño de la parte puede ser hasta el tamaño máximo de un valor de muestra de la API. Este tamaño es un poco menor de 32 megabytes, que en Java se representa con la constante com.google.appengine.api.blobstore.BlobstoreService.MAX_BLOB_FETCH_SIZE. Una aplicación no puede crear ni modificar los valores de Blobstore, excepto a través de archivos que sube el usuario.

Usa el Blobstore

Las aplicaciones pueden usar el Blobstore para aceptar archivos grandes como cargas de los usuarios y entregarlos. Los archivos se llaman BLOBS una vez que se suben. Las aplicaciones no pueden acceder a los BLOB de manera directa. En su lugar, las aplicaciones trabajan con los BLOB a través de entidades de información de BLOB (representadas por la clase BlobInfo) en el almacén de datos.

El usuario crea un BLOB cuando envía un formulario HTML que incluye uno o más campos de entrada de archivos. Tu aplicación llama a blobstoreService.createUploadUrl() para obtener el destino (acción) de este formulario y pasa la función a una ruta de URL de un controlador en tu aplicación. Cuando el usuario envía el formulario, el navegador del usuario sube a Blobstore los archivos especificados. Blobstore reescribe la solicitud del usuario y almacena los datos del archivo subido, reemplazándolos con una o más claves de BLOB correspondientes, y luego pasa la solicitud reescrita al controlador en la ruta de URL que proporcionaste a blobstoreService.createUploadUrl(). Este controlador puede hacer un procesamiento adicional basado en la clave del BLOB.

La aplicación puede leer partes de un valor de Blobstore con una interfaz de transmisión similar a un archivo. Consulta la clase BlobstoreInputStream.

Cómo subir un BLOB

Para crear y subir un blob, sigue este procedimiento:

1. Crea una URL de carga.

Llama a blobstoreService.createUploadUrl para crear una URL de carga cuando el usuario llene un formulario. Cuando se completa su POST, se pasa la ruta de la aplicación para la carga.

<body>
    <form action="<%= blobstoreService.createUploadUrl("/upload") %>" method="post" enctype="multipart/form-data">
        <input type="file" name="myFile">
        <input type="submit" value="Submit">
    </form>
</body>

Ten en cuenta que así se verá el formulario de carga si se crea como un JSP.

2. Crea un formulario de subida

El formulario debe incluir un campo de subida de archivos, y el enctype del formulario debe establecerse en multipart/form-data. Cuando el usuario envía el formulario, el POST es controlado por la API de Blobstore, que crea un blob. La API también crea un registro de información para el BLOB, almacena el registro en el almacén de datos y pasa la solicitud reescrita a tu aplicación en la ruta dada como una clave de BLOB.

3. Implementa un controlador de subida

En este controlador, puedes almacenar la clave de blob con el resto de tu modelo de datos de la aplicación. La clave de blob en sí permanece accesible desde la entidad de información de blob en el almacén de datos. Ten en cuenta que después de que el usuario envíe el formulario y se llame a tu controlador, el blob ya estará guardado y la información agregada al almacén de datos. Si tu aplicación no quiere mantener el BLOB, debe borrarlo de inmediato para evitar que quede suelto:

En el siguiente código, getUploads muestra un conjunto de BLOB que se han subido. El objeto Map es una lista que asocia los nombres de los campos de carga a los BLOB que contenían.

Map<String, List<BlobKey>> blobs = blobstoreService.getUploads(req);
List<BlobKey> blobKeys = blobs.get("myFile");

if (blobKeys == null || blobKeys.isEmpty()) {
    res.sendRedirect("/");
} else {
    res.sendRedirect("/serve?blob-key=" + blobKeys.get(0).getKeyString());
}

Cuando Blobstore reescribe la solicitud del usuario, las partes MIME de los archivos subidos tienen sus cuerpos vacíos y la clave del BLOB se agrega como parte del encabezado MIME. Todos los demás campos de formulario y las partes se conservan y se pasan al controlador de subida. Si no especificas un tipo de contenido, Blobstore intentará inferirlo de la extensión del archivo. Si no se puede determinar ningún tipo de contenido, al blob recién creado se le asigna el tipo de contenido application/octet-stream.

Entrega un BLOB

Para entregar BLOB, debes incluir un controlador de descarga de BLOB como una ruta en tu aplicación. Este controlador debe pasar la clave del BLOB para el BLOB deseado a blobstoreService.serve(blobKey, res);. En este ejemplo, la clave del BLOB se pasa al controlador de descarga como parte de la URL.(req.getParameter('blob-key')). En la práctica, el controlador de descarga puede obtener la clave del BLOB por cualquier medio que elijas, como a través de otro método o acción del usuario.

public void doGet(HttpServletRequest req, HttpServletResponse res)
    throws IOException {
        BlobKey blobKey = new BlobKey(req.getParameter("blob-key"));
        blobstoreService.serve(blobKey, res);

Los BLOB se pueden entregar desde cualquier URL de aplicación. Para entregar un BLOB en tu aplicación, coloca un encabezado especial en la respuesta que contiene la clave del BLOB. App Engine reemplaza el cuerpo de la respuesta con el contenido del blob.

Rangos de bytes de blob

Blobstore admite el servicio de parte de un valor grande en lugar del valor total en respuesta a una solicitud. Para entregar un valor parcial, incluye el encabezado X-AppEngine-BlobRange en la respuesta saliente. Su valor es un rango de byte HTTP estándar. La numeración de bytes está basada en cero. Un X-AppEngine-BlobRange en blanco indica a la API que ignore el encabezado del rango y entregue el blob completo. Los rangos de ejemplo incluyen lo siguiente:

  • 0-499 entrega los primeros 500 bytes del valor (bytes 0 a 499, incluido).
  • 500-999 entrega 500 bytes comenzando con el byte 501.
  • 500- entrega todos los bytes que comienzan con el byte 501 hasta final del valor.
  • -500 entrega los últimos 500 bytes del valor.

Si el rango de byte es válido para el valor de Blobstore, este envía un código de estado 206 Partial Content y un rango de byte solicitado al cliente. Si el rango no es válido para el valor, Blobstore envía 416 Requested Range Not Satisfiable.

Blobstore no admite varios rangos de bytes en una sola solicitud (por ejemplo, 100-199,200-299), por más que se superpongan o no.

Completa la aplicación de muestra

En la aplicación de muestra siguiente, la URL principal de la aplicación carga el formulario que solicita al usuario un archivo que se debe subir. El controlador de subida llama de inmediato al controlador de descarga para entregar los datos. Esto sirve para simplificar la aplicación de muestra. En la práctica, es probable que no debas usar la URL principal para solicitar datos de carga ni entregar de inmediato un BLOB que acabas de subir.

// file Upload.java

import java.io.IOException;
import java.util.List;
import java.util.Map;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.google.appengine.api.blobstore.BlobKey;
import com.google.appengine.api.blobstore.BlobstoreService;
import com.google.appengine.api.blobstore.BlobstoreServiceFactory;

public class Upload extends HttpServlet {
    private BlobstoreService blobstoreService = BlobstoreServiceFactory.getBlobstoreService();

    @Override
    public void doPost(HttpServletRequest req, HttpServletResponse res)
        throws ServletException, IOException {

        Map<String, List<BlobKey>> blobs = blobstoreService.getUploads(req);
        List<BlobKey> blobKeys = blobs.get("myFile");

        if (blobKeys == null || blobKeys.isEmpty()) {
            res.sendRedirect("/");
        } else {
            res.sendRedirect("/serve?blob-key=" + blobKeys.get(0).getKeyString());
        }
    }
}

// file Serve.java

import java.io.IOException;

import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import com.google.appengine.api.blobstore.BlobKey;
import com.google.appengine.api.blobstore.BlobstoreService;
import com.google.appengine.api.blobstore.BlobstoreServiceFactory;

public class Serve extends HttpServlet {
    private BlobstoreService blobstoreService = BlobstoreServiceFactory.getBlobstoreService();

    @Override
    public void doGet(HttpServletRequest req, HttpServletResponse res)
        throws IOException {
            BlobKey blobKey = new BlobKey(req.getParameter("blob-key"));
            blobstoreService.serve(blobKey, res);
        }
}

// file index.jsp

<%@ page import="com.google.appengine.api.blobstore.BlobstoreServiceFactory" %>
<%@ page import="com.google.appengine.api.blobstore.BlobstoreService" %>

<%
    BlobstoreService blobstoreService = BlobstoreServiceFactory.getBlobstoreService();
%>

<html>
    <head>
        <title>Upload Test</title>
    </head>
    <body>
        <form action="<%= blobstoreService.createUploadUrl("/upload") %>" method="post" enctype="multipart/form-data">
            <input type="text" name="foo">
            <input type="file" name="myFile">
            <input type="submit" value="Submit">
        </form>
    </body>
</html>

// web.xml

<?xml version="1.0" encoding="utf-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
   xmlns="http://java.sun.com/xml/ns/javaee"
   xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
   xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
   http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" version="2.5">

  <servlet>
    <servlet-name>Upload</servlet-name>
    <servlet-class>Upload</servlet-class>
  </servlet>

  <servlet>
    <servlet-name>Serve</servlet-name>
    <servlet-class>Serve</servlet-class>
  </servlet>

  <servlet-mapping>
    <servlet-name>Upload</servlet-name>
    <url-pattern>/upload</url-pattern>
  </servlet-mapping>

  <servlet-mapping>
    <servlet-name>Serve</servlet-name>
    <url-pattern>/serve</url-pattern>
  </servlet-mapping>

</web-app>

Usa el servicio de imágenes con Blobstore

Con el servicio de imágenes, se puede usar un valor de Blobstore como la fuente de una transformación. La imagen fuente puede ser tan grande como el tamaño máximo de un valor de Blobstore. El servicio de imágenes aún muestra la imagen transformada a la aplicación, por lo que esta imagen debe ser menor de 32 megabytes. Esto es útil para crear imágenes en miniatura de fotografías grandes subidas por los usuarios.

Para obtener información sobre el uso de servicios de imagen con valores Blobstore, consulta la documentación sobre el servicio de imágenes.

Usar la API de Blobstore con Google Cloud Storage

Puedes usar la API de Blobstore para almacenar BLOB en Cloud Storage en lugar de almacenarlos en Blobstore. Debes configurar un depósito como se describe en la documentación de Google Cloud Storage, y especificar el depósito y el nombre de archivo en BlobstoreService createUploadUrl. Especifica también el nombre de depósito en el parámetro UploadOptions. En tu controlador de carga, debes procesar los metadatos de FileInfo que muestran y almacenan explícitamente el nombre de archivo de Google Cloud Storage necesario para recuperar el BLOB más tarde.

También puedes entregar objetos de Cloud Storage mediante la API de Blobstore.

Los siguientes fragmentos de código muestran cómo hacerlo. Este ejemplo se encuentra en un controlador de solicitudes que obtiene el nombre del depósito y el nombre del objeto en la solicitud. Este crea el servicio de Blobstore y lo utiliza para crear una clave de BLOB correspondiente a Google Cloud Storage con el depósito y el nombre del objeto suministrados:

BlobstoreService blobstoreService = BlobstoreServiceFactory.getBlobstoreService();
BlobKey blobKey = blobstoreService.createGsBlobKey(
    "/gs/" + fileName.getBucketName() + "/" + fileName.getObjectName());
blobstoreService.serve(blobKey, resp);

Cuotas y límites

El espacio usado por los valores de Blobstore contribuyen a la cuota Datos almacenados (facturable). Las entidades de información de blob en el almacén de datos cuentan con los límites relacionados con el almacén de datos. Ten en cuenta que Google Cloud Storage es un servicio de pago por uso; se te cobrará de acuerdo con la hoja de precios de Cloud Storage.

Para obtener más información sobre las cuotas de seguridad en todo el sistema, consulte Cuotas.

Además de las cuotas de seguridad para todo el sistema, los límites siguientes se aplican específicamente al uso de Blobstore:

  • El tamaño máximo de los datos de Blobstore que puede leer la aplicación con una llamada a la API es de 32 megabytes.
  • La cantidad máxima de archivos que pueden subirse en un solo formulario POST es de 500.
¿Te ha resultado útil esta página? Enviar comentarios:

Enviar comentarios sobre...

Entorno estándar de App Engine para Java 8