Panoramica dell'API Blobstore per i servizi in bundle legacy

L'API Blobstore consente alla tua applicazione di pubblicare oggetti di dati, chiamati blob, di dimensioni molto maggiori rispetto a quelle 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 lo fanno presentando all'utente un modulo con un campo di caricamento file. Quando il modulo viene inviato, Blobstore crea un BLOB dai contenuti del file e restituisce un riferimento opaco al BLOB, chiamato chiave BLOB, che puoi utilizzare in un secondo momento per erogare il BLOB. L'applicazione può pubblicare il valore blob completo in risposta a una richiesta dell'utente oppure può leggere il valore direttamente utilizzando un'interfaccia simile a un file di streaming.

Introduzione a Blobstore

App Engine include il servizio Blobstore, che consente alle applicazioni di pubblicare 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 Blobstore o blob. I valori Blobstore vengono pubblicati come risposte dai gestori delle richieste e vengono creati come caricamenti tramite moduli web. Le applicazioni non creano direttamente i dati blob; i blob vengono invece creati indirettamente, tramite un modulo web inviato o un'altra richiesta HTTP POST. I valori Blobstore possono essere pubblicati per l'utente o accessibili dall'applicazione in uno stream simile a un file, utilizzando l'API Blobstore.

Per chiedere a un utente di caricare un valore Blobstore, l'applicazione presenta un modulo web con un campo di caricamento file. L'applicazione genera l'URL dell'azione del modulo chiamando l'API Blobstore. Il browser dell'utente carica il file direttamente in Blobstore tramite l'URL generato. Blobstore archivia 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'ulteriore elaborazione del modulo.

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

I blob non possono essere modificati dopo la creazione, ma possono essere eliminati. Ogni blob ha un record di informazioni blob corrispondente, archiviato nel datastore, che fornisce dettagli sul blob, come l'ora di creazione e il tipo di contenuto. Puoi utilizzare la chiave blob per recuperare i record di informazioni blob ed eseguire query sulle relative proprietà.

Un'applicazione può leggere un valore Blobstore una porzione alla volta utilizzando una chiamata API. La dimensione della porzione può essere fino alla dimensione massima di un valore restituito dall'API. Questa dimensione è leggermente inferiore a 32 megabyte, rappresentata e in Python dalla costante google.appengine.ext.blobstore.MAX_BLOB_FETCH_SIZE . Un'applicazione non può creare o modificare i valori Blobstore se non tramite i file caricati dall'utente.

Utilizzo di Blobstore

Le applicazioni possono utilizzare Blobstore per accettare file di grandi dimensioni come caricamenti dagli utenti e per pubblicare questi file. I file vengono chiamati blob una volta caricati. Le applicazioni non accedono direttamente ai blobLe applicazioni interagiscono con i blob tramite le entità di informazioni blob (rappresentate dalla classe BlobInfo ) in Datastore.

L'utente crea un blob inviando un modulo HTML che includa uno o più campi di immissione file. La tua applicazione chiamate blobstore.create_upload_url() per ottenere la destinazione (l'azione) di questo modulo, passando alla funzione un percorso dell'URL di un gestore nella tua applicazione. Quando l'utente invia il modulo, il browser dell'utente carica i file specificati direttamente in 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 blobstore.create_upload_url() .

Questo gestore può eseguire un'ulteriore elaborazione in base alla chiave blob.

L'applicazione può leggere porzioni di un valore Blobstore utilizzando un interfaccia di streaming simile a un file. Consulta la classe BlobReader.

Caricamento di un blob

Per creare e caricare un blob, segui questa procedura:

1. Crea un URL di caricamento

Chiama blobstore.create_upload_url() per creare un URL di caricamento per il modulo che l'utente compilerà, passando il percorso dell'applicazione da caricare al termine della richiesta POST del modulo.

upload_url = blobstore.create_upload_url("/upload_photo")

Esiste una versione asincrona, create_upload_url_async(). Consente al codice dell'applicazione di continuare a essere eseguito mentre Blobstore genera l'URL di caricamento.

2. Crea un modulo di caricamento

Il modulo deve includere un campo di caricamento file e il relativo enctype deve essere impostato su multipart/form-data. Quando l'utente invia il modulo, la richiesta POST viene gestita dall'API Blobstore, che crea il blob. L'API crea anche un record di informazioni per il blob, lo archivia in Datastore e passa la richiesta riscritta alla tua applicazione nel percorso specificato come chiave blob.

Devi pubblicare la pagina del modulo con un Content-Type di text/html; charset=utf-8, altrimenti i nomi file con caratteri non ASCII verranno interpretati in modo errato.
Poiché Blobstore per Python 3 non utilizza webapp, devi impostare il tuo Content-Type per impedire al framework web di impostare un tipo di contenuto predefinito e ad App Engine di impostarlo su un tipo stimato.

Non puoi utilizzare un bilanciatore del carico delle applicazioni esterno globale con un NEG serverless per gestire le richieste di caricamento inviate all'/_ah/upload/ URL restituito dalla blobstore.create_upload_url chiamata. Devi invece instradare queste richieste di caricamento direttamente al servizio App Engine. Puoi farlo utilizzando il dominio appspot.com o un dominio personalizzato mappato direttamente al servizio App Engine.

3. Implementa il gestore di caricamento

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

Per tutte le app Flask, tutte le chiamate ai metodi della BlobstoreUploadHandler classe richiedono il request.environ dictionary (la richiesta viene importata dal modulo flask). Se la tua app è un'app WSGI senza un framework web, utilizza il parametro environ nel metodo get_uploads(). Quando riscrive la richiesta dell'utente, Blobstore svuota le parti MIME dei file caricati e aggiunge la chiave blob come intestazione della parte MIME. Blobstore conserva tutti gli altri campi e parti del modulo, passandoli al gestore di caricamento. Se non specifichi un tipo di contenuto, Blobstore tenterà di dedurlo dall'estensione del file. Se non riesce a determinare un tipo di contenuto, assegna il tipo di contenuto application/octet-stream al blob appena creato.

Pubblicazione di un blob

Per pubblicare i blob, devi includere un gestore di download dei blob come percorso nella tua applicazione. L'applicazione pubblica un blob impostando un'intestazione nella risposta in uscita. Se utilizzi Flask, la BlobstoreDownloadHandler classe richiede il request.environ dizionario (la richiesta viene importata dal modulo flask). Se la tua app è un' app WSGI senza un framework web, utilizza il parametro environ nei send_blob() metodi .

I blob possono essere pubblicati da qualsiasi URL dell'applicazione. Per erogare 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 una 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 di pubblicare il blob completo. Ecco alcuni esempi di intervalli:

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

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

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.

Applicazione di esempio completa

Consulta l'esempio di app Flask nella guida all'API Blobstore per Python 3.

Utilizzo del servizio Images con Blobstore

Il servizio Images può utilizzare un valore Blobstore come origine di una trasformazione. L'immagine di origine può avere una dimensione massima pari a quella di un valore Blobstore. Il servizio Images restituisce comunque l'immagine trasformata all'applicazione, quindi l'immagine trasformata deve essere inferiore a 32 megabyte. Questa funzionalità è utile per creare immagini miniatura di fotografie di grandi dimensioni caricate dagli utenti. Per informazioni sull'utilizzo del servizio Images con i valori Blobstore, consulta la documentazione del servizio Images.

Utilizzo dell'API Blobstore con 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 Cloud Storage e specificare il bucket e il nome file in blobstore.create_upload_url parametro gs_bucket_name.

Nel gestore di caricamento, devi elaborare la mappa dei metadati FileInfo metadata e archiviare esplicitamente il nome file di Cloud Storage necessario per recuperare il blob in un secondo momento.

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

Se vuoi una soluzione di archiviazione di oggetti più moderna, valuta la migrazione da Blobstore di App Engine a Cloud Storage.

Utilizzo di BlobReader

Un'applicazione può leggere i dati dai valori Blobstore utilizzando un'interfaccia simile a un oggetto file Python. Questa interfaccia può iniziare a leggere un valore in qualsiasi posizione di byte e utilizza più chiamate di servizio e buffering, in modo che un'applicazione possa accedere alla dimensione completa del valore nonostante il limite alla dimensione di una singola risposta alla chiamata di servizio.

La BlobReader classe può accettare uno dei tre valori seguenti come argomento del suo costruttore:

L'oggetto implementa i metodi di file familiari per la lettura del valore. L'applicazione non può modificare il valore Blobstore; i metodi di file per la scrittura non sono implementati.

# Instantiate a BlobReader for a given Blobstore blob_key.
blob_reader = blobstore.BlobReader(blob_key)

# Instantiate a BlobReader for a given Blobstore blob_key, setting the
# buffer size to 1 MB.
blob_reader = blobstore.BlobReader(blob_key, buffer_size=1048576)

# Instantiate a BlobReader for a given Blobstore blob_key, setting the
# initial read position.
blob_reader = blobstore.BlobReader(blob_key, position=0)

# Read the entire value into memory. This may take a while depending
# on the size of the value and the size of the read buffer, and is not
# recommended for large values.
blob_reader_data = blob_reader.read()

# Write the contents to the response.
self.response.headers["Content-Type"] = "text/plain"
self.response.write(blob_reader_data)

# Set the read position back to 0, then read and write 3 bytes.
blob_reader.seek(0)
blob_reader_data = blob_reader.read(3)
self.response.write(blob_reader_data)
self.response.write("\n")

# Set the read position back to 0, then read and write one line (up to
# and including a '\n' character) at a time.
blob_reader.seek(0)
for line in blob_reader:
    self.response.write(line)

Effettuare richieste asincrone

Un'applicazione può chiamare alcune funzioni Blobstore che funzionano in background. Blobstore esegue la richiesta mentre l'applicazione esegue altre operazioni. Per effettuare la richiesta, l'applicazione chiama una funzione asincrona. La funzione restituisce immediatamente un oggetto RPC; questo oggetto rappresenta la richiesta. Quando l'applicazione ha bisogno del risultato della richiesta, chiama il metodo get_result() dell'oggetto RPC.

Se il servizio non ha completato la richiesta quando l'applicazione chiama get_result(), il metodo attende il completamento della richiesta (o il raggiungimento della scadenza o il verificarsi di un errore). Il metodo restituisce l'oggetto risultato o genera un'eccezione se si è verificato un errore durante l'esecuzione della richiesta. Ad esempio, questo snippet di codice

upload_url = blobstore.create_upload_url('/upload')
slow_operation()
self.response.out.write("""<form action="%s" method="POST"
                           enctype="multipart/form-data">""" % upload_url)

diventa

upload_url_rpc = blobstore.create_upload_url_async('/upload')
slow_operation()
upload_url = upload_url_rpc.get_result()
self.response.out.write("""<form action="%s" method="POST"
                           enctype="multipart/form-data">""" % upload_url)

In questo esempio, l'applicazione esegue il codice slow_operation() contemporaneamente alla generazione dell'URL di caricamento da parte di Blobstore.

Quote e limiti

Lo spazio utilizzato per i valori Blobstore contribuisce alla quota Dati archiviati (fatturabili). Le entità di informazioni blob in Datastore vengono conteggiate ai fini dei limiti relativi a Datastore. Tieni presente che Cloud Storage è un servizio a pagamento; ti verrà addebitato un costo in base al listino prezzi di Cloud Storage Cloud Storage.

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

Oltre alle quote di sicurezza a livello di sistema, i seguenti limiti si applicano in modo specifico all'utilizzo di Blobstore:

  • La dimensione massima dei dati Blobstore che possono essere letti dall'applicazione con una chiamata API è di 32 megabyte.
  • Il numero massimo di file che possono essere caricati in una singola richiesta POST del modulo è 500.