Uso de Spring Data JPA con Azure SQL Database

Artículo
10/07/2024

En este tutorial se muestra cómo almacenar datos en Azure SQL Database mediante Spring Data JPA.

Java Persistence API (JPA) es la API de Java estándar para la asignación relacional de objetos.

En este tutorial, incluimos dos métodos de autenticación: la autenticación de Microsoft Entra y la autenticación de Base de datos SQL. La pestaña Sin contraseña muestra la autenticación de Microsoft Entra y la pestaña Contraseña muestra la autenticación de Base de datos SQL.

La autenticación de Microsoft Entra es un mecanismo para conectarse a Azure Database for SQL Database mediante identidades definidas en Microsoft Entra ID. Con la autenticación de Microsoft Entra, puede administrar las identidades de los usuarios de la base de datos y otros servicios de Microsoft en una ubicación central, lo que simplifica la administración de permisos.

La autenticación de SQL Database usa cuentas almacenadas en SQL Database. Si elige usar contraseñas como credenciales para las cuentas, estas credenciales se almacenarán en la tabla de usuarios. Dado que estas contraseñas se almacenan en SQL Database, debe administrar la rotación de las contraseñas usted mismo.

Requisitos previos

Una suscripción a Azure: cree una cuenta gratuita.
Kit de desarrollo de Java (JDK), versión 8 o posterior.
Apache Maven.
Azure CLI.

Utilidad sqlcmd
Controlador ODBC 17 o 18.
Si no tiene una, cree una instancia de Azure SQL Server denominada sqlservertest y una base de datos denominada demo. Para obtener instrucciones, consulte Inicio rápido: Creación de una base de datos única - Azure SQL Database.
Si no tiene ninguna aplicación de Spring Boot, cree un proyecto de Maven con Spring Initializr. Asegúrese de seleccionar Proyecto de Maven y, en Dependencias, agregue las dependencias Web de Spring, Spring Data JPA y Controlador MS SQL Server y, a continuación, seleccione Java versión 8 o posterior.

Importante

Para usar conexiones sin contraseña, actualice Controlador de servidor MS SQL a la versión 12.1.0 o superior y, a continuación, cree un usuario administrador de Microsoft Entra para la instancia del servidor de Azure SQL Database. Para obtener más información, consulte la sección Creación de un administrador de Microsoft Entra de Tutorial: Protección de una base de datos en Azure SQL Database.

Consulte la aplicación de ejemplo

En este tutorial, codificará una aplicación de ejemplo. Si desea ir más rápido, esta aplicación ya está codificada y disponible en https://github.com/Azure-Samples/quickstart-spring-data-jpa-sql-server.

Configuración de una regla de firewall para el servidor de Azure SQL Database

De forma predeterminada, las instancias de Azure SQL Database están protegidas. Tienen un firewall que no permite ninguna conexión entrante.

Para poder usar la base de datos, abra el firewall del servidor para permitir que la dirección IP local acceda al servidor de base de datos. Para obtener más información, consulte Tutorial: Protección de una base de datos en Azure SQL Database.

Si se conecta al servidor de Azure SQL Database desde el subsistema de Windows para Linux (WSL) en un equipo Windows, debe agregar el identificador de host de WSL al firewall.

Creación de un usuario no administrador de base de datos SQL y concesión de permisos

Este paso creará un usuario que no sea administrador y le concederá todos los permisos de la base de datos demo.

Sin contraseña (recomendado)
Contraseña

Para usar conexiones sin contraseña, consulte Tutorial: Protección de una base de datos en Azure SQL Database o Uso de Service Connector para crear un usuario administrador de Microsoft Entra para el servidor de Azure SQL Database, como se muestra en los pasos siguientes:

Primero, instale la extensión sin contraseña de Service Connector para la CLI de Azure:
```
az extension add --name serviceconnector-passwordless --upgrade
```

A continuación, use el siguiente comando para crear el usuario no administrador de Microsoft Entra:

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

El administrador de Microsoft Entra que creó es un usuario administrador de SQL Database, por lo que no es necesario crear un nuevo usuario.

Importante

Las conexiones sin contraseña de Azure SQL Database requieren la actualización del controlador de MS SQL Server a la versión 12.1.0 o superior. La opción de conexión es authentication=DefaultAzureCredential en la versión 12.1.0 y authentication=ActiveDirectoryDefault en la versión 12.2.0.

En primer lugar, cree un script SQL llamado create_user.sql para crear un usuario que no sea administrador. Agregue el siguiente contenido y guárdelo de forma local:

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

A continuación, utilice el siguiente comando para ejecutar el script SQL para crear el usuario no administrador:

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

Nota:

Para obtener más información sobre cómo crear usuarios de bases de datos SQL, consulte CREATE USER (Transact-SQL).

Almacenamiento de datos desde la instancia de Azure SQL Database

Con una instancia de Azure SQL Database, puede almacenar datos mediante Spring Cloud Azure.

Para instalar el módulo Spring Cloud Azure Starter, agregue las siguientes dependencias al archivo pom.xml :

La lista de materiales (BOM) de Azure de Spring Cloud:
```
<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>
```
Nota:

Si usa Spring Boot 2.x, asegúrese de establecer la versión de spring-cloud-azure-dependencies en 4.19.0. Esta lista de materiales (BOM) debe configurarse en la sección <dependencyManagement> del archivo pom.xml. Esto garantiza que todas las dependencias de Spring Cloud Azure usen la misma versión. Para obtener más información sobre la versión que se usa para esta lista de materiales, consulte Qué versión de Spring Cloud Azure debo usar.
El artefacto de Spring Cloud Azure Starter:
```
<dependency>
  <groupId>com.azure.spring</groupId>
  <artifactId>spring-cloud-azure-starter</artifactId>
</dependency>
```
Nota:

Como se trata de una dependencia, se debe agregar en la sección <dependencies> del pom.xml. Su versión no está configurada aquí, ya que está administrada por la BOM que agregamos anteriormente.

Configuración de Spring Boot para usar Azure SQL Database

Para almacenar datos de Azure SQL Database mediante Spring Data JPA, siga estos pasos para configurar la aplicación:

Configure las credenciales de Azure SQL Database en el archivo de configuración application.properties.

Sin contraseña (recomendado)
Contraseña

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

Advertencia

La propiedad de configuración spring.jpa.hibernate.ddl-auto=create-drop significa que Spring Boot creará automáticamente un esquema de base de datos al inicio de la aplicación e intentará eliminarlo cuando se cierre. Esta función es excelente para las pruebas, pero recuerde que se eliminarán los datos en cada reinicio, por lo que no debe usarse en producción.

Cree una clase nueva de Java Todo. Esta clase es un modelo de dominio asignado en la tabla todo, que se creará automáticamente mediante JPA. El siguiente código ignora los métodos getters y 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;

}

Edite el archivo de clase de inicio para mostrar el siguiente contenido.
```
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> {

}
```
Sugerencia

En este tutorial, no hay ninguna operación de autenticación en las configuraciones ni en el código. Sin embargo, la conexión a los servicios de Azure requiere autenticación. Para completar la autenticación, debe usar Azure Identity. Spring Cloud Azure usa DefaultAzureCredential, que la biblioteca de Azure Identity proporciona para ayudarle a obtener credenciales sin cambios en el código.

DefaultAzureCredential admite varios métodos de autenticación y determina qué método se usa en tiempo de ejecución. Este enfoque permite que la aplicación use diferentes métodos de autenticación en distintos entornos, como entornos locales o de producción, sin implementar código específico del entorno. Para obtener más información, vea DefaultAzureCredential.

Para completar la autenticación en entornos de desarrollo local, puede usar la CLI de Azure, Visual Studio Code, PowerShell u otros métodos. Para obtener más información, consulte Autenticación de Azure en entornos de desarrollo de Java. Para completar la autenticación en entornos de hospedaje de Azure, se recomienda usar la identidad administrada asignada por el usuario. Para obtener más información, consulta ¿Qué son las identidades administradas para recursos de Azure?

Inicie la aplicación. Verá registros similares a los del siguiente ejemplo:

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

Implementación en Azure Spring Apps

Ahora que tiene la aplicación Spring Boot que se ejecuta localmente, es el momento de moverla a producción. Azure Spring Apps facilita la implementación de aplicaciones de Spring Boot en Azure sin necesidad de realizar cambios en el código. El servicio administra la infraestructura de las aplicaciones de Spring, con el fin de que los desarrolladores puedan centrarse en el código. Azure Spring Apps proporciona administración del ciclo de vida mediante el uso de una supervisión y un diagnóstico completos, administración de la configuración, detección de servicios, integración de CI/CD e implementaciones azul-verde, entre otros. Para implementar la aplicación en Azure Spring Apps, consulte Implementación de la primera aplicación en Azure Spring Apps.

Pasos siguientes

Azure para desarrolladores de Spring

Compartir a través de