Gestori Blobstore webapp

webapp include classi di gestore delle richieste per l'utilizzo dell'API Blobstore. BlobstoreUploadHandler fornisce la logica per l'analisi della richiesta di caricamento passata tramite Blobstore nei record BlobInfo per l'ulteriore elaborazione. BlobstoreDownloadHandler semplifica il servizio dei valori di Blobstore da qualsiasi percorso.

BlobstoreUploadHandler

I valori vengono aggiunti a Blobstore tramite i caricamenti di file pubblicati dagli utenti o dagli amministratori dell'app. L'app pubblica un modulo web con un campo di caricamento file e un'azione del modulo che indirizza il caricamento a Blobstore. L'app recupera l'URL dell'azione del modulo chiamando una funzione (create_upload_url()), passando l'URL di un gestore dell'app che viene chiamato quando gli utenti caricano file. Un'applicazione web può utilizzare una sottoclasse della classe BlobstoreUploadHandler come gestore per questo URL.

Il metodo get_uploads() restituisce un elenco di oggetti BlobInfo, uno per ogni file caricato nella richiesta. Ogni oggetto contiene la chiave Blobstore per il valore caricato, nonché metadati come il nome del file e le dimensioni. Ogni file caricato ha anche un'entità corrispondente nel datastore con queste informazioni, quindi puoi recuperare l'oggetto BlobInfo in un secondo momento in base a una chiave blob o eseguire una query sul datastore sui campi dei metadati. L'handler di caricamento analizza queste informazioni direttamente dai dati della richiesta, non dal datastore.

Per impostazione predefinita, get_uploads() restituisce oggetti BlobInfo per tutti i file caricati nella richiesta. Il metodo accetta anche un argomento field_name per ottenere solo il file (o i file) per un determinato campo di caricamento file. Il valore restituito è sempre un elenco, eventualmente vuoto.

class PhotoUploadHandler(blobstore_handlers.BlobstoreUploadHandler):
    def post(self):
        upload = self.get_uploads()[0]
        user_photo = UserPhoto(
            user=users.get_current_user().user_id(),
            blob_key=upload.key())
        user_photo.put()

        self.redirect('/view_photo/%s' % upload.key())

Utilizzo di BlobstoreUploadHandler con Google Cloud Storage

Se utilizzi questo gestore dei caricamenti con Cloud Storage, devi recuperare e memorizzare il nome file completo dell'oggetto Cloud Storage, poiché è necessario per recuperare di nuovo il file da Cloud Storage. Utilizza la funzione get_file_infos, che restituisce un elenco di record FileInfo corrispondenti a ogni caricamento. Il nome completo dell'oggetto Cloud Storage, il tipo di contenuti, la data di creazione e altri dati sono disponibili in FileInfo. (visita il link per informazioni dettagliate).

BlobstoreDownloadHandler

Per pubblicare un valore dell'archivio BLOB, l'applicazione imposta l'intestazione X-AppEngine-BlobKey sul valore di una chiave dell'archivio BLOB in formato stringa. Quando App Engine vede questa intestazione nella risposta, pubblica il valore del blob come corpo della risposta. La classe di gestore della web app BlobstoreDownloadHandler semplifica l'impostazione di questo valore nella risposta.

Il metodo send_blob() accetta un oggetto BlobKey, una chiave di stringa o un oggetto BlobInfo come argomento blob_key_or_info e imposta i dati di risposta in modo che il valore del blob venga fornito all'utente. Il metodo accetta un argomento content_type facoltativo che aggira il tipo di contenuti MIME del valore del blob archiviato. Per impostazione predefinita, il blob viene pubblicato con il tipo di contenuti impostato dal client che lo ha caricato, un tipo di contenuti derivato dal nome file o un tipo generico se non sono disponibili altre informazioni sul tipo.

Il metodo send_blob() accetta un argomento save_as che determina se i dati del blob vengono inviati come dati di risposta non elaborati o come allegato MIME con un nome file. Se l'argomento è una stringa, il blob viene inviato come allegato e il valore della stringa viene utilizzato come nome file. Se True e blob_key_or_info sono oggetti BlobInfo, viene utilizzato il nome file dell'oggetto. Per impostazione predefinita, i dati del blob vengono inviati come corpo della risposta e non come allegato MIME.

class ViewPhotoHandler(blobstore_handlers.BlobstoreDownloadHandler):
    def get(self, photo_key):
        if not blobstore.get(photo_key):
            self.error(404)
        else:
            self.send_blob(photo_key)

Blobstore supporta l'invio di solo una parte di un valore anziché del valore completo, descritto come un intervallo di indici di byte. Puoi fornire un intervallo di indici di byte al metodo send_blob() di BlobstoreDownloadHandler in due modi. La prima consiste nello specificare l'intervallo come argomenti start e end:

            # Send the first 1,000 bytes of the value.
            self.send_blob(key, start=0, end=999)

Per impostazione predefinita, BlobstoreDownloadHandler rispetta l'intestazione range nella richiesta. Se vuoi bloccare l'utilizzo dell'intestazione dell'intervallo originale, fornisci il parametro use_range=False a send_blob():

            # Send the full value of the blob and
            # block the "range" header.
            self.send_blob(key, use_range=False)

Il valore dell'intestazione range è un intervallo di byte HTTP standard. BlobstoreDownloadHandler utilizza webob.byterange per analizzare questo valore dell'intestazione.

Applicazione di esempio completa

Nella seguente applicazione di esempio, l'URL principale dell'applicazione carica il modulo che chiede all'utente di caricare un file e il gestore del caricamento chiama immediatamente il gestore del download per pubblicare i dati. Questo per semplificare l'applicazione di esempio. In pratica, probabilmente non utilizzerai l'URL principale per richiedere i dati di caricamento né pubblicherai immediatamente un blob appena caricato.

from google.appengine.api import users
from google.appengine.ext import blobstore
from google.appengine.ext import ndb
from google.appengine.ext.webapp import blobstore_handlers
import webapp2


# This datastore model keeps track of which users uploaded which photos.
class UserPhoto(ndb.Model):
    user = ndb.StringProperty()
    blob_key = ndb.BlobKeyProperty()


class PhotoUploadFormHandler(webapp2.RequestHandler):
    def get(self):
        upload_url = blobstore.create_upload_url('/upload_photo')
        # To upload files to the blobstore, the request method must be "POST"
        # and enctype must be set to "multipart/form-data".
        self.response.out.write("""
<html><body>
<form action="{0}" method="POST" enctype="multipart/form-data">
  Upload File: <input type="file" name="file"><br>
  <input type="submit" name="submit" value="Submit">
</form>
</body></html>""".format(upload_url))


class PhotoUploadHandler(blobstore_handlers.BlobstoreUploadHandler):
    def post(self):
        upload = self.get_uploads()[0]
        user_photo = UserPhoto(
            user=users.get_current_user().user_id(),
            blob_key=upload.key())
        user_photo.put()

        self.redirect('/view_photo/%s' % upload.key())


class ViewPhotoHandler(blobstore_handlers.BlobstoreDownloadHandler):
    def get(self, photo_key):
        if not blobstore.get(photo_key):
            self.error(404)
        else:
            self.send_blob(photo_key)


app = webapp2.WSGIApplication([
    ('/', PhotoUploadFormHandler),
    ('/upload_photo', PhotoUploadHandler),
    ('/view_photo/([^/]+)?', ViewPhotoHandler),
], debug=True)