Freigeben über

Verwenden von Spring Data-JPA mit Azure Database for MySQL

  • Artikel

In diesem LTutorial wird veranschaulicht, wie Daten in einer Azure Database for MySQL-Datenbank mithilfe von Spring Data-JPA gespeichert werden.

Die Java-Persistenz-API (JPA) ist die Standard-Java-API für die objektrelationale Zuordnung.

In diesem Tutorial werden zwei Authentifizierungsmethoden vorgestellt: die Microsoft Entra-Authentifizierung und die MySQL-Authentifizierung. Die Registerkarte Kennwortlos zeigt die Microsoft Entra-Authentifizierung und die Registerkarte Kennwort die MySQL-Authentifizierung.

Die Microsoft Entra-Authentifizierung ist ein Mechanismus zum Herstellen einer Verbindung mit Azure Database for MySQL unter Verwendung von Identitäten, die in Microsoft Entra ID definiert sind. Mit der Microsoft Entra-Authentifizierung können Sie Datenbankbenutzeridentitäten und andere Microsoft-Dienste an einem zentralen Ort verwalten, wodurch die Berechtigungsverwaltung vereinfacht wird.

MySQL-Authentifizierung verwendet Konten, die in MySQL gespeichert sind. Wenn Sie Kennwörter als Anmeldeinformationen für die Konten verwenden möchten, werden diese Anmeldeinformationen in der user-Tabelle gespeichert. Da diese Kennwörter in MySQL gespeichert werden, müssen Sie die Rotation der Kennwörter selbst verwalten.

Voraussetzungen

  • MySQL-Befehlszeilenclient.

  • Wenn Sie über keine Spring Boot-Anwendung verfügen, erstellen Sie mit Spring Initializr ein Maven-Projekt. Achten Sie darauf, Maven-Projekt auszuwählen, fügen Sie unter Abhängigkeiten die Abhängigkeit Spring Web, Spring Data-JPA und MySQL Driver hinzu, und wählen Sie dann Java-Version 8 oder höher aus.

Wichtig

Um kennwortlose Verbindungen zu verwenden, erstellen Sie einen Microsoft Entra-Administratorbenutzer für Ihre Azure Database for MySQL-Instanz. Anweisungen finden Sie im Abschnitt Konfigurieren des Microsoft Entra-Admin unter Einrichten der Microsoft Entra-Authentifizierung für Azure Database for MySQL – flexibler Server".

Siehe die Beispielanwendung

In diesem Tutorial codieren Sie eine Beispielanwendung. Wenn Sie schneller vorgehen möchten, ist diese Anwendung unter https://github.com/Azure-Samples/quickstart-spring-data-jpa-mysql bereits programmiert und verfügbar.

Konfigurieren einer Firewallregel für den MySQL-Server

Azure Database for MySQL-Instanzen sind standardmäßig gesichert. Sie besitzen eine Firewall, die keine eingehenden Verbindungen zulässt.

Um Ihre Datenbank nutzen zu können, öffnen Sie die Firewall des Servers, damit die lokale IP-Adresse auf den Datenbankserver zugreifen kann. Weitere Informationen finden Sie unter Verwalten von Firewallregeln für Azure Database for MySQL – flexibler Server mit Azure-Portal.

Wenn Sie über das Windows-Subsystem für Linux (WSL) auf einem Windows-Computer eine Verbindung mit Ihrem MySQL-Server herstellen, müssen Sie der Firewall die WSL-Host-IP-Adresse hinzufügen.

Erstellen eines MySQL-Nicht-Administratorbenutzers und Erteilen von Berechtigungen

In diesem Schritt wird ein Benutzer ohne Administratorrechte erstellt und ihm alle Berechtigungen für die demo Datenbank erteilt.

Sie können die folgende Methode verwenden, um einen Nicht-Administratorbenutzer zu erstellen, der eine kennwortlose Verbindung verwendet.

  1. Verwenden Sie den folgenden Befehl, um die kennwortlose Service Connector-Erweiterung für die Azure CLI zu installieren:

     az extension add --name serviceconnector-passwordless --upgrade

  2. Verwenden Sie den folgenden Befehl, um den Microsoft Entra Nicht-Administratorbenutzer zu erstellen:

      az connection create mysql-flexible \
       --resource-group <your_resource_group_name> \
       --connection mysql_conn \
       --target-resource-group <your_resource_group_name> \
       --server mysqlflexibletest \
       --database demo \
       --user-account mysql-identity-id=/subscriptions/<your_subscription_id>/resourcegroups/<your_resource_group_name>/providers/Microsoft.ManagedIdentity/userAssignedIdentities/<your_user_assigned_managed_identity_name> \
       --query authInfo.userName \
       --output tsv

    Wenn der Befehl abgeschlossen ist, notieren Sie sich den Benutzernamen in der Konsolenausgabe.

Speichern Sie Daten von Azure Database for MySQL

Nachdem Sie nun über eine Azure Database for MySQL flexible Server-Instanz verfügen, können Sie Daten mithilfe von Spring Cloud Azure speichern.

Um das Spring Cloud Azure Starter JDBC MySQL-Modul zu installieren, fügen Sie Ihrer pom.xml-Datei die folgenden Abhängigkeiten hinzu:

  • Die Spring Cloud Azure Bill of Materials (BOM):

    <dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure.spring</groupId>
      <artifactId>spring-cloud-azure-dependencies</artifactId>
      <version>5.18.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

    Hinweis

    Wenn Sie Spring Boot 2.x verwenden, stellen Sie sicher, dass Sie die spring-cloud-azure-dependencies Version auf 4.19.0 festlegen. Diese Stückliste (Bill of Material, BOM) sollte im <dependencyManagement> Abschnitt Ihrer pom.xml Datei konfiguriert werden. Dadurch wird sichergestellt, dass alle Spring Cloud Azure-Abhängigkeiten dieselbe Version verwenden. Weitere Informationen zu der Version, die für diese BOM verwendet wird, finden Sie unter Welche Version von Spring Cloud Azure sollte ich verwenden.

  • Das Spring Cloud Azure Starter JDBC MySQL-Artefakt:

    <dependency>
  <groupId>com.azure.spring</groupId>
  <artifactId>spring-cloud-azure-starter-jdbc-mysql</artifactId>
</dependency>

Hinweis

Kennwortlose Verbindungen werden seit Version 4.5.0 unterstützt.

Konfigurieren von Spring Boot für die Verwendung von Azure Database for MySQL

Führen Sie die folgenden Schritte aus, um Daten aus der Azure Database for MySQL mithilfe von Spring Data-JPA zu speichern:

  1. Konfigurieren Sie Azure Database for MySQL-Anmeldeinformationen, indem Sie der Konfigurationsdatei application.properties die folgenden Eigenschaften hinzufügen.

    logging.level.org.hibernate.SQL=DEBUG

spring.datasource.azure.passwordless-enabled=true
spring.datasource.url=jdbc:mysql://mysqlflexibletest.mysql.database.azure.com:3306/demo?serverTimezone=UTC
spring.datasource.username=<your_mysql_ad_non_admin_username>

spring.jpa.hibernate.ddl-auto=create-drop
spring.jpa.properties.hibernate.dialect =org.hibernate.dialect.MySQL8Dialect

    Warnung

    An die spring.datasource.url-Konfigurationseigenschaft wird ?serverTimezone=UTC angefügt, um den JDBC-Treiber anzuweisen, beim Herstellen einer Verbindung mit der Datenbank das UTC-Datumsformat (Coordinated Universal Time, koordinierte Weltzeit) zu verwenden. Ohne diesen Parameter würde Ihr Java-Server nicht das gleiche Datumsformat wie die Datenbank verwenden, was zu einem Fehler führen würde.

Wichtig

Um kennwortlose Verbindungen zu verwenden, erstellen Sie einen Microsoft Entra-Administratorbenutzer für Ihre Azure Database for MySQL-Instanz. Anweisungen finden Sie im Abschnitt Festlegen des Microsoft Entra Admin-Benutzers unter Verwendung der Microsoft Entra-ID für die Authentifizierung mit MySQL.

Siehe die Beispielanwendung

In diesem Artikel wird eine Beispielanwendung codiert. Wenn Sie schneller vorgehen möchten, ist diese Anwendung unter https://github.com/Azure-Samples/quickstart-spring-data-jpa-mysql bereits programmiert und verfügbar.

Konfigurieren einer Firewallregel für den MySQL-Server

Azure Database for MySQL-Instanzen sind standardmäßig gesichert. Sie besitzen eine Firewall, die keine eingehenden Verbindungen zulässt.

Um Ihre Datenbank nutzen zu können, öffnen Sie die Firewall des Servers, damit die lokale IP-Adresse auf den Datenbankserver zugreifen kann. Weitere Informationen finden Sie unter Erstellen und Verwalten von Firewallregeln für Azure Database for MySQL mithilfe des Azure-Portals.

Wenn Sie über das Windows-Subsystem für Linux (WSL) auf einem Windows-Computer eine Verbindung mit Ihrem MySQL-Server herstellen, müssen Sie der Firewall die WSL-Host-IP-Adresse hinzufügen.

Erstellen eines MySQL-Nicht-Administratorbenutzers und Erteilen von Berechtigungen

In diesem Schritt wird ein Benutzer ohne Administratorrechte erstellt und ihm alle Berechtigungen für die demo Datenbank erteilt.

Wichtig

Um kennwortlose Verbindungen zu verwenden, erstellen Sie einen Microsoft Entra-Administratorbenutzer für Ihre Azure Database for MySQL-Instanz. Weitere Informationen finden Sie im Abschnitt Festlegen des Microsoft Entra Admin-Benutzers unter Verwendung der Microsoft Entra-ID für die Authentifizierung mit MySQL.

Erstellen Sie ein SQL-Skript namens create_ad_user.sql zum Erstellen eines Nicht-Administratorbenutzers. Fügen Sie den folgenden Inhalt hinzu, und speichern Sie das Skript lokal:

export AZ_MYSQL_AD_NON_ADMIN_USERID=$(az ad signed-in-user show --query id --output tsv)

cat << EOF > create_ad_user.sql
SET aad_auth_validate_oids_in_tenant = OFF;
CREATE AADUSER '<your_mysql_ad_non_admin_username>' IDENTIFIED BY '$AZ_MYSQL_AD_NON_ADMIN_USERID';
GRANT ALL PRIVILEGES ON demo.* TO '<your_mysql_ad_non_admin_username>'@'%';
FLUSH privileges;
EOF

Verwenden Sie dann den folgenden Befehl, um das SQL-Skript zum Erstellen des/der Microsoft Entra-Benutzers/-Benutzerin ohne Administratorrechte auszuführen:

mysql -h mysqlsingletest.mysql.database.azure.com --user <your_mysql_ad_admin_username>@mysqlsingletest --enable-cleartext-plugin --password=$(az account get-access-token --resource-type oss-rdbms --output tsv --query accessToken) < create_ad_user.sql

Tipp

Um die Microsoft Entra-Authentifizierung zum Herstellen einer Verbindung mit Azure Database for MySQL zu verwenden, müssen Sie sich mit dem von Ihnen eingerichteten Microsoft Entra-Administratorbenutzer anmelden und dann das Zugriffstoken als Kennwort abrufen. Für weitere Informationen, siehe Verwendung der Microsoft Entra ID für die Authentifizierung mit MySQL.

Speichern Sie Daten von Azure Database for MySQL

Nachdem Sie nun über eine Azure Database for MySQL Einzelserver-Instanz verfügen, können Sie Daten mithilfe von Spring Cloud Azure speichern.

Um das Spring Cloud Azure Starter JDBC MySQL-Modul zu installieren, fügen Sie Ihrer pom.xml-Datei die folgenden Abhängigkeiten hinzu:

  • Die Spring Cloud Azure Bill of Materials (BOM):

    <dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure.spring</groupId>
      <artifactId>spring-cloud-azure-dependencies</artifactId>
      <version>5.18.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>

    Hinweis

    Wenn Sie Spring Boot 2.x verwenden, stellen Sie sicher, dass Sie die spring-cloud-azure-dependencies Version auf 4.19.0 festlegen. Diese Stückliste (Bill of Material, BOM) sollte im <dependencyManagement> Abschnitt Ihrer pom.xml Datei konfiguriert werden. Dadurch wird sichergestellt, dass alle Spring Cloud Azure-Abhängigkeiten dieselbe Version verwenden. Weitere Informationen zu der Version, die für diese BOM verwendet wird, finden Sie unter Welche Version von Spring Cloud Azure sollte ich verwenden.

  • Das Spring Cloud Azure Starter JDBC MySQL-Artefakt:

    <dependency>
  <groupId>com.azure.spring</groupId>
  <artifactId>spring-cloud-azure-starter-jdbc-mysql</artifactId>
</dependency>

Hinweis

Kennwortlose Verbindungen werden seit Version 4.5.0 unterstützt.

Konfigurieren von Spring Boot für die Verwendung von Azure Database for MySQL

Führen Sie die folgenden Schritte aus, um Daten aus der Azure Database for MySQL mithilfe von Spring Data-JPA zu speichern:

  1. Konfigurieren Sie Azure Database for MySQL-Anmeldeinformationen, indem Sie der Konfigurationsdatei application.properties die folgenden Eigenschaften hinzufügen.

    logging.level.org.hibernate.SQL=DEBUG

spring.datasource.azure.passwordless-enabled=true
spring.datasource.url=jdbc:mysql://mysqlsingletest.mysql.database.azure.com:3306/demo?serverTimezone=UTC
spring.datasource.username=<your_mysql_ad_non_admin_username>@mysqlsingletest

spring.jpa.hibernate.ddl-auto=create-drop
spring.jpa.properties.hibernate.dialect =org.hibernate.dialect.MySQL8Dialect

    Warnung

    An die spring.datasource.url-Konfigurationseigenschaft wird ?serverTimezone=UTC angefügt, um den JDBC-Treiber anzuweisen, beim Herstellen einer Verbindung mit der Datenbank das UTC-Datumsformat (Coordinated Universal Time, koordinierte Weltzeit) zu verwenden. Ohne diesen Parameter würde Ihr Java-Server nicht das gleiche Datumsformat wie die Datenbank verwenden, was zu einem Fehler führen würde.

  1. Erstellen Sie eine neue Todo Java-Klasse. Diese Klasse ist ein Domänenmodell, das in der todo Tabelle zugeordnet wird, die automatisch von JPA erstellt wird. Der folgende Code ignoriert die getters- und setters-Methoden:

    package com.example.demo;

import javax.persistence.Entity;
import javax.persistence.GeneratedValue;
import javax.persistence.Id;

@Entity
public class Todo {

    public Todo() {
    }

    public Todo(String description, String details, boolean done) {
        this.description = description;
        this.details = details;
        this.done = done;
    }

    @Id
    @GeneratedValue
    private Long id;

    private String description;

    private String details;

    private boolean done;

}

  2. Bearbeiten Sie die Startklassendatei, um den folgenden Inhalt anzuzeigen.

    import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.context.annotation.Bean;
import org.springframework.data.jpa.repository.JpaRepository;

import java.util.stream.Collectors;
import java.util.stream.Stream;

@SpringBootApplication
public class DemoApplication {

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

    @Bean
    ApplicationListener<ApplicationReadyEvent> basicsApplicationListener(TodoRepository repository) {
        return event->repository
            .saveAll(Stream.of("A", "B", "C").map(name->new Todo("configuration", "congratulations, you have set up correctly!", true)).collect(Collectors.toList()))
            .forEach(System.out::println);
    }

}

interface TodoRepository extends JpaRepository<Todo, Long> {

}

    Tipp

    In diesem Lernprogramm gibt es keine Authentifizierungsvorgänge in den Konfigurationen oder im Code. Für die Verbindung mit dem Azure-Diensten ist jedoch eine Authentifizierung erforderlich. Um die Authentifizierung abzuschließen, müssen Sie Azure Identity verwenden. Spring Cloud Azure verwendet DefaultAzureCredential, was die Azure Identity-Bibliothek bereitstellt, um Sie beim Abrufen von Anmeldeinformationen ohne Codeänderungen zu unterstützen.

    „DefaultAzureCredential“ unterstützt mehrere Authentifizierungsmethoden und bestimmt, welche Methode zur Laufzeit verwendet wird. Mit diesem Ansatz kann Ihre Anwendung verschiedene Authentifizierungsmethoden in unterschiedlichen Umgebungen verwenden (z. B. in lokalen oder Produktionsumgebungen), ohne dass umgebungsspezifischer Code implementiert werden muss. Weitere Informationen finden Sie unter DefaultAzureCredential.

    Um die Authentifizierung in lokalen Entwicklungsumgebungen abzuschließen, können Sie Azure CLI, Visual Studio Code, PowerShell oder andere Methoden verwenden. Weitere Informationen finden Sie unter Azure-Authentifizierung in Java-Entwicklungsumgebungen. Um die Authentifizierung in Azure-Hostingumgebungen abzuschließen, empfehlen wir die Verwendung einer benutzerzugewiesenen verwalteten Identität. Weitere Informationen finden Sie unter Was sind verwaltete Identitäten für Azure-Ressourcen?.

  3. Starten Sie die Anwendung. Ihnen wird daraufhin Protokolle angezeigt, die in etwa wie im folgenden Beispiel aussehen:

    2023-02-01 10:29:19.763 DEBUG 4392 --- [main] org.hibernate.SQL : insert into todo (description, details, done, id) values (?, ?, ?, ?)
com.example.demo.Todo@1f

Bereitstellen in Azure Spring Apps

Nachdem Sie nun die Spring Boot-Anwendung lokal ausgeführt haben, ist es an der Zeit, sie in die Produktion zu verschieben. Mit Azure Spring Apps lassen sich Spring Boot-Anwendungen ganz einfach und ohne Codeänderungen in Azure bereitstellen. Der Dienst verwaltet die Infrastruktur von Spring-Anwendungen und ermöglicht es Entwicklern dadurch, sich auf ihren Code zu konzentrieren. Azure Spring Apps bietet eine Lebenszyklusverwaltung mit umfassender Überwachung und Diagnose, Konfigurationsverwaltung, Dienstermittlung, CI/CD-Integration, Blau/Grün-Bereitstellungen und mehr. Informationen zum Bereitstellen Ihrer Anwendung in Azure Spring Apps finden Sie unter Bereitstellen Ihrer ersten Anwendung in Azure Spring Apps.

Nächste Schritte

Azure für Spring-EntwicklerBeispiele für Spring Cloud Azure MySQL