App Engine-Gradle-Plug-in – Aufgaben und Attribute

Nachdem das App Engine-Gradle-Plug-in Ihrem Projekt hinzugefügt wurde, können Sie die folgenden App Engine-spezifischen Gradle-Aufgaben in Ihrer Java 8-Anwendung verwenden:
Aufgabe Beschreibung
tasks Zeigt Hilfeinformationen zu installierten Aufgaben an.
appengineStage Erzeugt ein Anwendungsverzeichnis für die Bereitstellung.
appengineDeploy Stellt eine Anwendung in App Engine bereit.
appengineDeployCron Stellt eine cron.yaml-Konfigurationsdatei in App Engine bereit.
appengineDeployDispatch Stellt eine dispatch.yaml-Konfigurationsdatei in App Engine bereit.
appengineDeployDos Stellt eine dos.yaml-Konfigurationsdatei in App Engine bereit.
appengineDeployIndex Stellt eine index.yaml-Konfigurationsdatei in App Engine bereit.
appengineDeployQueue Stellt eine queue.yaml-Konfigurationsdatei in App Engine bereit.
jettyRun Führt den Entwicklungsserver mit den Standardkonfigurationen von Jetty aus. Weitere Informationen zum Gretty-Plug-in finden Sie unter Gretty-Konfiguration und Gretty-Aufgaben.

So zeigen Sie eine Liste aller Aufgaben an:

gradle tasks

Weitere Informationen zum Einrichten und Verwenden von Gradle finden Sie auf GitHub unter App Engine Gradle verwenden und Repository app-gradle-plugin.

Aufgabenattribute

Der Inhalt der gradle.build-Datei ist ein Satz von Regeln zur Beschreibung Ihres Builds. Sie ist in einer domainspezifischen Sprache geschrieben, die auf der Sprache Groovy beruht.

Jeder Aufgabe sind Attribute zugeordnet (siehe unten), die verwendet werden können. Diese können Sie in der Datei gradle.build mit einem Konfigurationsabschluss, einer Aufgabe und Attributen angeben.

Das folgende Beispiel zeigt, wie Gradle-Aufgaben für Java 8 angegeben werden. Weitere Informationen zur Verwendung neuerer Versionen für Java Version 11 und höher finden Sie unter Java-Laufzeit.

In diesem Fall gilt Folgendes:

  • Der Konfigurationsabschluss für das Plug-in lautet appengine.
  • Die Aufgabe ist deploy.
  • Die Attribute stopPreviousVersion und promote sind auf true gesetzt.
appengine {
  deploy {   // deploy configuration
    stopPreviousVersion = true  // default - stop the current version
    promote = true              // default - & make this the current version
  }
}
Wenn Sie nur einige Attribute angeben möchten, können Sie sie in einer einzelnen Zeile festlegen:

  appengine.deploy.stopPreviousVersion = true

In den folgenden Abschnitten finden Sie eine Liste der Attribute, die für jede Aufgabe verfügbar sind.

appengineStage

task(stage)

Erzeugt ein Anwendungsverzeichnis für die Bereitstellung. Wird von den Aufgaben appengineDeploy und jettyRun verwendet.

Sie können folgende Attribute verwenden:

Attribut Beschreibung
artifact Erstelltes Artefakt mit allen Klassen, Ressourcen und Manifesten. Standardwert ist build/libs/[YOUR_SERVLET].war.
appEngineDirectory Speicherort der app.yaml-Datei. Der Standardwert ist src/main/appengine.
dockerDirectory Speicherort von Dockerfile. Der Standardwert ist src/main/docker.
stagingDirectory Erforderlich. Das Verzeichnis für das Staging der Anwendung. Standardwert ist build/staged-app.

appengineDeploy

task(deploy)

Löst Staging und Bereitstellung einer Anwendung in App Engine aus.

Jeder Aufgabe sind Attribute zugeordnet (siehe unten), die verwendet werden können. Diese können Sie in der Datei gradle.build mit einem Konfigurationsabschluss, einer Aufgabe und Attributen angeben.

Im folgenden Beispiel gilt:

  • Der Konfigurationsabschluss für das Plug-in lautet appengine.
  • Die Aufgabe ist run.
  • Das Attribut port ist auf 8080 gesetzt.
appengine {  // App Engine tasks configuration
  run {      // local (dev_appserver) configuration (standard environments only)
    port = 8080                 // default
  }

  deploy {   // deploy configuration
    stopPreviousVersion = true  // default - stop the current version
    promote = true              // default - & make this the current version
  }
}

Wenn Sie nur einige Attribute angeben möchten, können Sie sie in einer einzelnen Zeile festlegen:

  appengine.run.port = 8888
Attribut Beschreibung
appEngineDirectory Speicherort der .yaml-Konfigurationsdateien (cron, index usw.), über die konfigurationsspezifische Bereitstellungen (appengineDeployCron usw.) durchgeführt werden. Bei flexiblen Anwendungen lautet der Standardwert src/main/appengine.
bucket Der Cloud Storage-Bucket, der für das Staging von Dateien verwendet wird, die der Bereitstellung zugeordnet sind. Wenn dieses Argument nicht angegeben ist, wird der Standard-Bucket der Anwendung verwendet.
deployables Die YAML-Dateien für die Dienste oder Konfigurationen, die Sie bereitstellen möchten. Der Standardwert ist die app.yaml-Datei im Staging-Verzeichnis. Wenn sie nicht gefunden wird, wird versucht, erforderliche Konfigurationsdateien wie app.yaml automatisch im Staging-Verzeichnis zu erzeugen.
imageUrl Bereitstellen mit einem bestimmten Docker-Image. Die Docker-URL muss aus einem der gültigen Artifact Registry-Hostnamen sein.
project Der Google Cloud Platform-Projektname für diesen Aufruf. Die Standardeinstellung ist das aktuelle Projekt, das beim Initialisieren von gcloud ausgewählt wurde. Verwenden Sie zur Bestätigung gcloud config list project.
promote Bereitgestellte Version für den gesamten Traffic hochstufen. Der Standardwert ist „True“.
server Der App Engine-Server, mit dem eine Verbindung hergestellt werden soll. Dieser Wert muss in der Regel nicht geändert werden.
stopPreviousVersion Beendet die zuvor ausgeführte Version, wenn eine neue Version bereitgestellt wird, die den gesamten Traffic empfängt.
version Die Version der Anwendung, die durch diese Bereitstellung erstellt oder ersetzt wird. Wenn Sie keine Version angeben, wird automatisch eine erzeugt.

Globale Attribute

AttributBeschreibung
tools.cloudSdkHome Optionales Attribut zum Konfigurieren des Speicherorts der Google Cloud CLI. In der Regel findet das Plug-in dieses in der gcloud CLI, wenn es mit gcloud components install app-engine-java installiert wird.