Push-Aufgaben erstellen

Auf dieser Seite wird gezeigt, wie Sie Aufgaben erstellen und in Push-Warteschlangen einfügen. Wenn Sie eine Aufgabe verarbeiten möchten, müssen Sie ein neues Aufgabenobjekt erstellen und in eine Warteschlange stellen. Sie können den Dienst und den Handler, mit denen die Aufgabe verarbeitet wird, ausdrücklich angeben und optional aufgabenspezifische Daten an den Handler weiterleiten. Außerdem können Sie für die Konfiguration der Aufgabe Feineinstellungen vornehmen, z. B. einen Zeitpunkt in der Zukunft festlegen, an dem die Aufgabe ausgeführt werden soll, oder die Anzahl ihrer Wiederholungen bei Fehlversuchen beschränken.

Neue Aufgabe erstellen

Um eine Aufgabe zu erstellen und in eine Warteschlange einzufügen, rufen Sie die Funktion taskqueue.Add auf.

import("google.golang.org/appengine/taskqueue")

Worker-Dienst angeben

Wenn eine Aufgabe in der Warteschlange an der Reihe ist, wird sie vom Dienst für Aufgabenwarteschlangen an einen Worker-Dienst gesendet. Jede Aufgabe verfügt über ein Ziel und eine URL, mit denen bestimmt wird, von welchem Dienst und Handler die Aufgabe letztendlich ausgeführt wird.

target

Mit dem Ziel wird der Dienst angegeben, der die HTTP-Anfrage zur Ausführung der Aufgabe erhält. Dabei handelt es sich um einen String, mit dem ein Dienst, eine Version oder eine Instanz in einem der kanonischen Formate angegeben wird. Am häufigsten werden folgende Formate verwendet:

    service
    version.service
    instance.version.service

Der String „target“ wird dem Domainnamen Ihrer Anwendung vorangestellt. Es gibt drei Möglichkeiten, um das Ziel für eine Aufgabe festzulegen:

  • Sie deklarieren das Ziel beim Erstellen der Aufgabe. Für die explizite Angabe des Ziels beim Erstellen des Objekts Task legen Sie den Header Host fest: 

    h := http.Header{}
h.Add("Host", "versionHostname")
task := taskqueue.Task{
	Header: h,
}

  • Fügen Sie eine target-Anweisung hinzu, wenn Sie eine Warteschlange in der Datei queue.yaml definieren, genauso wie bei der Definition von queue-blue. Alle Aufgaben, die mit target in die Warteschlange eingefügt werden, verwenden dieses Ziel, auch wenn der Aufgabe zum Zeitpunkt ihres Erstellens ein anderes Ziel zugewiesen war.

  • Wenn kein Ziel mit einer der beiden vorherigen Methoden angegeben wurde, ist das Ziel der Aufgabe die Version des Dienstes, von der sie in die Warteschlange gestellt wurde. Wenn Sie auf diese Weise eine Aufgabe vom Standarddienst und der Standardversion in die Warteschlange einfügen und sich die Standardversion vor Ausführung der Aufgabe ändert, wird die Aufgabe in der neuen Standardversion ausgeführt.

url

url wählt einen der Handler im Zieldienst aus, der die Aufgabe ausführen soll.

Dabei muss url mit einem der URL-Muster des Handlers im Zieldienst übereinstimmen. url kann Abfrageparameter enthalten, wenn in der Aufgabe die Methode GET oder PULL festgelegt wurde. Wenn kein url-Wert in der Standard-URL festgelegt ist, wird /_ah/queue/[QUEUE_NAME] verwendet. Dabei ist [QUEUE_NAME] der Name der Aufgabenwarteschlange.

Daten an den Handler übergeben

Sie können Daten als Abfrageparameter an den Handler in der URL der Aufgabe übergeben. Voraussetzung ist, dass in der Aufgabe die Methode GET oder PULL angegeben wurde.

Die Funktion NewPOSTTask hat ein Positionsargument für „query_data“. Diese Daten bestehen in der Regel aus einem Wörterbuch von Schlüssel/Wert-Paaren. Wenn die Methode der Aufgabe POST oder PUT lautet, werden die Daten der Nutzlast der HTTP-Anfrage hinzugefügt. Wenn die Methode GET lautet, werden sie der URL als Abfrageparameter hinzugefügt.

Aufgabe benennen

Wenn Sie eine neue Aufgabe erstellen, wird ihr von App Engine standardmäßig ein eindeutiger Name zugewiesen. Sie können einer Aufgabe jedoch mit dem Parameter name auch eigene Namen zuweisen. Die Zuweisung eigener Aufgabennamen hat den Vorteil, dass benannte Aufgaben dedupliziert werden. So können Sie anhand von Aufgabennamen gewährleisten, dass eine Aufgabe nur einmal hinzugefügt wird. Die Deduplizierung wird noch neun Tage fortgeführt, nachdem die Aufgabe abgeschlossen oder gelöscht wurde.

Dabei ist zu beachten, dass die Deduplizierungslogik zu signifikanten Leistungseinbußen führen und die Latenzen und unter Umständen auch die Fehlerraten im Zusammenhang mit benannten Aufgaben erhöhen kann. Bei sequenziellen Aufgabennamen, beispielsweise mit Zeitstempeln, können diese Einbußen noch erheblich höher ausfallen. Wir empfehlen daher, beim Zuweisen eigener Namen ein wohlüberlegtes Präfix für Aufgabennamen zu verwenden, beispielsweise einen Hashwert des Inhalts.

Wenn Sie Aufgaben eigene Namen zuweisen, dürfen Sie die maximale Namenslänge von 500 Zeichen nicht überschreiten. Der Name kann Groß- und Kleinbuchstaben, Zahlen sowie Unter- und Bindestriche enthalten.

Aufgaben in Cloud Datastore-Transaktionen in die Warteschlange stellen

Sie können eine Aufgabe als Teil einer Datastore-Transaktion in die Warteschlange stellen, sodass die Aufgabe dann – und nur dann – in die Warteschlange aufgenommen wird, wenn der Commit für die Transaktion erfolgreich ausgeführt wurde. Aufgaben, die Sie einer Transaktion hinzufügen, werden als Teil dieser Transaktion behandelt. Für sie gilt das gleiche Maß an Isolation und Konsistenz.

Eine Anwendung kann während einer einzelnen Transaktion nicht mehr als fünf Transaktionsaufgaben in Aufgabenwarteschlangen einfügen. Transaktionsaufgaben dürfen keine vom Nutzer angegebenen Namen haben.

Mit dem folgenden Beispielcode wird gezeigt, wie Sie Transaktionsaufgaben als Teil einer Datastore-Transaktion in eine Push-Warteschlange einfügen:

import (
	"net/url"

	"golang.org/x/net/context"

	"google.golang.org/appengine/datastore"
	"google.golang.org/appengine/taskqueue"
)

func f(ctx context.Context) {
	err := datastore.RunInTransaction(ctx, func(ctx context.Context) error {
		t := taskqueue.NewPOSTTask("/worker", url.Values{
			// ...
		})
		// Use the transaction's context when invoking taskqueue.Add.
		_, err := taskqueue.Add(ctx, t, "")
		if err != nil {
			// Handle error
		}
		// ...
		return nil
	}, nil)
	if err != nil {
		// Handle error
	}
	// ...
}

Paket „delay“ statt eines Worker-Diensts verwenden

Das Einrichten eines Handlers für jede einzelne Aufgabe (wie in den vorherigen Abschnitten beschrieben) kann wie das Serialisieren und Deserialisieren komplexer Argumente für die Aufgabe mühsam sein. Dies trifft vor allem dann zu, wenn Sie viele verschiedene, aber kleine Aufgaben haben, die Sie in der Warteschlange ausführen möchten. Das Go SDK enthält ein Paket (appengine/delay), das eine einfache API enthält, mit der Sie die Einrichtung dedizierter Aufgaben-Handler sowie die Serialisierung und Deserialisierung Ihrer Parameter umgehen können.

So verwenden Sie das Paket delay:

var expensiveFunc = delay.Func("some-arbitrary-key", func(ctx context.Context, a string, b int) {
	// do something expensive!
})

// Somewhere else
expensiveFunc.Call(ctx, "Hello, world!", 42)

Das Paket delay serialisiert Ihren Funktionsaufruf und seine Argumente und fügt ihn dann der Aufgabenwarteschlange hinzu. Das Paket delay führt die Funktion aus, wenn die Aufgabe ausgeführt wird.

Weitere Informationen zur Verwendung des Pakets delay finden Sie in der zugehörigen Dokumentation.

Aufgaben in einer mehrinstanzenfähigen Anwendung

Push-Warteschlangen verwenden standardmäßig den Namespace, der zum Zeitpunkt der Aufgabenerstellung im Namespace Manager festgelegt war. Wenn Ihre Anwendung die Mehrinstanzenfähigkeit nutzt, finden Sie entsprechende Informationen unter Namespaces Go 1.9 API.

Weitere Informationen