Usar o Spring Data JDBC com o Banco de Dados do Azure para MySQL

Este tutorial demonstra como armazenar dados no Banco de Dados do Azure para banco de dados MySQL usando o Spring Data JDBC.

JDBC é a API Java padrão para se conectar a bancos de dados relacionais tradicionais.

Neste tutorial, incluímos dois métodos de autenticação: autenticação Microsoft Entra e autenticação MySQL. A guia Sem senha mostra a autenticação do Microsoft Entra e a guia Senha mostra a autenticação do MySQL.

A autenticação do Microsoft Entra é um mecanismo para se conectar ao Banco de Dados do Azure para MySQL usando identidades definidas na ID do Microsoft Entra. Com a autenticação do Microsoft Entra, você pode gerenciar identidades de usuário de banco de dados e outros serviços da Microsoft em um local central, o que simplifica o gerenciamento de permissões.

A autenticação MySQL usa contas armazenadas no MySQL. Se você optar por usar senhas como credenciais para as contas, essas credenciais serão armazenadas na user tabela. Como essas senhas são armazenadas no MySQL, você precisa gerenciar a rotação das senhas por conta própria.

Pré-requisitos

• Uma assinatura do Azure - crie uma gratuitamente.

• Java Development Kit (JDK), versão 8 ou superior.

• Apache Maven.

• CLI do Azure.

• Cliente de linha de comando MySQL.

• Se você não tiver um aplicativo Spring Boot, crie um projeto Maven com o Spring Initializr. Certifique-se de selecionar Projeto Maven e, em Dependências, adicione as dependências Spring Web, Spring Data JDBC e MySQL Driver e, em seguida, selecione Java versão 8 ou superior.

• Se você não tiver um, crie um Banco de Dados do Azure para a instância do Servidor Flexível MySQL chamado mysqlflexibletest. Para obter instruções, consulte Guia de início rápido: usar o portal do Azure para criar um Banco de Dados do Azure para o Servidor Flexível MySQL. Em seguida, crie um banco de dados chamado demo. Para obter instruções, consulte Criar e gerenciar bancos de dados para o Banco de Dados do Azure para o Servidor Flexível MySQL.

Veja o aplicativo de exemplo

Neste tutorial, você codificará um aplicativo de exemplo. Se você quiser ir mais rápido, este aplicativo já está codificado e disponível em https://github.com/Azure-Samples/quickstart-spring-data-jdbc-mysql.

Configurar uma regra de firewall para o servidor MySQL

As instâncias do Banco de Dados do Azure para MySQL são protegidas por padrão. O serviço tem uma firewall que não permite ligações de entrada.

Para poder usar seu banco de dados, abra o firewall do servidor para permitir que o endereço IP local acesse o servidor de banco de dados. Para obter mais informações, consulte Gerenciar regras de firewall para o Banco de Dados do Azure para MySQL - Servidor flexível usando o portal do Azure.

Se você estiver se conectando ao seu servidor MySQL a partir do Windows Subsystem for Linux (WSL) em um computador Windows, você precisará adicionar o endereço IP do host WSL ao seu firewall.

Crie um usuário não-administrador do MySQL e conceda permissão

Esta etapa criará um usuário não administrador e concederá todas as permissões no demo banco de dados a ele.

Sem senha (recomendado)

Você pode usar o método a seguir para criar um usuário não administrador que usa uma conexão sem senha.

Conector de serviço (recomendado)

1. Use o seguinte comando para instalar a extensão sem senha do Service Connector para a CLI do Azure:

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

2. Use o seguinte comando para criar o usuário não administrador do Microsoft Entra:

     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
   

   Quando o comando for concluído, anote o nome de usuário na saída do console.

Configuração manual

Importante

Para usar conexões sem senha, crie um usuário administrador do Microsoft Entra para sua instância do Banco de Dados do Azure para MySQL. Para obter mais informações, consulte a seção Configurar o Microsoft Entra Admin de Configurar a autenticação do Microsoft Entra para o Banco de Dados do Azure para MySQL - Servidor Flexível.

Crie um script SQL chamado create_ad_user.sql para criar um usuário não administrador. Adicione o seguinte conteúdo e salve-o localmente:

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

Em seguida, use o seguinte comando para executar o script SQL para criar o usuário não administrador do Microsoft Entra:

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

Gorjeta

Para usar a autenticação do Microsoft Entra para se conectar ao Banco de Dados do Azure para MySQL, você precisa entrar com o usuário administrador do Microsoft Entra configurado e, em seguida, obter o token de acesso como senha. Para obter mais informações, consulte Configurar a autenticação do Microsoft Entra para o Banco de Dados do Azure para MySQL - Servidor Flexível.

Palavra-passe

Crie um script SQL chamado create_user.sql para criar um usuário não administrador. Adicione o seguinte conteúdo e salve-o localmente:

cat << EOF > create_user.sql
CREATE USER '<your_mysql_non_admin_username>'@'%' IDENTIFIED BY '<your_mysql_non_admin_password>';
GRANT ALL PRIVILEGES ON demo.* TO '<your_mysql_non_admin_username>'@'%';
FLUSH PRIVILEGES;
EOF

Em seguida, use o seguinte comando para executar o script SQL para criar o usuário não administrador:

mysql -h mysqlflexibletest.mysql.database.azure.com --user <your_mysql_admin_username> --enable-cleartext-plugin --password=<your_mysql_admin_password> < create_user.sql

Gorjeta

Você pode ler informações mais detalhadas sobre como criar usuários do MySQL em Criar usuários no Banco de Dados do Azure para MySQL.

Armazenar dados do Banco de Dados do Azure para MySQL

Agora que você tem uma instância de servidor flexível do Banco de Dados do Azure para MySQL, pode armazenar dados usando o Spring Cloud Azure.

Para instalar o módulo Spring Cloud Azure Starter JDBC MySQL, adicione as seguintes dependências ao seu arquivo pom.xml :

• A lista de materiais (BOM) do Azure 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

  Se estiver a utilizar o Spring Boot 2.x, certifique-se de que define a spring-cloud-azure-dependencies versão como 4.19.0. Esta lista de materiais (BOM) deve ser configurada na <dependencyManagement> seção do seu arquivo de pom.xml . Isso garante que todas as dependências do Spring Cloud Azure estejam usando a mesma versão. Para obter mais informações sobre a versão usada para essa lista técnica, consulte Qual versão do Spring Cloud Azure devo usar.

• O artefato Spring Cloud Azure Starter JDBC MySQL:

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

Nota

Conexões sem senha são suportadas desde a versão 4.5.0.

Configurar o Spring Boot para utilizar a Base de Dados do Azure para MySQL

Para armazenar dados do Banco de Dados do Azure para MySQL usando o Spring Data JDBC, siga estas etapas para configurar o aplicativo:

1. Configure o Banco de Dados do Azure para credenciais MySQL adicionando as seguintes propriedades ao seu arquivo de configuração application.properties .

   Sem senha (recomendado)

   logging.level.org.springframework.jdbc.core=DEBUG
   
   spring.datasource.url=jdbc:mysql://mysqlflexibletest.mysql.database.azure.com:3306/demo?serverTimezone=UTC
   spring.datasource.username=<your_mysql_ad_non_admin_username>
   spring.datasource.azure.passwordless-enabled=true
   
   spring.sql.init.mode=always
   

   Palavra-passe

   logging.level.org.springframework.jdbc.core=DEBUG
   
   spring.datasource.url=jdbc:mysql://mysqlflexibletest.mysql.database.azure.com:3306/demo?serverTimezone=UTC
   spring.datasource.username=<your_mysql_non_admin_username>
   spring.datasource.password=<your_mysql_non_admin_password>
   
   spring.sql.init.mode=always
   

   Aviso

   A propriedade spring.sql.init.mode=always configuration significa que o Spring Boot gerará automaticamente um esquema de banco de dados, usando o arquivo schema.sql que você criará em seguida, sempre que o servidor for iniciado. Esse recurso é ótimo para testes, mas lembre-se de que ele excluirá seus dados a cada reinicialização, portanto, você não deve usá-lo na produção.

   A propriedade spring.datasource.url configuration foi ?serverTimezone=UTC acrescentada para informar ao driver JDBC para usar o formato de data UTC (ou Tempo Universal Coordenado) ao se conectar ao banco de dados. Sem esse parâmetro, seu servidor Java não usaria o mesmo formato de data do banco de dados, o que resultaria em um erro.

• Se você não tiver uma, crie um Banco de Dados do Azure para MySQL Instância única do servidor chamada mysqlsingletest. Para obter instruções, consulte Guia de início rápido: criar um banco de dados do Azure para o servidor MySQL usando o portal do Azure. Em seguida, crie um banco de dados chamado demo. Para obter instruções, consulte a seção Criar um banco de dados de Criar usuários no Banco de Dados do Azure para MySQL.

Veja o aplicativo de exemplo

Neste artigo, você codificará um aplicativo de exemplo. Se você quiser ir mais rápido, este aplicativo já está codificado e disponível em https://github.com/Azure-Samples/quickstart-spring-data-jdbc-mysql.

Configurar uma regra de firewall para o servidor MySQL

As instâncias do Banco de Dados do Azure para MySQL são protegidas por padrão. O serviço tem uma firewall que não permite ligações de entrada.

Para poder usar seu banco de dados, abra o firewall do servidor para permitir que o endereço IP local acesse o servidor de banco de dados. Para obter mais informações, consulte Criar e gerenciar o Banco de Dados do Azure para regras de firewall do MySQL usando o portal do Azure.

Se você estiver se conectando ao seu servidor MySQL a partir do Windows Subsystem for Linux (WSL) em um computador Windows, você precisará adicionar o endereço IP do host WSL ao seu firewall.

Crie um usuário não-administrador do MySQL e conceda permissão

Esta etapa criará um usuário não administrador e concederá todas as permissões no demo banco de dados a ele.

Sem senha (recomendado)

Importante

Para usar conexões sem senha, crie um usuário administrador do Microsoft Entra para sua instância do Banco de Dados do Azure para MySQL. Para obter mais informações, consulte a seção Definindo o usuário administrador do Microsoft Entra em Usar o Microsoft Entra ID para autenticação com MySQL.

Crie um script SQL chamado create_ad_user.sql para criar um usuário não administrador. Adicione o seguinte conteúdo e salve-o localmente:

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

Em seguida, use o seguinte comando para executar o script SQL para criar o usuário não administrador do Microsoft Entra:

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

Gorjeta

Para usar a autenticação do Microsoft Entra para se conectar ao Banco de Dados do Azure para MySQL, você precisa entrar com o usuário administrador do Microsoft Entra configurado e, em seguida, obter o token de acesso como senha. Para obter mais informações, consulte Usar o Microsoft Entra ID para autenticação com MySQL.

Palavra-passe

Crie um script SQL chamado create_user.sql para criar um usuário não administrador. Adicione o seguinte conteúdo e salve-o localmente:

cat << EOF > create_user.sql
CREATE USER '<your_mysql_non_admin_username>'@'%' IDENTIFIED BY '<your_mysql_non_admin_password>';
GRANT ALL PRIVILEGES ON demo.* TO '<your_mysql_non_admin_username>'@'%';
FLUSH PRIVILEGES;
EOF

Em seguida, use o seguinte comando para executar o script SQL para criar o usuário não administrador:

mysql -h mysqlsingletest.mysql.database.azure.com --user <your_mysql_admin_username>@mysqlsingletest --enable-cleartext-plugin --password=<your_mysql_admin_password> < create_user.sql

Nota

Para obter mais informações, veja Criar utilizadores na Base de Dados do Azure para MySQL.

Armazenar dados do Banco de Dados do Azure para MySQL

Agora que você tem um Banco de Dados do Azure para instância do Servidor Único MySQL, pode armazenar dados usando o Spring Cloud Azure.

Para instalar o módulo Spring Cloud Azure Starter JDBC MySQL, adicione as seguintes dependências ao seu arquivo pom.xml :

• A lista de materiais (BOM) do Azure 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

  Se estiver a utilizar o Spring Boot 2.x, certifique-se de que define a spring-cloud-azure-dependencies versão como 4.19.0. Esta lista de materiais (BOM) deve ser configurada na <dependencyManagement> seção do seu arquivo de pom.xml . Isso garante que todas as dependências do Spring Cloud Azure estejam usando a mesma versão. Para obter mais informações sobre a versão usada para essa lista técnica, consulte Qual versão do Spring Cloud Azure devo usar.

• O artefato Spring Cloud Azure Starter JDBC MySQL:

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

Nota

Conexões sem senha são suportadas desde a versão 4.5.0.

Configurar o Spring Boot para utilizar a Base de Dados do Azure para MySQL

Para armazenar dados do Banco de Dados do Azure para MySQL usando o Spring Data JDBC, siga estas etapas para configurar o aplicativo:

1. Configure o Banco de Dados do Azure para credenciais MySQL adicionando as seguintes propriedades ao seu arquivo de configuração application.properties .

   Sem senha (recomendado)

   logging.level.org.springframework.jdbc.core=DEBUG
   
   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.datasource.azure.passwordless-enabled=true
   
   spring.sql.init.mode=always
   

   Palavra-passe

   logging.level.org.springframework.jdbc.core=DEBUG
   
   spring.datasource.url=jdbc:mysql://mysqlsingletest.mysql.database.azure.com:3306/demo?serverTimezone=UTC
   spring.datasource.username=<your_mysql_non_admin_username>@mysqlsingletest
   spring.datasource.password=<your_mysql_non_admin_password>
   
   spring.sql.init.mode=always
   

   Aviso

   A propriedade spring.sql.init.mode=always configuration significa que o Spring Boot gerará automaticamente um esquema de banco de dados, usando o arquivo schema.sql que você criará em seguida, sempre que o servidor for iniciado. Esse recurso é ótimo para testes, mas lembre-se de que ele excluirá seus dados a cada reinicialização, portanto, você não deve usá-lo na produção.

   A propriedade spring.datasource.url configuration foi ?serverTimezone=UTC acrescentada para informar ao driver JDBC para usar o formato de data UTC (ou Tempo Universal Coordenado) ao se conectar ao banco de dados. Sem esse parâmetro, seu servidor Java não usaria o mesmo formato de data do banco de dados, o que resultaria em um erro.

2. Crie o arquivo de configuração src/main/resources/schema.sql para configurar o esquema do banco de dados e adicione o seguinte conteúdo.

   DROP TABLE IF EXISTS todo;
   CREATE TABLE todo (id SERIAL PRIMARY KEY, description VARCHAR(255), details VARCHAR(4096), done BOOLEAN);
   

3. Crie uma nova Todo classe Java. Esta classe é um modelo de domínio mapeado todo na tabela que será criado automaticamente pelo Spring Boot. O código a seguir ignora os getters métodos e setters .

   import org.springframework.data.annotation.Id;
   
   public class Todo {
   
       public Todo() {
       }
   
       public Todo(String description, String details, boolean done) {
           this.description = description;
           this.details = details;
           this.done = done;
       }
   
       @Id
       private Long id;
   
       private String description;
   
       private String details;
   
       private boolean done;
   
   }
   

4. Edite o arquivo de classe de inicialização para mostrar o seguinte conteúdo.

   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.repository.CrudRepository;
   
   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)).toList())
               .forEach(System.out::println);
       }
   
   }
   
   interface TodoRepository extends CrudRepository<Todo, Long> {
   
   }
   

   Gorjeta

   Neste tutorial, não há operações de autenticação nas configurações ou no código. No entanto, conectar-se aos serviços do Azure requer autenticação. Para concluir a autenticação, você precisa usar a Identidade do Azure. O Spring Cloud Azure usa DefaultAzureCredentialo , que a biblioteca de Identidades do Azure fornece para ajudá-lo a obter credenciais sem alterações de código.

   DefaultAzureCredential Suporta vários métodos de autenticação e determina qual método usar em tempo de execução. Essa abordagem permite que seu aplicativo use diferentes métodos de autenticação em ambientes diferentes (como ambientes locais e de produção) sem implementar código específico do ambiente. Para obter mais informações, consulte DefaultAzureCredential.

   Para concluir a autenticação em ambientes de desenvolvimento local, você pode usar a CLI do Azure, o Visual Studio Code, o PowerShell ou outros métodos. Para obter mais informações, consulte Autenticação do Azure em ambientes de desenvolvimento Java. Para concluir a autenticação em ambientes de hospedagem do Azure, recomendamos o uso da identidade gerenciada atribuída pelo usuário. Para obter mais informações, consulte O que são identidades gerenciadas para recursos do Azure?

5. Inicie a aplicação. O aplicativo armazena dados no banco de dados. Você verá logs semelhantes ao exemplo a seguir:

   2023-02-01 10:22:36.701 DEBUG 7948 --- [main] o.s.jdbc.core.JdbcTemplate : Executing prepared SQL statement [INSERT INTO todo (description, details, done) VALUES (?, ?, ?)]    
   com.example.demo.Todo@4bdb04c8
   

Implantar no Azure Spring Apps

Agora que você tem o aplicativo Spring Boot em execução localmente, é hora de movê-lo para a produção. O Azure Spring Apps facilita a implantação de aplicativos Spring Boot no Azure sem alterações de código. O serviço gerencia a infraestrutura dos aplicativos Spring para que os desenvolvedores possam se concentrar em seu código. O Azure Spring Apps fornece gerenciamento do ciclo de vida usando monitoramento e diagnóstico abrangentes, gerenciamento de configuração, descoberta de serviços, integração de CI/CD, implantações azul-verde e muito mais. Para implantar seu aplicativo no Azure Spring Apps, consulte Implantar seu primeiro aplicativo no Azure Spring Apps.

Próximos passos

Azure para desenvolvedoresSpring Cloud Azure MySQL Exemplos