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, ad esempio 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 possono farlo presentando all'utente un modulo con un campo di caricamento 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 inserimento di flussi.

Ti presentiamo 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 BLOB o BLOB. I valori BLOB vengono forniti 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 di tipo 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. Blobstore quindi archivia il BLOB, riscrive la richiesta in modo che contenga la chiave BLOB e la passa a un percorso dell'applicazione. Un gestore delle richieste in quel percorso nella tua applicazione può eseguire un'ulteriore elaborazione dei moduli.

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 è associato un record di informazioni sul BLOB, archiviato nel datastore, che fornisce i dettagli sul BLOB, ad esempio data e ora di creazione e tipo di contenuti. Puoi utilizzare la chiave BLOB per recuperare record con informazioni sui BLOB ed eseguire query sulle relative proprietà.

Utilizzo dell'archivio BLOB

Le applicazioni possono utilizzare l'archivio BLOB per accettare file di grandi dimensioni come caricamenti degli utenti e pubblicarli. Una volta caricati, i file vengono chiamati BLOB. Le applicazioni non possono accedere ai BLOB direttamente in base al nome file. Le applicazioni fanno invece riferimento ai BLOB tramite il tipo appengine.BlobKey.

L'utente crea un blob inviando un modulo HTML che includa uno o più campi di immissione file. L'applicazione imposta blobstore.UploadURL come destinazione (azione) di questo modulo, trasmettendo alla funzione il percorso dell'URL di un gestore nell'applicazione. Quando l'utente invia il modulo, il browser carica i file specificati direttamente nel Blobstore. Il Blobstore riscrive la richiesta dell'utente e archivia i dati del file caricato, sostituendo questi dati con una o più chiavi BLOB corrispondenti, quindi passa la richiesta riscritta al gestore nel percorso dell'URL che hai fornito a blobstore.UploadURL. Questo gestore può eseguire elaborazioni aggiuntive in base alla chiave BLOB. Infine, il gestore deve restituire una risposta di reindirizzamento (301, 302 o 303) di sole intestazioni, in genere un reindirizzamento del browser a un'altra pagina in cui viene indicato lo stato del caricamento del BLOB.

L'applicazione può leggere parti di un valore Blobstore utilizzando un blobstore.Reader.

Caricamento di un blob

Per creare e caricare un BLOB, segui questa procedura:

1. Creare un URL di caricamento

Chiama blobstore.UploadURL per creare un URL di caricamento per il modulo che l'utente compilerà, trasmettendo il percorso della domanda da caricare una volta completato il campo POST del modulo.

ctx := appengine.NewContext(r)
uploadURL, err := blobstore.UploadURL(ctx, "/upload", nil)
if err != nil {
	serveError(ctx, w, err)
	return
}

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.

	var rootTemplate = template.Must(template.New("root").Parse(rootTemplateHTML))

	const rootTemplateHTML = `
<html><body>
<form action="{{.}}" method="POST" enctype="multipart/form-data">
Upload File: <input type="file" name="file"><br>
<input type="submit" name="submit" value="Submit">
</form></body></html>
`

3. Implementare il gestore dei caricamenti

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

ctx := appengine.NewContext(r)
blobs, _, err := blobstore.ParseUpload(r)
if err != nil {
	serveError(ctx, w, err)
	return
}
file := blobs["file"]
if len(file) == 0 {
	log.Errorf(ctx, "no file uploaded")
	http.Redirect(w, r, "/", http.StatusFound)
	return
}
http.Redirect(w, r, "/serve/?blobKey="+string(file[0].BlobKey), http.StatusFound)

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 passati al gestore del caricamento. Se non specifichi un tipo di contenuto, 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 nell'applicazione. Questo gestore deve passare la chiave del blob desiderato a blobstore.Send. In questo esempio, la chiave blob viene passata al gestore dei download come argomento dell'URL r.FormValue("blobKey"). In pratica, il gestore dei download può ottenere la chiave blob con qualsiasi mezzo scelto, ad esempio con un altro metodo o con un'altra azione utente.

blobstore.Send(w, appengine.BlobKey(r.FormValue("blobKey")))

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 del 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 elevato anziché dell'intero valore 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 in byte è in base a zero. Un elemento 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, l'archivio BLOB 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.

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

Completa applicazione di esempio

Nella seguente applicazione di esempio, l'URL principale dell'applicazione carica il modulo che richiede all'utente il caricamento di un file e il gestore del caricamento chiama immediatamente il gestore dei download per pubblicare 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 che hai appena caricato.


package blobstore_example

import (
	"context"
	"html/template"
	"io"
	"net/http"

	"google.golang.org/appengine"
	"google.golang.org/appengine/blobstore"
	"google.golang.org/appengine/log"
)

func serveError(ctx context.Context, w http.ResponseWriter, err error) {
	w.WriteHeader(http.StatusInternalServerError)
	w.Header().Set("Content-Type", "text/plain")
	io.WriteString(w, "Internal Server Error")
	log.Errorf(ctx, "%v", err)
}

var rootTemplate = template.Must(template.New("root").Parse(rootTemplateHTML))

const rootTemplateHTML = `
<html><body>
<form action="{{.}}" method="POST" enctype="multipart/form-data">
Upload File: <input type="file" name="file"><br>
<input type="submit" name="submit" value="Submit">
</form></body></html>
`

func handleRoot(w http.ResponseWriter, r *http.Request) {
	ctx := appengine.NewContext(r)
	uploadURL, err := blobstore.UploadURL(ctx, "/upload", nil)
	if err != nil {
		serveError(ctx, w, err)
		return
	}
	w.Header().Set("Content-Type", "text/html")
	err = rootTemplate.Execute(w, uploadURL)
	if err != nil {
		log.Errorf(ctx, "%v", err)
	}
}

func handleServe(w http.ResponseWriter, r *http.Request) {
	blobstore.Send(w, appengine.BlobKey(r.FormValue("blobKey")))
}

func handleUpload(w http.ResponseWriter, r *http.Request) {
	ctx := appengine.NewContext(r)
	blobs, _, err := blobstore.ParseUpload(r)
	if err != nil {
		serveError(ctx, w, err)
		return
	}
	file := blobs["file"]
	if len(file) == 0 {
		log.Errorf(ctx, "no file uploaded")
		http.Redirect(w, r, "/", http.StatusFound)
		return
	}
	http.Redirect(w, r, "/serve/?blobKey="+string(file[0].BlobKey), http.StatusFound)
}

func init() {
	http.HandleFunc("/", handleRoot)
	http.HandleFunc("/serve/", handleServe)
	http.HandleFunc("/upload", handleUpload)
}

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 nel campo UploadURLOptions fornito per la funzione UploadURL. Nel gestore del caricamento, devi elaborare la mappa restituita dei BLOB 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 di Cloud Storage utilizzando l'API Blobstore. Per gestire un oggetto Cloud Storage, utilizza BlobKeyForFile per generare il blobkey richiesto come descritto in Pubblicare un blob.

Quote e limiti

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

Per maggiori informazioni sulle quote di sicurezza a livello di sistema, consulta Quote.

Oltre alle quote di sicurezza a livello di sistema, all'utilizzo di Blobstore si applicano in modo specifico 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 POST in un unico formato è 500.
Per informazioni su come aggirare i limiti di dimensione, consulta la documentazione della funzione Send.