Verwenden der Spring Data-JPA mit Azure SQL-Datenbank

Artikel
10/04/2024

In diesem Lernprogramm wird das Speichern von Daten in einer Azure SQL-Datenbank mithilfe von Spring Data-JPA veranschaulicht.

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 SQL-Datenbank-Authentifizierung. Auf der Registerkarte „Kennwortlos” wird die Microsoft Entra-Authentifizierung und auf der Registerkarte „Kennwort” die SQL-Datenbank-Authentifizierung angezeigt.

Die Microsoft Entra-Authentifizierung ist ein Mechanismus zur Verbindung mit Azure Database for SQL Database 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.

SQL-Datenbank-Authentifizierung verwendet Konten, die in SQL-Datenbank gespeichert sind. Wenn Sie sich dafür entscheiden, Kennwörter als Anmeldeinformationen für die Konten zu verwenden, werden diese Anmeldeinformationen in der Benutzertabelle gespeichert. Da diese Kennwörter in SQL-Datenbank gespeichert werden, müssen Sie die Rotation der Kennwörter selbst verwalten.

Voraussetzungen

Azure-Abonnement (kostenloses Abonnement erstellen)
Java Development Kit (JDK), Version 8 oder höher.
Apache Maven.
Azure-Befehlszeilenschnittstelle.

SQLCMD-Hilfsprogramm
ODBC-Treiber 17 oder 18.
Wenn Sie nicht über eine verfügen, erstellen Sie eine Azure SQL Server-Instanz namens sqlservertest und eine Datenbank mit dem Namen demo. Weitere Anleitungen finden Sie unter Schnellstart: Erstellen einer Einzeldatenbank – Azure SQL-Datenbank.
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 MS SQL Server Driver hinzu, und wählen Sie dann Java-Version 8 oder höher aus.

Wichtig

Um kennwortlose Verbindungen zu verwenden, aktualisieren Sie MS SQL Server-Treiber auf Version 12.1.0 oder höher, und erstellen Sie dann einen Microsoft Entra-Administratorbenutzer für Ihre Azure SQL-Datenbank-Serverinstanz. Weitere Informationen finden Sie im Abschnitt Erstellen eines Microsoft Entra-Administrators des Lernprogramms: Sichern einer Datenbank in Azure SQL-Datenbank.

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-sql-server bereits programmiert und verfügbar.

Konfigurieren einer Firewallregel für den Azure SQL-Datenbank-Server

Azure SQL-Datenbankinstanzen 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 Tutorial: Sichern einer Datenbank in Azure SQL-Datenbank.

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

Erstellen eines SQL-Datenbankbenutzers ohne Administratorrechte und Erteilen von Berechtigungen

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

Kennwortlos (empfohlen)
Kennwort

Informationen zur Verwendung kennwortloser Verbindungen finden Sie im Lernprogramm: Sichern einer Datenbank in Azure SQL-Datenbank oder Verwenden von Service Connector zum Erstellen eines Microsoft Entra-Administratorbenutzers für Ihren Azure SQL-Datenbank-Server, wie in den folgenden Schritten gezeigt:

Zuerst installieren Sie die kennwortlose Dienstconnector-Erweiterung für die Azure CLI:
```
az extension add --name serviceconnector-passwordless --upgrade
```

Danach verwenden Sie den folgenden Befehl, um den Microsoft Entra Nicht-Administratorbenutzer zu erstellen:

az connection create sql \
    --resource-group <your-resource-group-name> \
    --connection sql_conn \
    --target-resource-group <your-resource-group-name> \
    --server sqlservertest \
    --database demo \
    --user-account \
    --query authInfo.userName \
    --output tsv

Der von Ihnen erstellte Microsoft Entra-Administrator ist ein SQL-Datenbankadministratorbenutzer, sodass Sie keinen neuen Benutzer erstellen müssen.

Wichtig

Kennwortlose Azure SQL-Datenbankverbindungen erfordern ein Upgrade des MS SQL Server-Treibers auf Version 12.1.0 oder höher. Die Verbindungsoption befindet sich authentication=DefaultAzureCredential in Version 12.1.0 und authentication=ActiveDirectoryDefault in Version 12.2.0.

Erstellen Sie zunächst ein SQL-Skript mit dem Namen create_user.sql zum Erstellen eines Benutzers ohne Administratorrechte. Fügen Sie den folgenden Inhalt hinzu, und speichern Sie das Skript lokal:

cat << EOF > create_user.sql
USE demo;
GO
CREATE USER <your_sql_server_non_admin_username> WITH PASSWORD='<your_sql_server_non_admin_password>'
GO
GRANT CONTROL ON DATABASE::demo TO <your_sql_server_non_admin_username>;
GO
EOF

Verwenden Sie dann den folgenden Befehl, um das SQL-Skript auszuführen, um den Benutzer ohne Administratorrechte zu erstellen:

sqlcmd -S sqlservertest.database.windows.net,1433 -d demo -U <your_sql_server_admin_username> -P <your_sql_server_admin_password> -i create_user.sql

Hinweis

Weitere Informationen zum Erstellen von SQL-Datenbankbenutzern finden Sie unter CREATE USER (Transact-SQL).

Speichern von Daten aus der Azure SQL-Datenbank

Mit einer Azure SQL-Datenbankinstanz können Sie Daten mithilfe von Spring Cloud Azure speichern.

Um das Spring Cloud Azure-Startermodul 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.19.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-Artefakt:
```
<dependency>
  <groupId>com.azure.spring</groupId>
  <artifactId>spring-cloud-azure-starter</artifactId>
</dependency>
```
Hinweis

Da es sich um eine Abhängigkeit handelt, sollte sie im <dependencies> Abschnitt der pom.xml hinzugefügt werden. Die Version ist hier nicht konfiguriert, da sie von der zuvor hinzugefügten BOM verwaltet wird.

Konfigurieren von Spring Boot für die Verwendung von Azure SQL-Datenbank

Führen Sie die folgenden Schritte aus, um Daten aus Azure SQL-Datenbank mithilfe von Spring Data-JPA zu speichern:

Konfigurieren Sie Azure SQL-Datenbank-Anmeldeinformationen in der Konfigurationsdatei application.properties.

Kennwortlos (empfohlen)
Kennwort

logging.level.org.hibernate.SQL=DEBUG

spring.datasource.url=jdbc:sqlserver://sqlservertest.database.windows.net:1433;databaseName=demo;authentication=DefaultAzureCredential;

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

logging.level.org.hibernate.SQL=DEBUG

spring.datasource.url=jdbc:sqlserver://sqlservertest.database.windows.net:1433;database=demo;encrypt=true;trustServerCertificate=false;hostNameInCertificate=*.database.windows.net;loginTimeout=30;
spring.datasource.username=<your_sql_server_non_admin_username>
spring.datasource.password=<your_sql_server_non_admin_password>

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

Warnung

Die Konfigurationseigenschaft spring.jpa.hibernate.ddl-auto=create-drop bedeutet, dass Spring Boot beim Start der Anwendung automatisch ein Datenbankschema erstellt und versucht, dieses beim Herunterfahren zu löschen. Dieses Feature eignet sich hervorragend für Tests. Denken Sie jedoch daran, dass Ihre Daten bei jedem Neustart gelöscht werden, daher sollte diese Eigenschaft nicht in der Produktion verwendet werden.

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;

}

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?.

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-Entwickler

Freigeben über