Blobstore API für gebündelte Legacy-Dienste

Die Blobstore API ermöglicht einer Anwendung, als Blobs bezeichnete Datenobjekte bereitzustellen, deren Größe die im Datastore-Dienst zulässige maximale Objektgröße bei Weitem überschreitet. Blobs sind hilfreich, um große Dateien bereitzustellen, z. B. Video- oder Bilddateien, und um Nutzern das Hochladen großer Datendateien zu ermöglichen. Blobs werden durch Hochladen einer Datei über eine HTTP-Anfrage erstellt. Dazu wird dem Nutzer in der Regel in der Anwendung ein Formular mit einem entsprechenden Feld angezeigt. Wenn das Formular gesendet wird, erstellt Blobstore aus den Dateiinhalten ein Blob und gibt eine intransparente Referenz zurück. Diese wird als Blob-Schlüssel bezeichnet und Sie können sie später zum Bereitstellen des Blobs verwenden. Die Anwendung kann als Antwort auf eine Nutzeranfrage den vollständigen Blob-Wert bereitstellen oder den Wert über eine dateiähnliche Streaming-Schnittstelle lesen.

Einführung in Blobstore

Google App Engine enthält den Blobstore-Dienst, mit dem Anwendungen sehr große Datenobjekte bereitstellen können. Die Größe ist nur durch die Datenmenge begrenzt, die über eine einzelne HTTP-Verbindung hoch- bzw. heruntergeladen werden kann. Diese Objekte heißen Blobstore-Werte oder Blobs. Ein Blobstore-Wert wird als Antwort eines Anfrage-Handlers bereitgestellt und als Upload über ein Webformular erstellt. Blob-Daten werden von Anwendungen nicht direkt erstellt. Stattdessen werden Blobs indirekt über ein Webformular oder eine andere POST-HTTP-Anfrage angelegt. Mithilfe der Blobstore API können Blobstore-Werte dem Nutzer bereitgestellt oder von der Anwendung in einem dateiähnlichen Stream abgerufen werden.

In der Anwendung wird ein Webformular mit einem Feld zum Dateiupload angezeigt, über das der Nutzer einen Blobstore-Wert hochladen kann. Die Anwendung ruft die Blobstore API auf und generiert damit die Aktions-URL des Formulars. Im Browser des Nutzers wird die Datei über die generierte URL direkt in Blobstore hochgeladen. Blobstore speichert das Blob, fügt den Blob-Schlüssel in die Anfrage ein und übergibt ihn an einen Pfad in Ihrer Anwendung. Ein Anfrage-Handler unter diesem Anwendungspfad kann das Formular dann weiter verarbeiten.

Zum Bereitstellen eines Blobs legt die Anwendung einen Header für die ausgehende Antwort fest und App Engine ersetzt die Antwort durch den Blob-Wert.

Nach ihrer Erstellung können Blobs nicht mehr geändert, aber gelöscht werden. Für jedes Blob wird im Datenspeicher ein Blob-Informationseintrag angelegt, der Details zum Blob enthält (z. B. Erstellungszeitpunkt und Inhaltstyp). Sie können den Blob-Schlüssel verwenden, um Blob-Informationseinträge abzurufen und die enthaltenen Properties abzufragen.

Blobstore verwenden

Anwendungen können mit Blobstore große Dateien, die von Nutzern hochgeladen werden, verarbeiten und bereitstellen. Sobald sie hochgeladen wurden, werden diese Dateien als Blobs bezeichnet. Anwendungen greifen nicht direkt anhand des Dateinamens auf Blobs zu. Stattdessen verweisen sie mithilfe des Typs appengine.BlobKey darauf.

Der Nutzer erstellt ein Blob, indem er ein HTML-Formular mit einem oder mehreren Dateieingabefeldern sendet. Ihre Anwendung legt blobstore.UploadURL als Ziel (Aktion) für dieses Formular fest und übergibt die Funktion einem URL-Pfad eines Handlers in der Anwendung. Sendet der Nutzer das Formular ab, lädt der Browser die angegebenen Dateien direkt in Blobstore hoch. Der Blobstore schreibt die Anfrage des Nutzers um und speichert die hochgeladenen Dateidaten. Dabei ersetzt er die hochgeladenen Dateidaten mit einem oder mehreren übereinstimmenden Blob-Schlüsseln und gibt dann die umgeschriebene Anfrage an den Handler weiter, dessen URL-Pfad Sie blobstore.UploadURL zugewiesen haben. Der Handler kann auf Grundlage des Blob-Schlüssels weitere Verarbeitungsschritte ausführen. Zum Schluss muss der Handler eine Weiterleitungsantwort zurückgeben, die nur einen Header enthält (301, 302 oder 303). Dies ist üblicherweise eine Browserweiterleitung auf eine andere Seite, auf der der Status des Blob-Uploads angegeben wird.

Die Anwendung kann Teile eines Blobstore-Werts mit einem blobstore.Reader lesen.

Blob hochladen

Gehen Sie beim Erstellen und Hochladen eines Blobs folgendermaßen vor:

1. Upload-URL erstellen

Rufen Sie blobstore.UploadURL auf, um eine Upload-URL für das Formular zu erstellen, das vom Nutzer ausgefüllt wird. Dabei wird der Anwendungspfad übergeben, der nach Fertigstellung des POST des Formulars geladen werden soll.

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

2. Uploadformular erstellen

Das Formular muss ein Feld für das Hochladen von Dateien enthalten und der enctype des Formulars muss auf multipart/form-data festgelegt sein. Wenn der Nutzer das Formular absendet, wird der POST von der Blobstore API verarbeitet, die das Blob erstellt. Die API erstellt auch den Informationseintrag für das Blob und speichert ihn im Datenspeicher. Außerdem übergibt sie die umgeschriebene Anfrage als Blob-Schlüssel unter dem angegebenen Pfad an die Anwendung.

	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. Upload-Handler implementieren

In diesem Handler können Sie den Blob-Schlüssel zusammen mit dem restlichen Datenmodell der Anwendung speichern. Auf den Blob-Schlüssel selbst lässt sich über die Blob-Informationsentität im Datenspeicher zugreifen. Beachten Sie, dass das Blob bereits gespeichert und die Blob-Informationen dem Datenspeicher hinzugefügt wurden, nachdem der Nutzer das Formular gesendet hat und der Handler aufgerufen wurde. Wenn Ihre Anwendung das Blob nicht mehr benötigt, sollten Sie es sofort löschen, damit es nicht verwaist:

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)

Wenn der Blobstore den Nutzer-Request neu schreibt, wird der Text in den MIME-Teilen der hochgeladenen Dateien gelöscht und der Blob-Schlüssel wird als Header für die MIME-Teile hinzugefügt. Alle anderen Formularfelder und Teile werden beibehalten und an den Upload-Handler weitergeleitet. Wenn Sie keinen Inhaltstyp angeben, versucht Blobstore, ihn von der Dateierweiterung abzuleiten. Wenn sich kein Inhaltstyp ermitteln lässt, wird dem neu erstellten Blob der Inhaltstyp application/octet-stream zugewiesen.

Blob bereitstellen

Um Blobs bereitzustellen, müssen Sie in der Anwendung einen Blob-Download-Handler als Pfad angeben. Dieser Handler sollte den Blob-Schlüssel für das gewünschte Blob an blobstore.Send weitergeben. In diesem Beispiel wird der Blob-Schlüssel als URL-Argument r.FormValue("blobKey") an den Download-Handler weitergegeben. In der Praxis kann der Download-Handler den Blob-Schlüssel gemäß Ihren Vorgaben abrufen, zum Beispiel durch eine andere Methode oder eine Nutzeraktion.

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

Blobs können über jede Anwendungs-URL bereitgestellt werden. Wenn Sie ein Blob in Ihrer Anwendung bereitstellen möchten, fügen Sie der Antwort einen speziellen Header hinzu, die den Blob-Schlüssel enthält. App Engine ersetzt den Antworttext durch den Blob-Inhalt.

Blob-Bytebereiche

Statt der Bereitstellung des vollständigen Werts bei einer Antwort zu einer Anfrage wird bei Blobstore die Bereitstellung von Teilen eines großen Werts unterstützt. Fügen Sie den Header X-AppEngine-BlobRange in die ausgehende Antwort ein, um einen Teilwert bereitzustellen. Der Wert dieses Headers ist ein normaler HTTP-Bytebereich. Die Bytenummerierung ist nullbasiert. Wenn X-AppEngine-BlobRange leer ist, ignoriert die API den Bereichsheader und stellt das vollständige Blob bereit. Einige Beispielbereiche:

  • 0-499 stellt die ersten 500 Byte des Werts bereit (Byte 0 bis einschließlich Byte 499).
  • 500-999 stellt 500 Byte ab Byte 501 bereit.
  • 500- stellt alle Byte ab Byte 501 bis zum Ende des Werts bereit.
  • -500 stellt die letzten 500 Byte des Werts bereit.

Wenn der Bytebereich für den Blobstore-Wert gültig ist, sendet Blobstore den Statuscode 206 Partial Content und den angeforderten Bytebereich an den Client. Wenn der Bereich für den Wert nicht gültig ist, sendet Blobstore 416 Requested Range Not Satisfiable.

Die Angabe mehrerer Bytebereiche (z. B. 100-199,200-299) in einer Anfrage wird unabhängig davon, ob sie sich überschneiden, vom Blobstore nicht unterstützt.

Komplette Beispielanwendung

In der folgenden Beispielanwendung wird über die Haupt-URL der Anwendung das Formular geladen, das den Nutzer zum Hochladen einer Datei auffordert. Der Upload-Handler ruft sofort den Download-Handler auf, um die Daten bereitzustellen. Das vereinfacht die Beispielanwendung. In der Praxis würden Sie wahrscheinlich nicht die Haupt-URL verwenden, um das Hochladen von Daten einzufordern. Und Sie würden ein gerade hochgeladenes Blob auch nicht sofort bereitstellen.


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

Blobstore API mit Google Cloud Storage verwenden

Die Blobstore API ermöglicht das Speichern von Blobs in Cloud Storage statt in Blobstore. Dazu müssen Sie gemäß der Dokumentation zu Google Cloud Storage einen Bucket einrichten und diesen zusammen mit dem Dateinamen in UploadURLOptions für die Funktion UploadURL angeben. Im Upload-Handler müssen Sie die zurückgegebene Zuordnung der zurückgegebenen Blobs verarbeiten und den Google Cloud Storage-Dateinamen, der zum späteren Abrufen des Blobs benötigt wird, explizit speichern.

Cloud Storage-Objekte lassen sich auch mithilfe der Blobstore API bereitstellen. Verwenden Sie zum Bereitstellen eines Cloud Storage-Objekts BlobKeyForFile, um den erforderlichen blobkey zu erstellen, wie unter Blob bereitstellen beschrieben.

Kontingente und Limits

Der von Blobstore-Werten belegte Speicherplatz wird dem Kontingent Gespeicherte Daten (kostenpflichtig) angerechnet. Blob-Informationsentitäten im Datenspeicher werden den datenspeicherspezifischen Beschränkungen angerechnet. Google Cloud Storage ist ein zahlungspflichtiger nutzungsbasierter Dienst. Die anfallenden Kosten richten sich nach der Preisübersicht für Cloud Storage.

Weitere Informationen zu den systemweiten Sicherheitskontingenten finden Sie unter Kontingente.

Neben den systemweiten Sicherheitskontingenten gelten speziell für Blobstore folgende Beschränkungen:

  • Mit einem einzelnen API-Aufruf kann eine Anwendung maximal 32 Megabyte Blobstore-Daten lesen.
  • Mit einem einzigen Formular-POST können maximal 500 Dateien hochgeladen werden.
Wie Sie diese Größenbeschränkungen umgehen können, lesen Sie in der Dokumentation zur Send-Funktion.