Spring Boot-Anwendung in der App Engine-Standardumgebung bereitstellen

1. Hinweis

App Engine-Anwendungen lassen sich einfach erstellen, verwalten und skalieren, wenn sich Traffic und Datenspeicheranforderungen ändern. Und bei App Engine müssen keine Server verwaltet werden. Sie laden einfach Ihre App hoch und es kann losgehen.

App Engine-Anwendungen werden auf der Grundlage des eingehenden Traffics automatisch skaliert. Load-Balancing, Mikrodienste, Autorisierung, SQL- und NoSQL-Datenbanken, Memory-Caching, Traffic-Aufteilung, Logging, Suche, Versionsverwaltung, Rollouts und Rollbacks sowie Sicherheitsscans werden nativ unterstützt und können individuell angepasst werden.

Die App Engine-Standardumgebung und die flexible App Engine-Umgebung unterstützen eine Vielzahl von Programmiersprachen, darunter Java, Python, PHP, NodeJS und Go. Die beiden Umgebungen bieten Entwicklern maximale Flexibilität bei der Funktionsweise ihrer App. Jede Umgebung hat bestimmte Stärken. Weitere Informationen finden Sie unter App Engine-Umgebung auswählen.

Sie erfahren, wie Sie eine Spring Boot-Anwendung in der App Engine-Standardumgebung bereitstellen. Die Standardumgebung wird auf null Instanzen herunter- und automatisch wieder hochskaliert, wenn sie nicht verwendet wird.

Voraussetzungen

• Kenntnisse der Programmiersprache Java und der entsprechenden Tools
• Kenntnisse von standardmäßigen Linux-Texteditoren wie Vim, Emacs und Nano

Aufgaben

• Spring Boot-Java-Anwendung in App Engine erstellen

Voraussetzungen

• Ein Google Cloud-Projekt
• Ein Browser, z. B. Google Chrome

2. Einrichtung und Anforderungen

Umgebung zum selbstbestimmten Lernen einrichten

1. Melden Sie sich in der Google Cloud Console an und erstellen Sie ein neues Projekt oder verwenden Sie ein vorhandenes Projekt. Wenn Sie noch kein Gmail- oder Google Workspace-Konto haben, müssen Sie eines erstellen.

• Der Projektname ist der Anzeigename für die Teilnehmer dieses Projekts. Es handelt sich um einen String, der nicht von Google APIs verwendet wird. Sie können sie jederzeit aktualisieren.
• Die Projekt-ID ist für alle Google Cloud-Projekte eindeutig und unveränderlich (kann nach dem Festlegen nicht mehr geändert werden). In der Cloud Console wird automatisch ein eindeutiger String generiert. Normalerweise ist es nicht wichtig, wie dieser String aussieht. In den meisten Codelabs müssen Sie auf Ihre Projekt-ID verweisen (in der Regel als PROJECT_ID angegeben). Wenn Ihnen die generierte ID nicht gefällt, können Sie eine andere zufällige ID generieren. Alternativ können Sie es mit einem eigenen Namen versuchen und sehen, ob er verfügbar ist. Sie kann nach diesem Schritt nicht mehr geändert werden und bleibt für die Dauer des Projekts bestehen.
• Zur Information: Es gibt einen dritten Wert, die Projektnummer, die von einigen APIs verwendet wird. Weitere Informationen zu diesen drei Werten

Achtung:Eine Projekt-ID ist global eindeutig und kann nach der Auswahl nicht mehr von anderen verwendet werden. Sie sind der einzige Nutzer dieser ID. Auch wenn ein Projekt gelöscht wird, kann die ID nicht wiederverwendet werden.

Hinweis:Wenn Sie ein Gmail-Konto verwenden, können Sie den Standardspeicherort auf Keine Organisation belassen. Wenn Sie ein Google Workspace-Konto verwenden, wählen Sie einen Standort aus, der für Ihre Organisation sinnvoll ist.

2. Als Nächstes müssen Sie die Abrechnung in der Cloud Console aktivieren, um Cloud-Ressourcen/-APIs zu verwenden. Die Durchführung dieses Codelabs kostet wenig oder gar nichts. Wenn Sie Ressourcen herunterfahren möchten, um Kosten zu vermeiden, die über diese Anleitung hinausgehen, können Sie die erstellten Ressourcen oder das Projekt löschen. Neue Google Cloud-Nutzer können am kostenlosen Testzeitraum mit einem Guthaben von 300$ teilnehmen.

Cloud Shell

Sie verwenden Cloud Shell, eine Befehlszeilenumgebung, die in Google Cloud ausgeführt wird.

Cloud Shell aktivieren

1. Klicken Sie in der Cloud Console auf Cloud Shell aktivieren .

Wenn Sie die Cloud Shell zum ersten Mal starten, wird ein Fenster mit einer Beschreibung eingeblendet. Klicken Sie in diesem Fall einfach auf Weiter.

Das Herstellen der Verbindung mit der Cloud Shell sollte nur wenige Augenblicke dauern.

Auf dieser virtuellen Maschine sind alle erforderlichen Entwicklungstools installiert. Sie bietet ein Basisverzeichnis mit 5 GB nichtflüchtigem Speicher und läuft in Google Cloud, was die Netzwerkleistung und Authentifizierung erheblich verbessert. Die meisten, wenn nicht sogar alle Aufgaben in diesem Codelab können mit einem Browser erledigt werden.

Sobald die Verbindung mit der Cloud Shell hergestellt ist, sehen Sie, dass Sie authentifiziert sind und für das Projekt Ihre Projekt-ID eingestellt ist.

2. Führen Sie in der Cloud Shell den folgenden Befehl aus, um zu prüfen, ob Sie authentifiziert sind:

gcloud auth list

Befehlsausgabe

 Credentialed Accounts
ACTIVE  ACCOUNT
*       <my_account>@<my_domain.com>

To set the active account, run:
    $ gcloud config set account `ACCOUNT`

Hinweis:Das gcloud-Befehlszeilentool ist ein leistungsstarkes und vereinheitlichtes Befehlszeilentool in Google Cloud. Das Tool ist in der Cloud Shell vorinstalliert. Sie werden feststellen, dass die Tab-Vervollständigung unterstützt wird. Weitere Informationen finden Sie in der Übersicht über das gcloud-Befehlszeilentool.

3. Führen Sie den folgenden Befehl in Cloud Shell aus, um zu bestätigen, dass der gcloud-Befehl Ihr Projekt kennt:

gcloud config list project

Befehlsausgabe

[core]
project = <PROJECT_ID>

Ist dies nicht der Fall, können Sie die Einstellung mit diesem Befehl vornehmen:

gcloud config set project <PROJECT_ID>

Befehlsausgabe

Updated property [core/project].

Hinweis:Wenn Sie diese Anleitung außerhalb von Cloud Shell ausführen, folgen Sie der Anleitung unter Standardanmeldedaten für Anwendungen einrichten.

3. Neue Spring Boot-Webanwendung erstellen

Nachdem Cloud Shell gestartet wurde, können Sie über die Befehlszeile mit Spring Initializr eine neue Spring Boot-Anwendung generieren.

$ curl https://start.spring.io/starter.tgz \
  -d bootVersion=3.0.5 \
  -d dependencies=web \
  -d type=maven-project \
  -d baseDir=gae-standard-example | tar -xzvf -
$ cd gae-standard-example

4. Maven-Datei pom.xml aktualisieren

Es gibt zwei Möglichkeiten, eine Java-Serveranwendung bereitzustellen: entweder mit dem Maven App Engine-Plug-in oder dem Gradle App Engine-Plug-in oder durch Bereitstellen des Paketverzeichnisses war. Sie verwenden das Maven App Engine-Plug-in, um die App bereitzustellen.

Maven App Engine Plugin hinzufügen

Aktualisieren Sie pom.xml, um ein Google Cloud-Plug‑in einzufügen, das den Bereitstellungsprozess vereinfacht. Sie können die Datei mit Vim, Nano oder Emacs bearbeiten.

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" ...>
  ...
  <build>
    <plugins>
      ...
      <plugin>
        <groupId>com.google.cloud.tools</groupId>
        <artifactId>appengine-maven-plugin</artifactId>
        <version>2.4.4</version>
        <configuration>
          <version>1</version>
          <projectId>GCLOUD_CONFIG</projectId>
        </configuration>
      </plugin>
      ...
    </plugins>
  </build>
</project>

5. App Engine-Deskriptor hinzufügen

1. Wenn Sie die App in der App Engine-Standardumgebung bereitstellen möchten, müssen Sie eine neue src/main/appengine/app.yaml-Deskriptordatei erstellen.

$ mkdir -p src/main/appengine/
$ touch src/main/appengine/app.yaml

2. Bearbeiten Sie die Datei src/main/appengine/app.yaml und fügen Sie den folgenden Inhalt hinzu:

src/main/appengine/app.yaml

runtime: java17
instance_class: F1

Hinweis: Mit verschiedenen Instanzklassen können Sie unterschiedliche Speichermengen verwenden. Die F1-Instanzklasse ist die kleinste Instanz. Für eine Produktionsanwendung sollten Sie eine größere Instanz verwenden, um Ihre Arbeitslast zu bewältigen. Weitere Informationen finden Sie unter app.yaml-Konfigurationsdatei.

6. Controller hinzufügen

Fügen Sie einen neuen Controller hinzu, der "hello world!" in DemoApplication.java zurückgibt.

src/main/java/com/example/demo/DemoApplication.java

package com.example.demo;

...

// Add imports
import org.springframework.web.bind.annotation.*;

@SpringBootApplication
public class DemoApplication {
  public static void main(String[] args) {
    SpringApplication.run(DemoApplication.class, args);
  }
}

// Add the controller.
@RestController
class HelloWorldController {
  @GetMapping("/")
  public String hello() {
    return "hello world!";
  }
}

7. App lokal ausführen

1. Prüfen Sie, ob JAVA_HOME auf die richtige JDK-Version festgelegt ist:

$ export JAVA_HOME=/usr/lib/jvm/java-17-openjdk-amd64/

2. Sie können die Spring Boot-App mit dem Spring Boot-Plug-in starten:

$ ./mvnw -DskipTests spring-boot:run

3. Klicken Sie nach dem Start der App in der Cloud Shell-Symbolleiste auf Webvorschau und wählen Sie Vorschau auf Port 8080 aus.

Im Browser wird ein Tab geöffnet und eine Verbindung zum gestarteten Server hergestellt.

8. Die Anwendung in App Engine bereitstellen

1. Initialisieren Sie zuerst das Projekt, damit App Engine-Apps ausgeführt werden können. Initialisieren Sie das Projekt außerdem für die Ausführung in der zentralen Region der USA.

$ gcloud app create --region us-central
You are creating an app for project [...].
WARNING: Creating an App Engine application for a project is irreversible and the region
cannot be changed. More information about regions is at
https://cloud.google.com/appengine/docs/locations

Hinweis:Alternativ können Sie mit gcloud app regions list alle verfügbaren Regionen auflisten und eine auswählen.

2. Stellen Sie dann Ihre App in der App Engine-Standardumgebung bereit, indem Sie mvn appengine:deploy ausführen.

$ ./mvnw -DskipTests package appengine:deploy
... first time deploy may take a couple of minutes

Hinweis:Die erste Bereitstellung kann einige Minuten dauern. Im Hintergrund werden die Laufzeitumgebung, das Netzwerk und die Load Balancer bereitgestellt und die App wird gestartet.

3. Nachdem die App bereitgestellt wurde, können Sie sie über die URL http://<project-id>.appspot.com in Ihrem Webbrowser aufrufen oder den folgenden Befehl in Cloud Shell verwenden:

$ gcloud app browse
... [It may print out the URL for your app]

Hinweis:Optional können Sie einen Top-Level-Domainnamen für Ihre App erwerben und verwenden oder einen verwenden, den Sie bereits registriert haben.

9. Bereinigen

Sie können eine App Engine-Anwendung nicht löschen, aber Sie können sie deaktivieren.

Rufen Sie in der Google Cloud Console App Engine und Settings auf und wählen Sie Disable Application aus:

Alternativ können Sie das gesamte Projekt löschen:

$ gcloud projects delete YOUR-PROJECT-ID

10. Glückwunsch

Sie haben Ihre erste App Engine-Webanwendung geschrieben.

Weitere Informationen

• Java in Google Cloud
• App Engine
• Java-Codebeispiele