Guia do desenvolvedor do Spring Cloud Azure

O Spring Cloud Azure integra aplicativos Spring Boot com serviços de Azure. Este guia do desenvolvedor explica como gerenciar dependências, escolher iniciantes e usar exemplos para acelerar Java desenvolvimento de aplicativos.

Para obter mais informações sobre versões com suporte, consulte Spring Versions Mapping.

Obter ajuda

Se você tiver dúvidas sobre esta documentação, crie uma issue no GitHub em um dos seguintes repositórios do GitHub. Solicitações de pull também são bem-vindas.

repositórios GitHub	Descrição
Azure/azure-sdk-for-java	Esse repositório contém o código-fonte.
Azure-Samples/azure-spring-boot-samples	Esse repositório contém os exemplos relacionados.
MicrosoftDocs/azure-dev-docs	Esse repositório contém a documentação.

Primeiros passos

Configurando dependências

Lista de materiais (BOM)

Se você usar o Maven, adicione o BOM ao arquivo pom.xml na seção dependencyManagement, conforme mostrado no exemplo a seguir. Ao usar o BOM, você não precisa especificar versões para nenhuma das dependências do Maven porque o BOM manipula o controle de versão.

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

Com o Gradle, você pode importar o BOM spring-cloud-azure-dependencies das seguintes maneiras:

• Use o suporte nativo do Gradle a BOM adicionando as dependências, conforme mostrado no exemplo a seguir.

  import org.springframework.boot.gradle.plugin.SpringBootPlugin
  
  plugins {
    id("java")
    id("org.springframework.boot") version "4.0.1"
  }
  
  dependencies {
      implementation(platform(SpringBootPlugin.BOM_COORDINATES))
      implementation(platform("com.azure.spring:spring-cloud-azure-dependencies:{version}"))
  }
  

• Use o io.spring.dependency-management plugin e importe o BOM em dependencyManagement, conforme mostrado no exemplo a seguir.

  plugins {
      id("io.spring.dependency-management") version "1.1.7"
  }
  
  dependencyManagement {
      imports {
          mavenBom("com.azure.spring:spring-cloud-azure-dependencies:{version}")
      }
  }
  

Para obter mais informações, consulte Guia de Referência do Plug-in do Spring Boot Gradle.

Nota

Se você estiver usando o Spring Boot 4.0.x, defina a spring-cloud-azure-dependencies versão como 7.4.0.

Se você estiver usando o Spring Boot 3.5.x, defina a spring-cloud-azure-dependencies versão como 6.5.0.

Se você estiver usando o Spring Boot 3.1.x-3.5.x, defina a spring-cloud-azure-dependencies versão como 5.25.0.

Se você estiver usando o Spring Boot 2.x, certifique-se de definir a spring-cloud-azure-dependencies versão como 4.20.0.

Esta lista de materiais (BOM) deve ser configurada na <dependencyManagement> seção do arquivo pom.xml. Isso garante que todas as dependências de Azure do Spring Cloud estejam usando a mesma versão.

Para obter mais informações sobre a versão usada para este BOM, consulte Which Version of Spring Cloud Azure Should I Use.

Dependências iniciais

O Spring Cloud Azure Starters é um conjunto de descritores de dependência convenientes a serem incluídos em seu aplicativo. Cada starter contém todas as dependências e dependências transitivas necessárias para começar a usar o módulo correspondente do Spring Cloud Azure. Esses starters impulsionam o desenvolvimento de aplicativos Spring Boot com os serviços do Azure.

Por exemplo, se você quiser começar a usar o Spring e Azure Cosmos DB para persistência de dados, inclua a dependência spring-cloud-azure-starter-cosmos em seu projeto.

A tabela a seguir lista os iniciadores de aplicativos fornecidos pelo Spring Cloud Azure no grupo com.azure.spring:

Nome	Descrição
spring-cloud-azure-starter	O starter principal, incluindo suporte à autoconfiguração.
spring-cloud-azure-starter-active-directory	O inicializador para usar o Microsoft Entra ID com o Spring Security.
spring-cloud-azure-starter-active-directory-b2c	O início para usar Azure Active Directory B2C com o Spring Security.
spring-cloud-azure-starter-appconfiguration	Guia inicial para usar o Configuração de Aplicativos do Azure.
spring-cloud-azure-starter-appconfiguration-config	O modelo inicial para usar Configuração de Aplicativos do Azure Config.
spring-cloud-azure-starter-cosmos	Guia de introdução ao Azure Cosmos DB.
spring-cloud-azure-starter-eventhubs	Introdução ao uso do Hubs de Eventos do Azure.
spring-cloud-azure-starter-eventgrid	Introdução ao uso do Grade de Eventos do Azure.
spring-cloud-azure-starter-keyvault	Introdução ao uso do Azure Key Vault.
spring-cloud-azure-starter-keyvault-secrets	Introdução ao uso do Azure Key Vault Secrets.
spring-cloud-azure-starter-keyvault-jca	O início para usar Azure Key Vault JCA.
spring-cloud-azure-starter-keyvault-certificates	Introdução ao uso dos certificados do Azure Key Vault.
spring-cloud-azure-starter-servicebus	O guia introdutório para usar o Barramento de Serviço do Azure.
spring-cloud-azure-starter-servicebus-jms	O inicializador para uso do Barramento de Serviço do Azure e JMS.
spring-cloud-azure-starter-storage	Primeiros passos com o Armazenamento do Azure.
spring-cloud-azure-starter-storage-blob	Introdução ao uso do Armazenamento do Azure Blob.
spring-cloud-azure-starter-storage-file-share	Introdução ao uso do Compartilhamento de Arquivos do Armazenamento do Azure.
spring-cloud-azure-starter-storage-queue	Introdução ao uso da Fila do Armazenamento do Azure.
spring-cloud-azure-starter-actuator	O início para usar o Actuator do Spring Boot, que fornece recursos prontos para produção.

A tabela a seguir lista os iniciantes para o suporte ao Spring Data:

Nome	Descrição
spring-cloud-azure-starter-data-cosmos	O início para usar o Spring Data para Azure Cosmos DB.

A tabela a seguir lista os iniciantes para o suporte do Spring Data Redis:

Nome	Descrição
spring-cloud-azure-starter-data-redis-lettuce	O starter para usar Spring Data e Cache do Azure para Redis com Lettuce.

A tabela a seguir lista os starters para oferecer suporte ao Spring Integration:

Nome	Descrição
spring-cloud-azure-starter-integration-eventhubs	O início para usar o Hubs de Eventos do Azure e o Spring Integration.
spring-cloud-azure-starter-integration-servicebus	O início para usar o Barramento de Serviço do Azure e o Spring Integration.
spring-cloud-azure-starter-integration-storage-queue	O início para usar Armazenamento do Azure Queue e Spring Integration.

A tabela a seguir lista os iniciantes para o suporte ao Spring Cloud Stream:

Nome	Descrição
spring-cloud-azure-starter-stream-eventhubs	O início para usar o Hubs de Eventos do Azure e o Spring Cloud Stream Binder.
spring-cloud-azure-starter-stream-servicebus	O starter para uso do Barramento de Serviço do Azure e do Spring Cloud Stream Binder.

A tabela a seguir lista os iniciantes para suporte ao MySQL:

Nome	Descrição
spring-cloud-azure-starter-jdbc-mysql	Introdução ao uso do Azure Database for MySQL e do JDBC com autenticação do Microsoft Entra.

A tabela a seguir lista os iniciantes para suporte ao PostgreSQL:

Nome	Descrição
spring-cloud-azure-starter-jdbc-postgresql	Introdução ao uso de PostgreSQL no Azure e JDBC com autenticação do Microsoft Entra.

Aprendendo Spring Cloud Azure

Para obter uma lista completa de exemplos que mostram o uso, consulte Spring Cloud Azure Samples.

Novidades na versão 4.0 desde 3.10.x

Esta documentação aborda as alterações feitas na 4.0 desde 3.10. Esta versão principal traz melhor segurança, dependências mais enxutas, suporte para preparação para produção e muito mais.

Dica

Para obter mais informações sobre como migrar para a 4.0, consulte Guia de Migração para 4.0.

A lista a seguir resume algumas das alterações que o Spring Cloud Azure 4.0 fornece:

• Uma experiência de desenvolvimento unificada, com nome de projeto unificado, ID de artefato e propriedades.
• Gerenciamento simplificado de dependência usando um único spring-cloud-azure-dependencies BOM.
• Suporte expandido do Azure no Spring Initializr para incluir Kafka, Event Hubs, Cache do Azure para Redis e Configuração de Aplicativos do Azure.
• Rearquitetamos as dependências do módulo Spring para remover camadas excessivas e acoplamento.
• Suporte à Identidade Gerenciada para Configuração de Aplicativos do Azure, Hubs de Eventos, Barramento de Serviço, Azure Cosmos DB, Key Vault, Blob de Armazenamento e Fila de Armazenamento.
• Suporte contínuo, em nossas bibliotecas Spring, aos métodos de autenticação do SDK do Azure subjacente, como token SAS e autenticação com credencial de token no Barramento de Serviço e no Event Hubs.
• A cadeia de credenciais agora está habilitada por padrão, permitindo que os aplicativos obtenham credenciais de propriedades do aplicativo, variáveis de ambiente, identidade gerenciada, IDEs e assim por diante. Para obter mais informações, consulte a seção DefaultAzureCredential da biblioteca de clientes Azure Identity para Java.
• Controle de acesso granular no nível do recurso (como fila do Barramento de Serviço) para permitir melhor governança de segurança e adesão às políticas de TI.
• Mais opções expostas de forma idiomática ao Spring, por meio de maior cobertura de autoconfiguração dos clientes do SDK do Azure, tanto para cenários síncronos quanto assíncronos.
• Foram adicionados indicadores de integridade para Configuração de Aplicativos do Azure, Hubs de Eventos, Azure Cosmos DB, Key Vault, Blob de Armazenamento, Fila de Armazenamento e Arquivo de Armazenamento.
• Suporte ao Spring Cloud Sleuth para todos os SDKs do Azure baseados em HTTP.