Tutorial: Erstellen einer Java Spring Boot-Web-App mit Azure App Service für Linux und Azure Cosmos DB

  • Artikel

In diesem Tutorial erfahren Sie, wie Sie eine sichere Spring Boot-Anwendung in Azure App Service erstellen, konfigurieren und bereitstellen, die eine Verbindung mit einer MongoDB-Datenbank in Azure herstellt (eigentlich eine Cosmos DB-Datenbank mit MongoDB-API). Wenn Sie fertig sind, verfügen Sie über eine Java SE-Anwendung, die in Azure App Service für Linux ausgeführt wird.

Screenshot: Spring Boot-Anwendung, die Daten in Cosmos DB speichert

In diesem Tutorial lernen Sie Folgendes:

  • Erstellen Sie eine Azure Cosmos DB-Datenbank.
  • Herstellen einer Verbindung zwischen einer Beispiel-App und der Datenbank und das lokale Testen
  • Bereitstellen der Beispiel-App in Azure
  • Streamen von Diagnoseprotokollen aus App Service
  • Hinzufügen zusätzlicher Instanzen zum Aufskalieren der Beispiel-App

Um dieses Tutorial abzuschließen, benötigen Sie Folgendes:

  • Ein Azure-Konto mit einem aktiven Abonnement. Falls Sie kein Azure-Konto besitzen, können Sie kostenlos eines erstellen.
  • Eine installierte Azure Developer CLI. Sie können die Schritte mit der Azure Cloud Shell ausführen, da Azure Developer CLI dort bereits installiert ist.
  • Kenntnisse über Java mit Spring Framework-Entwicklung
  • (Optional) Ein GitHub Copilot-Konto, um GitHub Copilot zu testen. Es ist eine kostenlose 30-Tage-Testversion verfügbar.

Zum Ende springen

Sie können die Beispiel-App in diesem Tutorial schnell bereitstellen und in Azure anzeigen. Führen Sie einfach die folgenden Befehle in Azure Cloud Shell aus, und befolgen Sie die Eingabeaufforderung:

mkdir msdocs-spring-boot-mongodb-sample-app
cd msdocs-spring-boot-mongodb-sample-app
azd init --template msdocs-spring-boot-mongodb-sample-app
azd up

1. Ausführen des Beispiels

Zunächst richten Sie eine datengesteuerte Beispiel-App als Ausgangspunkt ein. Das Beispielrepository umfasst der Einfachheit halber eine Entwicklercontainerkonfiguration. Der Entwicklercontainer verfügt über alles, was Sie zum Entwickeln einer Anwendung benötigen, einschließlich der MongoDB-Datenbank, des Cache und aller Umgebungsvariablen, die von der Beispielanwendung benötigt werden. Der Entwicklercontainer kann in einem GitHub-Codespace ausgeführt werden, was bedeutet, dass Sie das Beispiel auf jedem Computer mit einem Webbrowser ausführen können.

Schritt 1: In einem neuen Browserfenster:

  1. Melden Sie sich bei Ihrem GitHub-Konto an.
  2. Navigieren Sie zu https://github.com/Azure-Samples/msdocs-spring-boot-mongodb-sample-app/fork.
  3. Deaktivieren Sie die Option Nur Mainbranch kopieren. Sie benötigen alle Branches.
  4. Wählen Sie Fork erstellen aus.

Screenshot: wie eine Verzweigung des Beispiel-GitHub-Repositorys erstellt wird.

Schritt 2: Im GitHub-Fork:

  1. Wählen Sie für den Startbranch main>starter-no-infra aus. Dieser Branch enthält nur das Beispielprojekt und keine Azure-bezogenen Dateien oder Konfigurationen.
  2. Wählen Sie Code>Codespace in starter-no-infra erstellen aus. Das Einrichten des Codespace dauert einige Minuten.

Screenshot: Erstellen eines Codespace in GitHub

Schritt 3: Im Codespace-Terminal:

  1. Führen Sie mvn package spring-boot:run aus.
  2. Wenn die Benachrichtigung Your application running on port 8080 is available. angezeigt wird, wählen Sie Im Browser öffnen aus. Die Beispielanwendung sollte auf einer neuen Browserregisterkarte angezeigt werden. Geben Sie Ctrl+Cein, um den Jetty-Server zu beenden.

Screenshot: Ausführen der Beispielanwendung im GitHub-Codespace

Tipp

Sie können GitHub Copilot über dieses Repository befragen. Zum Beispiel:

  • @workspace Was macht dieses Projekt?
  • @workspace Wie stellt die App eine Verbindung mit der Datenbank her?
  • @workspace Wofür dient der Ordner „.devcontainer“?

Treten Probleme auf? Sehen Sie sich den Abschnitt zur Problembehandlung an.

2. Erstellen von Instanzen für App Service und Cosmos DB

Zuerst erstellen Sie die Azure-Ressourcen. Die in diesem Tutorial ausgeführten Schritte erstellen eine Reihe standardmäßig sicherer Ressourcen, die App Service und Azure Cosmos DB enthalten. Für den Erstellungsprozess geben Sie Folgendes an:

  • Den Namen für die Web-App. Er wird als Teil des DNS-Namens für Ihre App in Form von https://<app-name>-<hash>.<region>.azurewebsites.net verwendet.
  • Die Region für die physische Ausführung der App in der Welt Sie wird auch als Teil des DNS-Namens für Ihre App verwendet.
  • Der Runtimestapel für die App. Hier wählen Sie die Version von Java aus, die für Ihre App verwendet werden soll.
  • Der Hostingplan für die App. Dies ist der Tarif, der die Features und Skalierungskapazität für Ihre App enthält.
  • Die Ressourcengruppe für die App. Mit einer Ressourcengruppe können Sie (in einem logischen Container) alle für die Anwendung benötigten Azure-Ressourcen gruppieren.

Melden Sie sich beim Azure-Portal an, und führen Sie die folgenden Schritte aus, um Ihre Azure App Service-Ressourcen zu erstellen.

Schritt 1: Im Azure-Portal:

  1. Geben Sie auf der Suchleiste oben im Azure-Portal „Web App Datenbank“ ein.
  2. Wählen Sie das Element mit der Bezeichnung Web-App + Datenbank unter der Überschrift Marketplace aus. Sie können auch direkt zum Erstellungs-Assistenten navigieren.

Screenshot: Verwenden des Suchfelds auf der oberen Symbolleiste, um den Erstellungs-Assistenten „Web-App + Datenbank“ zu finden.

Schritt 2: Füllen Sie das Formular auf der Seite Web-App und Datenbank erstellen wie folgt aus.

  1. Ressourcengruppe: Wählen sie die Option Neu erstellen aus, und verwenden Sie einen Namen wie msdocs-spring-cosmosdb-tutorial.
  2. Region: Eine beliebige Azure-Region in Ihrer Nähe.
  3. Name: msdocs-spring-cosmosdb-XYZ, wobei XYZ für drei beliebige Zeichen steht. Dieser Name muss innerhalb von Azure eindeutig sein.
  4. Laufzeitstapel: Java 21.
  5. Java-Webserverstapel: Java SE (Eingebetteter Webserver).
  6. Engine: Cosmos DB-API für MongoDB. Cosmos DB ist eine vollständig verwaltete NoSQL-basierte, relationale und vektorbasierte Datenbank als Database-as-a-Service-Lösung.
  7. Hostingplan: Basic. Wenn Sie bereit sind, können Sie später auf einen Produktionstarif hochskalieren.
  8. Klicken Sie auf Überprüfen + erstellen.
  9. Wenn die Überprüfung abgeschlossen ist, wählen Sie Erstellen aus.

Screenshot: wie eine neue App und Datenbank im „Web-App + Datenbank“-Assistenten konfiguriert wird.

Schritt 3: Die Durchführung der Bereitstellung dauert einige Minuten. Wählen Sie nach Abschluss der Bereitstellung die Schaltfläche Zu Ressource wechseln aus. Sie werden direkt zur App Service App weitergeleitet, aber die folgenden Ressourcen werden erstellt:

  • Ressourcengruppe: Der Container für alle erstellten Ressourcen.
  • App Service-Plan: Definiert die Berechnungsressourcen für App Service. Ein Linux-Plan im Basic-Tarif wird erstellt.
  • App Service: Stellt Ihre App dar und wird im App Service Plan ausgeführt.
  • Virtuelles Netzwerk: Integriert in die App Service-App und isoliert den Back-End-Netzwerkdatenverkehr.
  • Azure Cosmos DB: Nur von hinter seinem privaten Endpunkt aus zugänglich. Eine Datenbank wird für Sie im Datenbankkonto erstellt.
  • Private DNS-Zonen: Aktivieren der DNS-Auflösung des Datenbankservers und des Redis-Cache im virtuellen Netzwerk.

Screenshot: Abgeschlossener Bereitstellungsprozess

Treten Probleme auf? Sehen Sie sich den Abschnitt zur Problembehandlung an.

3. Schützen von Verbindungsgeheimnissen

Der Erstellungs-Assistent hat die Verbindungszeichenfolge für Sie bereits als App-Einstellungen generiert. In diesem Schritt erfahren Sie jedoch, wo Sie die App-Einstellungen finden und wie Sie eigene erstellen können.

App-Einstellungen sind eine Möglichkeit, um Verbindungsgeheimnisse aus Ihrem Coderepository herauszuhalten. Wenn Sie bereit sind, Ihre Geheimschlüssel an einen sichereren Ort zu verschieben, können Sie stattdessen Key Vault-Verweise verwenden.

Schritt 1: Auf der App Service-Seite:

  1. Wählen Sie im linken Menü Einstellungen > Umgebungsvariablen aus.
  2. Wählen Sie neben AZURE_COSMOS_CONNECTIONSTRING die Option Wert anzeigen aus. Mit dieser Verbindungszeichenfolge können Sie eine Verbindung mit der Cosmos DB-Datenbank herstellen, die hinter einem privaten Endpunkt geschützt wird. Das Geheimnis wird jedoch direkt in der App Service-App gespeichert, was nicht optimal ist. Sie ändern dieses Verhalten.

Screenshot: Wert einer App-Einstellung

Schritt 2: Erstellen eines Schlüsseltresors für die sichere Verwaltung von Geheimnissen

  1. Geben Sie in der oberen Suchleiste key vault ein, und wählen Sie dann Marketplace>Key Vault aus.
  2. Wählen Sie unter Ressourcengruppe die Option msdocs-spring-cosmosdb-tutorial aus.
  3. Geben Sie unter Schlüsseltresornamen einen Namen ein, der nur aus Buchstaben und Zahlen besteht.
  4. Legen Sie den Wert für Region auf den Beispielstandort der Ressourcengruppe fest.

Screenshot: Erstellen eines Schlüsseltresors

Schritt 3:

  1. Wählen Sie die Registerkarte Netzwerk aus.
  2. Deaktivieren SieÖffentlichen Zugriff aktivieren.
  3. Wählen sie Privaten Endpunkt erstellen aus.
  4. Wählen Sie unter Ressourcengruppe die Option msdocs-spring-cosmosdb-tutorial aus.
  5. Geben Sie unter Schlüsseltresornamen einen Namen ein, der nur aus Buchstaben und Zahlen besteht.
  6. Legen Sie den Wert für Region auf den Beispielstandort der Ressourcengruppe fest.
  7. Wählen Sie im Dialogfeld unter Standort denselben Standort wie für Ihre App Service-App aus.
  8. Wählen Sie unter Ressourcengruppe die Option msdocs-spring-cosmosdb-tutorial aus.
  9. Geben Sie unter Name den Namen msdocs-spring-cosmosdb-XYZVvaultEndpoint ein.
  10. Wählen Sie unter Virtuelles Netzwerk die Option msdocs-spring-cosmosdb-XYZVnet aus.
  11. Wählen Sie unter Subnetz die Option msdocs-spring-cosmosdb-XYZSubnet aus.
  12. Wählen Sie OK aus.
  13. Klicken Sie aufÜberprüfen + erstellen und dann auf Erstellen. Warten Sie, bis die Bereitstellung des Schlüsseltresors abgeschlossen ist. Die Meldung „Ihre Bereitstellung wurde abgeschlossen.“ sollte angezeigt werden.

Screenshot: Schützen eines Schlüsseltresors mit einem privaten Endpunkt

Schritt 4:

  1. Geben Sie in der oberen Suchleiste msdocs-spring-cosmosdb ein, und wählen Sie dann die App Service-Ressource msdocs-spring-cosmosdb-XYZ aus.
  2. Wählen Sie auf der App Service-Seite im linken Menü „Einstellungen“ >„Dienstconnector“ aus. Es gibt bereits einen Connector, den der App-Erstellungs-Assistent für Sie erstellt hat.
  3. Aktivieren Sie das Kontrollkästchen neben dem Connector, und wählen Sie dann Bearbeiten aus.
  4. Legen Sie auf der Registerkarte Grundlagen die Option Clienttyp auf SpringBoot fest. Mit dieser Option werden die spezifischen Spring Boot-Umgebungsvariablen für Sie erstellt.
  5. Wählen Sie die Registerkarte Authentifizierung aus.
  6. Wählen Sie „Geheimnis in Key Vault speichern“ aus.
  7. Wählen Sie unter Key Vault-Verbindung die Option Neu erstellen aus. Über dem Bearbeitungsdialogfeld wird das Dialogfeld Verbindung erstellen geöffnet.

Screenshot: Bearbeiten eines Dienstconnectors mit einer Key Vault-Verbindung

Schritt 5: Im Dialogfeld Verbindung erstellen für die Key Vault-Verbindung:

  1. Wählen Sie unter Schlüsseltresor den zuvor erstellten Schlüsseltresor aus.
  2. Klicken Sie auf Überprüfen + erstellen. Sie sehen, dass das Feld Systemseitig zugewiesene verwaltete Identität auf Ausgewählt festgelegt ist.
  3. Wählen Sie nach Abschluss der Überprüfung Erstellen aus.

Screenshot: Konfigurieren eines Dienstconnectors für den Schlüsseltresor

Schritt 6: Sie befinden sich wieder im Bearbeitungsdialogfeld für defaultConnector.

  1. Warten Sie auf der Registerkarte Authentifizierung, bis der Schlüsseltresorconnector erstellt wurde. Nach Abschluss des Vorgangs wird er automatisch in der Dropdownliste „Key Vault-Verbindung“ ausgewählt.
  2. Klicken Sie auf Weiter: Netzwerk.
  3. Wählen Sie Firewallregeln konfigurieren, um den Zugriff auf den Zieldienst zu aktivieren aus. Wenn die Meldung „Kein privater Endpunkt im Zieldienst“ angezeigt wird, ignorieren Sie diese. Der App-Erstellungs-Assistent hat die Cosmos DB-Datenbank bereits mit einem privaten Endpunkt geschützt.
  4. Wählen Sie Speichern. Warten Sie, bis die Benachrichtigung Update erfolgreich angezeigt wird.

Screenshot: Schlüsseltresorconnector, der in „defaultConnector“ ausgewählt ist

Schritt 7: So überprüfen Sie, ob Sie die Geheimnisse geschützt haben:

  1. Wählen Sie im linken Menü erneut Umgebungsvariablen aus.
  2. Stellen Sie sicher, dass die App-Einstellung spring.data.mongodb.uri vorhanden ist. Der Standardconnector hat sie für Sie generiert, und Ihre Spring Boot-Anwendung verwendet bereits die Variable.
  3. Wählen Sie neben der App-Einstellung Wert anzeigen aus. Der Wert sollte @Microsoft.KeyValut(...) lauten. Das bedeutet, dass es sich um einen Schlüsseltresorverweis handelt, da das Geheimnis jetzt im Schlüsseltresor verwaltet wird.

Screenshot: Anzeigen des Werts der Spring Boot-Umgebungsvariablen in Azure

Treten Probleme auf? Sehen Sie sich den Abschnitt zur Problembehandlung an.

5. Bereitstellen von Beispielcode

In diesem Schritt konfigurieren Sie die GitHub-Bereitstellung mithilfe von GitHub Actions. Es ist nur eine der vielen Möglichkeiten, um App Service bereitzustellen, aber auch eine hervorragende Möglichkeit, eine kontinuierliche Integration in Ihren Bereitstellungsprozess zu haben. Standardmäßig startet jede git push in Ihrem GitHub-Repository die Build- und Bereitstellungsaktion.

Wie bei Tomcat üblich, benennen Sie Ihr erstelltes Artefakt ROOT.war, wenn Sie es im Stammkontext von Tomcat bereitstellen möchten.

Schritt 1: Wählen Sie im linken Menü Bereitstellung> Bereitstellungscenter aus.

Screenshot: wie das Bereitstellungscenter in App Service geöffnet wird.

Schritt 2: Auf der Seite „Bereitstellungscenter“:

  1. Wählen Sie in Quelle die Option GitHub aus. Standardmäßig wird GitHub Actions als Buildanbieter ausgewählt.
  2. Melden Sie sich bei Ihrem GitHub-Konto an und folgen Sie der Aufforderung, Azure zu autorisieren.
  3. Wählen Sie in Organisation Ihr Konto aus.
  4. Wählen Sie unter Repository das Repository msdocs-spring-boot-mongodb-sample-app aus.
  5. Wählen Sie unter Branch den Eintrag starter-no-infra aus. Dies ist der gleiche Branch, in dem Sie mit Ihrer Beispiel-App gearbeitet haben, ohne Azure-bezogene Dateien oder Konfigurationen.
  6. Wählen Sie unter Authentifizierungstyp die Option Benutzerseitig zugewiesene Identität aus.
  7. Wählen Sie im oberen Menü Speichern aus. App Service committet eine Workflowdatei in das ausgewählte GitHub-Repository im .github/workflows-Verzeichnis. Standardmäßig erstellt das Bereitstellungscenter eine benutzerseitig zugewiesene Identität für den Workflow zur Authentifizierung mithilfe von Microsoft Entra (OIDC-Authentifizierung). Weitere Informationen zu alternativen Authentifizierungsoptionen finden Sie unter Bereitstellen in App Service mithilfe von GitHub Actions.

Screenshot: wie CI/CD mit GitHub Actions konfiguriert wird.

Schritt 3:

  1. Wählen Sie die Registerkarte Protokolle aus. Sie sehen, dass bereits eine neue Bereitstellung ausgeführt wurde, aber der Status lautet Fehlerhaft.
  2. Wählen Sie Build-/Bereitstellungsprotokolle aus. Auf der Registerkarte Aktionen Ihres geforkten Repositorys auf GitHub wird eine Browserregisterkarte geöffnet. Unter Anmerkungen wird der Fehler The string 'java21' is not valid SeVer notation for a Java version angezeigt. Wenn Sie möchten, wählen Sie den fehlerhaften Build-Schritt auf der Seite aus, um weitere Informationen zu erhalten.

Screenshot: Fehler auf der Seite „Protokolle“ des Bereitstellungscenters

Schritt 4: Der Fehler zeigt, dass im GitHub-Workflow ein Fehler aufgetreten ist. Um diesen zu beheben, pullen Sie zuerst die neuesten Änderungen in Ihren Codespace. Führen Sie zurück im GitHub-Codespace Ihres Beispiel-Forks git pull origin starter-no-infra aus. Dadurch wird die neu committete Workflowdatei in Ihren Codespace übertragen.

Screenshot: „git pull“ in einem GitHub-Codespace

Schritt 5 (Option 1: mit GitHub Copilot):

  1. Starten Sie eine neue Chatsitzung, indem Sie die Ansicht Chat und dann die Option + auswählen.
  2. Fragen Sie: @workspace Warum erhalte ich folgenden Fehler in GitHub Actions: Die Zeichenfolge 'java21' ist keine gültige SemVer-Notation für eine Java-Version. Copilot liefert möglicherweise eine Erklärung und sogar einen Link zu der Workflowdatei, die Sie korrigieren müssen.
  3. Öffnen Sie .github/workflows/starter-no-infra_msdocs-spring-cosmosdb-123.yaml im Explorer, und nehmen Sie die vorgeschlagene Korrektur vor. GitHub Copilot gibt Ihnen nicht jedes Mal die gleiche Antwort. Möglicherweise müssen Sie zusätzliche Fragen stellen, um die Antwort zu optimieren. Tipps finden Sie unter Was kann ich mit GitHub Copilot in meinem Codespace machen?.

Screenshot, der zeigt, wie Sie eine Frage in einer neuen GitHub Copilot-Chatsitzung stellen

Schritt 5 (Option 2: ohne GitHub Copilot):

  1. Öffnen Sie .github/workflows/starter-no-infra_msdocs-spring-cosmosdb-123.yaml im Explorer, und suchen Sie die Aktion setup-java@v4.
  2. Ändern Sie den Wert von java-version in '21'.

Screenshot: GitHub-Codespace und geöffnete automatisch generierte Workflowdatei

Schritt 6:

  1. Wählen Sie die Quellsteuerungserweiterung aus.
  2. Geben Sie im Textfeld eine Commitnachricht ein, z. B. Fix error in java-version. Oder wählen Sie aus, und lassen Sie GitHub Copilot eine Commit-Nachricht für Sie generieren.
  3. Wählen Sie Commit aus, und bestätigen Sie dann mit Ja.
  4. Wählen Sie Änderungen synchronisieren 1 aus, und bestätigen Sie dann mit OK.

Screenshot der Änderungen, die committet und an GitHub gepusht werden.

Schritt 7: Zurück auf der Seite „Bereitstellungscenter“ im Azure-Portal:

  1. Wählen Sie auf der Registerkarte Protokolle die Option Aktualisieren aus. Eine neue Bereitstellungsausführung wurde bereits durch Ihre committeten Änderungen gestartet.
  2. Wählen Sie in dem Protokollelement für die Bereitstellungsausführung den Eintrag Build/Deploy Logs mit dem neuesten Zeitstempel aus.

Screenshot: Erfolgreiche Bereitstellung auf der Seite „Protokolle“ des Bereitstellungscenters

Schritt 8: Sie werden zu Ihrem GitHub-Repository weitergeleitet und sehen, dass die GitHub-Aktion ausgeführt wird. Die Workflowdatei definiert zwei separate Phasen, Erstellen und Bereitstellen. Warten Sie, bis die GitHub-Ausführung den Status Abgeschlossen anzeigt.

Screenshot: Erfolgreiche GitHub-Ausführung

Treten Probleme auf? Sehen Sie sich den Abschnitt zur Problembehandlung an.

6. Navigieren zur App

Schritt 1: Auf der App Service-Seite:

  1. Wählen Sie im Menü auf der linken Seite die Option Übersicht aus.
  2. Wählen Sie die URL Ihrer App aus. Sie können auch direkt zu https://<app-name>.azurewebsites.net navigieren.

Screenshot: wie ein App Service vom Azure-Portal gestartet wird.

Schritt 2: Fügen Sie der Liste einige Aufgaben hinzu. Glückwunsch! Sie führen eine Web-App in Azure App Service mit sicherer Konnektivität zu Azure Cosmos DB aus.

Screenshot: Spring Boot-Web-App mit Cosmos DB, die in Azure ausgeführt wird

Treten Probleme auf? Sehen Sie sich den Abschnitt zur Problembehandlung an.

7. Streamen von Diagnoseprotokollen

Azure App Service erfasst alle Nachrichten, die in der Konsole ausgegeben werden, um Sie bei der Diagnose von Problemen mit Ihrer Anwendung zu unterstützen. Die Beispielanwendung enthält standardmäßige Log4j-Protokollierungsanweisungen, um diese Funktion wie im folgenden Codeschnipsel dargestellt zu veranschaulichen.

private static Logger logger = LoggerFactory.getLogger(TodoListController.class);

@Autowired
private TodoItemRepository todoItemRepository;

public TodoListController() {
}

/**
 * HTTP GET
 */
@GetMapping(path = "/api/todolist/{index}", produces = {MediaType.APPLICATION_JSON_VALUE})
public TodoItem getTodoItem(@PathVariable("index") String index) {
    logger.info("GET request access '/api/todolist/{}' path.", index);
    return todoItemRepository.findById(index).get();
}

Schritt 1: Auf der App Service-Seite:

  1. Wählen Sie im linken Menü App Service-Protokolle aus.
  2. Wählen Sie unter Anwendungsprotokollierung die Option Dateisystem aus.
  3. Wählen Sie im oberen Menü Speichern aus.

Screenshot: wie native Protokolle in App Service im Azure-Portal aktiviert werden.

Schritt 2: Wählen Sie im Menü auf der linken Seite die Option Protokollstream aus. Sie sehen die Protokolle für Ihre App, einschließlich Plattformprotokolle und Protokolle innerhalb des Containers.

Screenshot: wie der Protokollstream im Azure-Portal angezeigt wird.

Erfahren Sie mehr über die Protokollierung in Java-Apps in der Reihe unter Azure Monitor OpenTelemetry für .NET-, Node.js-, Python- und Java-Anwendungen aktivieren.

Treten Probleme auf? Sehen Sie sich den Abschnitt zur Problembehandlung an.

8. Bereinigen von Ressourcen

Wenn Sie fertig sind, können Sie alle Ressourcen aus Ihrem Azure-Abonnement löschen, indem Sie die Ressourcengruppe löschen.

Schritt 1: In der Suchleiste oben im Azure-Portal:

  1. Geben Sie den Ressourcengruppennamen ein.
  2. Wählen Sie die Ressourcengruppe aus.

Screenshot: Suchen nach einer Ressourcengruppe und Navigieren zu einer Ressourcengruppe im Azure-Portal

Schritt 2: Wählen Sie auf der Seite „Ressourcengruppe“ die Option Ressourcengruppe löschen aus.

Screenshot: Position der Schaltfläche **Ressourcengruppe löschen** im Azure-Portal.

Schritt 3:

  1. Geben Sie den Namen der Ressourcengruppe ein, um Ihre Löschung zu bestätigen.
  2. Klicken Sie auf Löschen.
  3. Bestätigen Sie erneut mit Löschen.

Screenshot: Bestätigungsdialogfeld für das Löschen einer Ressourcengruppe im Azure-Portal

2. Erstellen von Azure-Ressourcen und Bereitstellen einer Beispiel-App

In diesem Schritt erstellen Sie die Azure-Ressourcen und stellen eine Beispiel-App für App Service für Linux bereit. Die in diesem Tutorial ausgeführten Schritte erstellen eine Reihe standardmäßig sicherer Ressourcen, die App Service und Azure Cosmos DB enthalten.

Der Entwicklercontainer verfügt bereits über die Azure Developer CLI (AZD).

  1. Führen Sie im Repositorystamm azd init aus.

    azd init --template javase-app-service-cosmos-redis-infra

  2. Wenn Sie dazu aufgefordert werden, geben Sie die folgenden Antworten:

    Frage Antwort
    Das aktuelle Verzeichnis ist nicht leer. Möchten Sie ein Projekt hier in <Ihr Verzeichnis> initialisieren? Y
    Was möchten Sie mit diesen Dateien tun? Meine vorhandenen Dateien unverändert beibehalten
    Geben Sie einen neuen Umgebungsnamen ein. Geben Sie einen eindeutigen Namen ein. Die AZD-Vorlage verwendet diesen Namen als Teil des DNS-Namens Ihrer Web-App in Azure (<app-name>.azurewebsites.net). Alphanumerische Zeichen und Bindestriche sind zulässig.

  3. Melden Sie sich mithilfe des Befehls azd auth login bei Azure an, und folgen Sie der Eingabeaufforderung:

    azd auth login

  4. Führen Sie den azd up-Befehl aus, um die notwendigen Azure-Ressourcen zu erstellen und den App-Code bereitzustellen. Folgen Sie der Eingabeaufforderung, um das gewünschte Abonnement und den gewünschten Standort für die Azure-Ressourcen auszuwählen.

    azd up

    Die Ausführung des Befehls azd up dauert etwa 15 Minuten.(Der Großteil der Zeit fällt für den Redis-Cache an.) Außerdem wird Ihr Anwendungscode kompiliert und bereitgestellt. Sie ändern den Code jedoch später so, dass er mit App Service funktioniert. Während der Ausführung stellt der Befehl Nachrichten zum Bestimmungs- und Bereitstellungsprozess bereit, einschließlich eines Links zur Bereitstellung in Azure. Wenn er abgeschlossen ist, zeigt der Befehl auch einen Link zur Bereitstellungsanwendung an.

    Diese AZD-Vorlage enthält Dateien (azure.yaml und das Verzeichnis infra), die eine standardmäßig sichere Architektur mit den folgenden Azure-Ressourcen generieren:

    • Ressourcengruppe: Der Container für alle erstellten Ressourcen.
    • App Service-Plan: Definiert die Berechnungsressourcen für App Service. Ein Linux-Plan im B1-Tarif wird erstellt.
    • App Service: Stellt Ihre App dar und wird im App Service Plan ausgeführt.
    • Virtuelles Netzwerk: Integriert in die App Service-App und isoliert den Back-End-Netzwerkdatenverkehr.
    • Azure Cosmos DB-Konto mit MongoDB-API: Nur von hinter seinem privaten Endpunkt aus zugänglich. Eine Datenbank wird für Sie auf dem Server erstellt.
    • Azure Cache for Redis: Nur innerhalb des virtuellen Netzwerks zugänglich.
    • Schlüsseltresor: Nur von hinter seinem privaten Endpunkt aus zugänglich. Wird verwendet, um Geheimnisse für die App Service-App zu verwalten.
    • Private DNS-Zonen: Aktivieren Sie die DNS-Auflösung der Cosmos DB-Datenbank, des Redis-Cache und des Schlüsseltresors im virtuellen Netzwerk.
    • Log Analytics-Arbeitsbereich: Fungiert als Zielcontainer für Ihre App, um die Protokolle zu versenden. Dort können Sie auch die Protokolle abfragen.

Treten Probleme auf? Sehen Sie sich den Abschnitt zur Problembehandlung an.

3. Überprüfen von Verbindungszeichenfolgen

Die von Ihnen verwendete AZD-Vorlage hat die Konnektivitätsvariablen für Sie bereits als App-Einstellungen generiert und gibt sie der Einfachheit halber im Terminal für Sie aus. App-Einstellungen sind eine Möglichkeit, um Verbindungsgeheimnisse aus Ihrem Coderepository herauszuhalten.

  1. Suchen Sie in der AZD-Ausgabe die App-Einstellung spring.data.mongodb.uri. Nur die Einstellungsnamen werden angezeigt. Sie sehen in der AZD-Ausgabe wie folgt aus:

     App Service app has the following app settings:
         - spring.data.mongodb.uri
         - spring.data.mongodb.database
         - spring.redis.host
         - spring.redis.port
         - spring.redis.password
         - spring.redis.database
         - spring.redis.ssl
         - spring.cloud.azure.keyvault.secret.credential.managed_identity_enabled
         - spring.cloud.azure.keyvault.secret.endpoint
         - azure.keyvault.uri
         - azure.keyvault.scope

    spring.data.mongodb.uri enthält den Verbindungs-URI für die Cosmos DB-Datenbank in Azure. Es handelt sich um eine Spring Data-Standardvariable, die Ihre Anwendung bereits in der Datei src/main/resources/application.properties verwendet.

  2. Navigieren Sie im Explorer zu src/main/resources/application.properties. Sie sehen, dass Ihre Spring Boot-App bereits die Variable spring.data.mongodb.uri für den Zugriff auf Daten verwendet.

  3. Der Einfachheit halber enthält die AZD-Vorlagenausgabe den direkten Link zur Seite „App-Einstellungen“ der App. Suchen Sie den Link, und öffnen Sie ihn auf einer neuen Browserregisterkarte.

    Der Wert spring.data.mongodb.uri sollte @Microsoft.KeyValut(...) lauten. Das bedeutet, dass es sich um einen Schlüsseltresorverweis handelt, da das Geheimnis im Schlüsseltresor verwaltet wird.

Treten Probleme auf? Sehen Sie sich den Abschnitt zur Problembehandlung an.

5. Navigieren zur App

  1. Suchen Sie in der AZD-Ausgabe die URL für Ihre App, und navigieren Sie im Browser dorthin. Die URL sieht in der AZD-Ausgabe wie folgt aus:

     Deploying services (azd deploy)

   (✓) Done: Deploying service web
   - Endpoint: https://<app-name>.azurewebsites.net/

  2. Fügen Sie der Liste einige Aufgaben hinzu.

    Ein Screenshot der Tomcat Web-App mit MySQL, die in Azure ausgeführt wird, zeigt die Aufgaben.

    Glückwunsch! Sie führen eine Web-App in Azure App Service mit sicherer Konnektivität zu Azure Cosmos DB aus.

Treten Probleme auf? Sehen Sie sich den Abschnitt zur Problembehandlung an.

6. Streamen von Diagnoseprotokollen

Azure App Service kann Konsolenprotokolle erfassen, um Sie bei der Diagnose von Problemen mit Ihrer Anwendung zu unterstützen. Der Einfachheit halber sind für die AZD-Vorlage bereits die Protokollierung im lokalen Dateisystem sowie das Senden der Protokolle an einen Log Analytics-Arbeitsbereich aktiviert.

Die Beispielanwendung enthält standardmäßige Log4j-Protokollierungsanweisungen, um diese Funktion wie im folgenden Codeschnipsel dargestellt zu veranschaulichen.

private static Logger logger = LoggerFactory.getLogger(TodoListController.class);

@Autowired
private TodoItemRepository todoItemRepository;

public TodoListController() {
}

/**
 * HTTP GET
 */
@GetMapping(path = "/api/todolist/{index}", produces = {MediaType.APPLICATION_JSON_VALUE})
public TodoItem getTodoItem(@PathVariable("index") String index) {
    logger.info("GET request access '/api/todolist/{}' path.", index);
    return todoItemRepository.findById(index).get();
}

Suchen Sie in der AZD-Ausgabe den Link zum Streamen von App Service-Protokollen, und navigieren Sie im Browser dorthin. Der Link sieht in der AZD-Ausgabe wie folgt aus:

Stream App Service logs at: https://portal.azure.com/#@/resource/subscriptions/<subscription-guid>/resourceGroups/<group-name>/providers/Microsoft.Web/sites/<app-name>/logStream

Erfahren Sie mehr über die Protokollierung in Java-Apps in der Reihe unter Azure Monitor OpenTelemetry für .NET-, Node.js-, Python- und Java-Anwendungen aktivieren.

Treten Probleme auf? Sehen Sie sich den Abschnitt zur Problembehandlung an.

7. Bereinigen von Ressourcen

Führen Sie azd down aus, und folgen Sie den Eingabeaufforderungen, um alle Azure-Ressourcen in der aktuellen Bereitstellungsumgebung zu löschen.

azd down

Problembehandlung

Die Portalbereitstellungsansicht für Azure Cosmos DB zeigt einen Konfliktstatus an.

Je nach ausgewähltem Abonnement und ausgewählter Region wird möglicherweise der Bereitstellungsstatus für Azure Cosmos DB als Conflict mit der folgenden Meldung in den Vorgangsdetails angezeigt:

Sorry, we are currently experiencing high demand in <region> region, and cannot fulfill your request at this time.

Der Fehler wird höchstwahrscheinlich durch einen Grenzwert für Ihr Abonnement für die von Ihnen ausgewählte Region verursacht. Versuchen Sie, eine andere Region für Ihre Bereitstellung auszuwählen.

Die bereitgestellte Beispiel-App zeigt nicht die Aufgabenlisten-App an.

Wenn anstelle der Aufgabenlisten-App die Seite Hey, Java developers! angezeigt wird, lädt App Service den aktualisierten Container höchstwahrscheinlich immer noch aus der neuesten Codebereitstellung. Warten Sie einige Minuten, und aktualisieren Sie die Seite.

Häufig gestellte Fragen

Wie viel kostet diese Einrichtung?

Die Preise für die erstellte Ressourcen sind wie folgt:

  • Der App Service-Plan wird im Tarif Basic erstellt und kann hoch- oder herunterskaliert werden. Informationen dazu finden Sie unter App Service – Preise.
  • Das Azure Cosmos DB-Konto wird in der Ebene Serverless erstellt. Mit dieser Ebene sind geringe Kosten verbunden. Weitere Informationen finden Sie unter Azure Cosmos DB-Preise.
  • Die Azure Cache for Redis wird in der Ebene Basic mit der minimalen Cachegröße erstellt. Diese Ebene ist mit geringen Kosten verbunden. Sie können sie auf leistungsstärkere Ebenen für eine höhere Verfügbarkeit, für Clustering und andere Features hochskalieren. Siehe Azure Cache for Redis: Preise.
  • Das virtuelle Netzwerk hat keine Gebühr, es sei denn, Sie konfigurieren zusätzliche Funktionen, z. B. Peering. Siehe Azure Virtual Network Preise.
  • Die private DNS-Zone verursacht eine kleine Gebühr. Siehe Azure DNS-Preise.

Wie führe ich die Datenbankmigration mit der Cosmos DB-Datenbank hinter dem virtuellen Netzwerk aus?

Der Java SE-Container in App Service verfügt bereits über Netzwerkkonnektivität mit Cosmos DB, enthält jedoch keine Migrationstools oder anderen MongoDB-Tools. Hier haben Sie mehrere Möglichkeiten:

  • Führen Sie die Datenbankmigration automatisch beim Start der App aus, z. B. mit Hibernate oder Flyway.
  • Installieren Sie in der SSH-Sitzungder App ein Migrationstool wie Flyway CLI, und führen Sie dann das Migrationsskript aus. Denken Sie daran, dass das installierte Tool nach einem App-Neustart nicht beibehalten wird, es sei denn, es befindet sich im Verzeichnis /home.
  • Integrieren Sie Azure Cloud Shell in das virtuelle Netzwerk, und führen Sie dort die Datenbankmigration aus.

Wie funktioniert die lokale App-Entwicklung mit GitHub Actions?

Nehmen Sie die automatisch generierte Workflowdatei von App Service als Beispiel; jede git push startet eine neue Build- und Bereitstellungsausführung. Aus einem lokalen Klon des GitHub-Repositorys können Sie die gewünschten Updates vornehmen und zu GitHub pushen. Zum Beispiel:

git add .
git commit -m "<some-message>"
git push origin main

Ich habe keine Berechtigungen zum Erstellen einer benutzerseitig zugewiesenen Identität.

Siehe Einrichten der Bereitstellung von GitHub Actions über das Bereitstellungscenter.

Was kann ich mit GitHub Copilot in meinem Codespace machen?

Möglicherweise haben Sie bemerkt, dass die GitHub Copilot-Chatansicht bereits verfügbar war, als Sie den Codespace erstellt haben. Zur Vereinfachung können Sie die GitHub Copilot-Chaterweiterung in die Containerdefinition einfügen (siehe .devcontainer/devcontainer.json). Sie benötigen jedoch ein GitHub Copilot-Konto (kostenlose 30-Tage-Testversion verfügbar).

Einige Tipps für die Unterhaltung mit GitHub Copilot:

  • In einer einzelnen Chatsitzung bauen die Fragen und Antworten aufeinander auf, und Sie können Ihre Fragen anpassen, um die Antworten zu optimieren.
  • Standardmäßig hat GitHub Copilot keinen Zugriff auf Dateien in Ihrem Repository. Um Fragen zu einer Datei zu stellen, öffnen Sie die Datei zuerst im Editor.
  • Damit GitHub Copilot beim Vorbereiten der Antworten Zugriff auf alle Dateien im Repository hat, beginnen Sie Ihre Frage mit @workspace. Weitere Informationen finden Sie unter Use the @workspace agent.
  • Innerhalb der Chatsitzung kann GitHub Copilot Änderungen vorschlagen und (mit @workspace) auch angeben, wo die Änderungen vorgenommen werden sollen. Copilot darf jedoch die Änderungen nicht für Sie vornehmen. Sie müssen entscheiden, ob Sie die vorgeschlagenen Änderungen hinzufügen und testen.

Nächste Schritte

Im Entwicklerhandbuch finden Sie weitere Informationen zum Ausführen von Java-Apps in App Service.

Konfigurieren einer Java-App in Azure App Service

Erfahren Sie, wie Sie Ihre App mit einer benutzerdefinierten Domäne und einem Zertifikat schützen.

 Schützen mit benutzerdefinierter Domäne und einem Zertifikat