Använda Spring Data JPA med Azure SQL Database

Artikel
01/17/2024

Den här självstudien visar hur du lagrar data i Azure SQL Database med Spring Data JPA.

Java Persistence API (JPA) är java-standard-API:et för objektrelationsmappning.

I den här självstudien inkluderar vi två autentiseringsmetoder: Microsoft Entra-autentisering och SQL Database-autentisering. Fliken Lösenordslös visar Microsoft Entra-autentiseringen och fliken Lösenord visar SQL Database-autentiseringen.

Microsoft Entra-autentisering är en mekanism för att ansluta till Azure Database for SQL Database med hjälp av identiteter som definierats i Microsoft Entra-ID. Med Microsoft Entra-autentisering kan du hantera databasanvändares identiteter och andra Microsoft-tjänster på en central plats, vilket förenklar behörighetshanteringen.

SQL Database-autentisering använder konton som lagras i SQL Database. Om du väljer att använda lösenord som autentiseringsuppgifter för kontona lagras dessa autentiseringsuppgifter i användartabellen. Eftersom dessa lösenord lagras i SQL Database måste du hantera rotationen av lösenorden själv.

Förutsättningar

En Azure-prenumeration – skapa en kostnadsfritt.
Java Development Kit (JDK), version 8 eller senare.
Apache Maven.
Azure CLI.

sqlcmd-verktyg
ODBC-drivrutin 17 eller 18.
Om du inte har någon skapar du en Azure SQL Server-instans med namnet sqlservertest och en databas med namnet demo. Anvisningar finns i Snabbstart: Skapa en enkel databas – Azure SQL Database.
Om du inte har något Spring Boot-program skapar du ett Maven-projekt med Spring Initializr. Se till att välja Maven Project och under Beroenden lägger du till Spring Web, Spring Data JPA och MS SQL Server Driver-beroenden och väljer sedan Java version 8 eller senare.

Viktigt!

Om du vill använda lösenordslösa anslutningar uppgraderar du MS SQL Server-drivrutinen till version 12.1.0 eller senare och skapar sedan en Microsoft Entra-administratörsanvändare för din Azure SQL Database-serverinstans. Mer information finns i avsnittet Skapa en Microsoft Entra-administratör i Självstudie: Skydda en databas i Azure SQL Database.

Se exempelprogrammet

I den här självstudien kodar du ett exempelprogram. Om du vill gå snabbare är det här programmet redan kodat och tillgängligt på https://github.com/Azure-Samples/quickstart-spring-data-jpa-sql-server.

Konfigurera en brandväggsregel för din Azure SQL Database-server

Azure SQL Database-instanser skyddas som standard. Databaserna har en brandvägg som inte tillåter inkommande anslutningar.

Om du vill kunna använda databasen öppnar du serverns brandvägg så att den lokala IP-adressen kan komma åt databasservern. Mer information finns i Självstudie: Skydda en databas i Azure SQL Database.

Om du ansluter till Din Azure SQL Database-server från Windows-undersystem för Linux (WSL) på en Windows-dator måste du lägga till WSL-värd-ID:t i brandväggen.

Skapa en SQL-databas som inte är administratör och bevilja behörighet

Det här steget skapar en icke-administratörsanvändare och beviljar alla behörigheter för databasen till den demo .

Lösenordsfri (rekommenderas)
Lösenord

Information om hur du använder lösenordslösa anslutningar finns i Självstudie: Skydda en databas i Azure SQL Database eller använd Service Anslut eller för att skapa en Microsoft Entra-administratörsanvändare för din Azure SQL Database-server, som du ser i följande steg:

Installera först tillägget Service Anslut eller passwordless för Azure CLI:
```
az extension add --name serviceconnector-passwordless --upgrade
```

Använd sedan följande kommando för att skapa microsoft Entra-användaren som inte är administratör:

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

Microsoft Entra-administratören som du skapade är en SQL-databasadministratörsanvändare, så du behöver inte skapa en ny användare.

Viktigt!

Lösenordslösa anslutningar i Azure SQL Database kräver uppgradering av MS SQL Server-drivrutinen till version 12.1.0 eller högre. Anslutningsalternativet är authentication=DefaultAzureCredential i version 12.1.0 och authentication=ActiveDirectoryDefault version 12.2.0.

Skapa först ett SQL-skript med namnet create_user.sql för att skapa en icke-administratörsanvändare. Lägg till följande innehåll och spara det lokalt:

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

Använd sedan följande kommando för att köra SQL-skriptet för att skapa användaren som inte är administratör:

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

Kommentar

Mer information om hur du skapar SQL-databasanvändare finns i CREATE USER (Transact-SQL).

Lagra data från Azure SQL Database

Med en Azure SQL Database-instans kan du lagra data med hjälp av Spring Cloud Azure.

Om du vill installera Spring Cloud Azure Starter-modulen lägger du till följande beroenden i din pom.xml-fil :

Spring Cloud Azure Bill of Materials (BOM):
```
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure.spring</groupId>
      <artifactId>spring-cloud-azure-dependencies</artifactId>
      <version>5.12.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>
```
Kommentar

Om du använder Spring Boot 2.x måste du ange spring-cloud-azure-dependencies versionen till 4.18.0. Den här strukturlistan (BOM) bör konfigureras i avsnittet i <dependencyManagement> din pom.xml-fil . Detta säkerställer att alla Spring Cloud Azure-beroenden använder samma version. Mer information om vilken version som används för den här strukturlistan finns i Vilken version av Spring Cloud Azure ska jag använda.
Spring Cloud Azure Starter-artefakten:
```
<dependency>
  <groupId>com.azure.spring</groupId>
  <artifactId>spring-cloud-azure-starter</artifactId>
</dependency>
```
Kommentar

Eftersom det här är ett beroende bör det läggas till i <dependencies> avsnittet i pom.xml. Dess version är inte konfigurerad här eftersom den hanteras av den strukturlista som vi lade till tidigare.

Konfigurera Spring Boot för att använda Azure SQL Database

Följ dessa steg för att konfigurera programmet för att lagra data från Azure SQL Database med Spring Data JPA:

Konfigurera en Azure SQL Database-autentiseringsuppgifter i konfigurationsfilen application.properties .

Lösenordsfri (rekommenderas)
Lösenord

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

Varning

Konfigurationsegenskapen spring.jpa.hibernate.ddl-auto=create-drop gör att Spring Boot automatiskt skapar ett databasschema när appen startar och försöker ta bort schemat när appen stängs. Den här funktionen är bra för testning, men kom ihåg att den tar bort dina data vid varje omstart, så du bör inte använda dem i produktion.

Skapa en ny Todo Java-klass. Den här klassen är en domänmodell som mappas till tabellen todo som skapas automatiskt av JPA. Följande kod ignorerar getters metoderna och setters .

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;

}

Redigera startklassfilen för att visa följande innehåll.
```
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> {

}
```
Dricks

I den här självstudien finns det inga autentiseringsåtgärder i konfigurationerna eller koden. Att ansluta till Azure-tjänster kräver dock autentisering. För att slutföra autentiseringen måste du använda Azure Identity. Spring Cloud Azure använder DefaultAzureCredential, som Azure Identity-biblioteket tillhandahåller för att hjälpa dig att få autentiseringsuppgifter utan några kodändringar.

DefaultAzureCredential stöder flera autentiseringsmetoder och avgör vilken metod som ska användas vid körning. Med den här metoden kan din app använda olika autentiseringsmetoder i olika miljöer (till exempel lokala miljöer och produktionsmiljöer) utan att implementera miljöspecifik kod. Mer information finns i DefaultAzureCredential.

För att slutföra autentiseringen i lokala utvecklingsmiljöer kan du använda Azure CLI, Visual Studio Code, PowerShell eller andra metoder. Mer information finns i Azure-autentisering i Java-utvecklingsmiljöer. För att slutföra autentiseringen i Azure-värdmiljöer rekommenderar vi att du använder användartilldelad hanterad identitet. Mer information finns i Vad är hanterade identiteter för Azure-resurser?

Starta programmet. Du ser loggar som liknar följande exempel:

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

Distribuera till Azure Spring Apps

Nu när Spring Boot-programmet körs lokalt är det dags att flytta det till produktion. Azure Spring Apps gör det enkelt att distribuera Spring Boot-program till Azure utan några kodändringar. Tjänsten hanterar infrastrukturen för Spring-program så att utvecklare kan fokusera på sin kod. Azure Spring Apps tillhandahåller livscykelhantering med omfattande övervakning och diagnostik, konfigurationshantering, tjänstidentifiering, CI/CD-integrering, blågröna distributioner med mera. Information om hur du distribuerar ditt program till Azure Spring Apps finns i Distribuera ditt första program till Azure Spring Apps.

Nästa steg

Azure for Spring-utvecklare

Share via