Panoramica dell'API Blobstore per i servizi in bundle legacy

L'API Blobstore consente all'applicazione di gestire oggetti di dati, chiamati blob,molto più grandi delle dimensioni consentite per gli oggetti nel servizio Datastore. I blob sono utili per pubblicare file di grandi dimensioni, come file video o immagine, e per consentire agli utenti di caricare file di dati di grandi dimensioni. I blob vengono creati caricando un file tramite una richiesta HTTP. In genere, le applicazioni eseguono questa operazione presentando all'utente un modulo con un campo per il caricamento di file. Quando il modulo viene inviato, il Blobstore crea un blob dai contenuti del file e restituisce un riferimento opaco al blob, chiamato chiave blob,che puoi utilizzare in seguito per pubblicare il blob. L'applicazione può fornire il valore completo del blob in risposta alla richiesta di un utente oppure può leggere il valore direttamente utilizzando un'interfaccia simile a un file di streaming.

Presentazione di Blobstore

Google App Engine include il servizio Blobstore, che consente alle applicazioni di gestire oggetti di dati limitati solo dalla quantità di dati che possono essere caricati o scaricati tramite una singola connessione HTTP. Questi oggetti sono chiamati valori dell'archivio BLOB o blob. I valori dell'archivio BLOB vengono pubblicati come risposte dai gestori delle richieste e vengono creati come caricamenti tramite moduli web. Le applicazioni non creano dati blob direttamente, ma vengono creati indirettamente tramite un modulo web inviato o un'altra richiesta POST HTTP. I valori dell'archivio BLOB possono essere forniti all'utente o accessibili dall'applicazione in uno stream simile a un file utilizzando l'API Blobstore.

Per richiedere a un utente di caricare un valore Blobstore, la tua applicazione presenta un modulo web con un campo di caricamento file. L'applicazione genera l'URL di azione del modulo chiamando l'API Blobstore. Il browser dell'utente carica il file direttamente nel Blobstore tramite l'URL generato. Il BLOB archivia quindi il blob, riscrive la richiesta in modo che contenga la chiave blob e la passa a un percorso nella tua applicazione. Un gestore delle richieste in quel percorso nella tua applicazione può eseguire un'elaborazione aggiuntiva del modulo.

Per gestire un blob, l'applicazione imposta un'intestazione sulla risposta in uscita e App Engine sostituisce la risposta con il valore del blob.

I blob non possono essere modificati dopo la creazione, ma possono essere eliminati. A ogni BLOB corrisponde un record di informazioni sul blob, memorizzato nel datastore, che fornisce dettagli sul blob, come l'ora di creazione e il tipo di contenuti. Puoi utilizzare la chiave blob per recuperare i record relativi alle informazioni sui blob ed eseguire query sulle loro proprietà.

Un'applicazione può leggere un valore dell'archivio BLOB una parte alla volta utilizzando una chiamata API. La dimensione della parte può arrivare alla dimensione massima di un valore restituito dall'API. Queste dimensioni sono di poco meno di 32 megabyte, rappresentate in Java dalla costante com.google.appengine.api.blobstore.BlobstoreService.MAX_BLOB_FETCH_SIZE. Un'applicazione non può creare o modificare i valori dell'archivio BLOB se non tramite i file caricati dall'utente.

Utilizzo del Blobstore

Le applicazioni possono utilizzare l'archivio BLOB per accettare file di grandi dimensioni come caricamenti degli utenti e per pubblicarli. Una volta caricati, i file vengono denominati blob. Le applicazioni non accedono direttamente ai blob. Le applicazioni funzionano invece con i blob tramite entità informative sui blob (rappresentate dalla classe BlobInfo) nel datastore.

L'utente crea un blob inviando un modulo HTML che includa uno o più campi di immissione del file. L'applicazione imposta blobstoreService.createUploadUrl() come destinazione (azione) di questo modulo, trasmettendo alla funzione un percorso URL di un gestore nella tua applicazione. Quando l'utente invia il modulo, il suo browser carica i file specificati direttamente nel Blobstore. Il Blobstore riscrive la richiesta dell'utente e archivia i dati del file caricato, sostituendo i dati del file caricato con una o più chiavi blob corrispondenti, quindi passa la richiesta riscritta al gestore nel percorso dell'URL che hai fornito a blobstoreService.createUploadUrl(). Questo gestore può eseguire ulteriori elaborazioni in base alla chiave blob.

L'applicazione può leggere parti di un valore Blobstore utilizzando un'interfaccia di streaming simile a un file. Guarda il corso BlobstoreInputStream.

Caricamento di un blob

Per creare e caricare un blob:

1. Crea un URL di caricamento

Chiama blobstoreService.createUploadUrl per creare un URL di caricamento per il modulo che l'utente compilerà, trasmettendo il percorso di richiesta da caricare al termine del POST del modulo.

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

Tieni presente che il modulo di caricamento avrebbe questo aspetto se fosse stato creato come JSP.

2. Crea un modulo di caricamento

Il modulo deve includere un campo di caricamento file e il valore enctype del modulo deve essere impostato su multipart/form-data. Quando l'utente invia il modulo, il POST viene gestito dall'API Blobstore, che crea il blob. L'API crea inoltre un record di informazioni per il blob e lo archivia nel datastore, quindi passa la richiesta riscritta all'applicazione nel percorso specificato come chiave blob.

3. Implementa il gestore dei caricamenti

In questo gestore puoi archiviare la chiave blob con il resto del modello dei dati della tua applicazione. La chiave blob stessa rimane accessibile dall'entità informazioni blob nel datastore. Tieni presente che, dopo che l'utente invia il modulo e viene chiamato il tuo gestore, il blob è già stato salvato e le informazioni sul blob sono state aggiunte al datastore. Se la tua applicazione non vuole conservare il blob, eliminalo immediatamente per evitare che diventi orfano:

Nel codice seguente, getUploads restituisce un insieme di blob caricati. L'oggetto Map è un elenco che associa i nomi dei campi di caricamento ai blob che contenevano.

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());
}

Quando il Blobstore riscrive la richiesta dell'utente, il corpo delle parti MIME dei file caricati viene svuotato e la chiave blob viene aggiunta come intestazione di parte MIME. Tutti gli altri campi e le altre parti del modulo vengono conservati e trasmessi al gestore dei caricamenti. Se non specifichi un tipo di contenuti, Blobstore proverà a deducerlo dall'estensione del file. Se non è possibile determinare il tipo di contenuto, al blob appena creato viene assegnato il tipo di contenuto application/octet-stream.

Pubblicazione di un blob

Per pubblicare i blob, devi includere un gestore del download dei blob come percorso nella tua applicazione. Questo gestore deve passare la chiave blob del blob desiderato a blobstoreService.serve(blobKey, res);. In questo esempio, la chiave blob viene passata al gestore dei download come argomento dell'URL (req.getParameter('blob-key')). In pratica, il gestore dei download può ottenere la chiave blob con qualsiasi mezzo tu scelga, ad esempio tramite un altro metodo o un'altra azione dell'utente.

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

I blob possono essere pubblicati da qualsiasi URL dell'applicazione. Per pubblicare un blob nella tua applicazione, inserisci un'intestazione speciale nella risposta contenente la chiave blob. App Engine sostituisce il corpo della risposta con il contenuto del blob.

Intervalli di byte blob

Blobstore supporta la pubblicazione di parte di un valore di grandi dimensioni anziché del valore completo in risposta a una richiesta. Per pubblicare un valore parziale, includi l'intestazione X-AppEngine-BlobRange nella risposta in uscita. Il suo valore è un intervallo di byte HTTP standard. La numerazione dei byte è in base zero. Un X-AppEngine-BlobRange vuoto indica all'API di ignorare l'intestazione dell'intervallo e pubblicare il blob completo. Gli intervalli di esempio includono:

  • 0-499 gestisce i primi 500 byte del valore (byte da 0 a 499 inclusi).
  • 500-999 gestisce 500 byte a partire dal 501 byte.
  • 500- gestisce tutti i byte a partire dal 501° byte fino alla fine del valore.
  • -500 gestisce gli ultimi 500 byte del valore.

Se l'intervallo di byte è valido per il valore dell'archivio BLOB, quest'ultimo invia un codice di stato 206 Partial Content e l'intervallo di byte richiesto al client. Se l'intervallo non è valido per il valore, l'archivio BLOB invia 416 Requested Range Not Satisfiable.

L'archivio BLOB non supporta intervalli di più byte in una singola richiesta (ad esempio 100-199,200-299), indipendentemente dal fatto che si sovrappongano o meno.

Completa l'applicazione di esempio

Nella seguente applicazione di esempio, l'URL principale dell'applicazione carica il modulo che richiede all'utente il file da caricare e il gestore dei caricamenti chiama immediatamente il gestore dei download per fornire i dati. per semplificare l'applicazione di esempio. In pratica, probabilmente non useresti l'URL principale per richiedere i dati di caricamento, né pubblicheresti immediatamente un blob appena caricato.

// 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>

Utilizzo del servizio Google Immagini con Blobstore

Il servizio Immagini può utilizzare un valore Blobstore come origine di una trasformazione. L'immagine di origine può avere le stesse dimensioni di un valore dell'archivio BLOB. Il servizio Immagini restituisce comunque l'immagine trasformata all'applicazione, pertanto l'immagine trasformata deve avere dimensioni inferiori a 32 megabyte. È utile per creare immagini in miniatura di fotografie di grandi dimensioni caricate dagli utenti.

Per informazioni sull'utilizzo del servizio Google Immagini con i valori dell'archivio BLOB, consulta la documentazione del servizio Immagini.

Utilizzo dell'API Blobstore con Google Cloud Storage

Puoi utilizzare l'API Blobstore per archiviare i BLOB in Cloud Storage anziché in Blobstore. Devi configurare un bucket come descritto nella documentazione di Google Cloud Storage e specificare il bucket e il nome del file in createUploadUrl BlobstoreService; il nome del bucket nel parametro UploadOptions. Nel gestore dei caricamenti, devi elaborare i metadati FileInfo restituiti e archiviare in modo esplicito il nome file di Google Cloud Storage necessario per recuperare il blob in un secondo momento.

Puoi anche gestire gli oggetti Cloud Storage utilizzando l'API Blobstore.

I seguenti snippet di codice mostrano come eseguire questa operazione. Questo esempio si trova in un gestore di richieste che riceve il nome del bucket e dell'oggetto nella richiesta. Crea il servizio Blobstore e lo utilizza per creare una chiave BLOB per Google Cloud Storage, utilizzando il bucket e il nome oggetto forniti:

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

Quote e limiti

Lo spazio utilizzato per i valori del Blobstore contribuisce alla quota di dati archiviati (fatturabili). Le entità di informazione blob nel datastore vengono conteggiate ai fini dei limiti relativi al datastore. Google Cloud Storage è un servizio a pagamento, ti verrà addebitato in base al listino prezzi di Cloud Storage.

Per saperne di più sulle quote di sicurezza a livello di sistema, consulta Quote.

Oltre alle quote di sicurezza a livello di sistema, per l'utilizzo di Blobstore si applicano i seguenti limiti:

  • La dimensione massima dei dati dell'archivio BLOB che possono essere letti dall'applicazione con una chiamata API è di 32 megabyte.
  • Il numero massimo di file che possono essere caricati in un unico modulo POST è 500.