Guia do desenvolvedor do Spring Cloud Azure

O Spring é uma estrutura de aplicativos de software livre desenvolvida pelo VMware que fornece uma abordagem modular simplificada para criar aplicativos Java. O Spring Cloud Azure é um projeto de software livre que fornece integração perfeita do Spring com Azure.

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

Obter ajuda

Se você tiver dúvidas sobre essa documentação, crie um GitHub problema em um dos repositórios de GitHub a seguir. 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.

Introdução

Configurando dependências

Cobrança 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 controle de versão é delegado ao BOM.

<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure.spring</groupId>
      <artifactId>spring-cloud-azure-dependencies</artifactId>
      <version>7.0.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 bom nativo do Gradle adicionando 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 plug-in io.spring.dependency-management 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.0.0.

Se você estiver usando o Spring Boot 3.5.x, defina a spring-cloud-azure-dependencies versão como 6.1.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 de inicialização

O Spring Cloud Azure Starters é um conjunto de descritores de dependência convenientes a serem incluídos em seu aplicativo. Cada iniciador contém todas as dependências e dependências transitivas necessárias para começar a usar o módulo de Azure do Spring Cloud correspondente. Esses iniciados impulsionam o desenvolvimento de aplicativos spring boot com serviços de 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 início principal, incluindo o suporte à configuração automática.
spring-cloud-azure-starter-active-directory	O início para usar 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	O início para usar Azure App Configuration.
spring-cloud-azure-starter-appconfiguration-config	O início para usar Azure App Configuration Config.
spring-cloud-azure-starter-cosmos	O início para usar Azure Cosmos DB.
spring-cloud-azure-starter-eventhubs	O início para usar Azure Event Hubs.
spring-cloud-azure-starter-eventgrid	O início para usar Azure Event Grid.
spring-cloud-azure-starter-keyvault	O início para usar Azure Key Vault.
spring-cloud-azure-starter-keyvault-secrets	O início para usar Azure Key Vault Segredos.
spring-cloud-azure-starter-keyvault-jca	O início para usar Azure Key Vault JCA.
spring-cloud-azure-starter-keyvault-certificates	O início para usar Azure Key Vault Certificados.
spring-cloud-azure-starter-servicebus	O início para usar Azure Service Bus.
spring-cloud-azure-starter-servicebus-jms	O início para usar Azure Service Bus e JMS.
spring-cloud-azure-starter-storage	O início para usar Azure Storage.
spring-cloud-azure-starter-storage-blob	O início para usar Azure Storage Blob.
spring-cloud-azure-starter-storage-file-share	O início para usar Azure Storage Compartilhamento de Arquivos.
spring-cloud-azure-starter-storage-queue	O início para usar Azure Storage Fila.
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 início para usar o Spring Data e Azure Cache for Redis com Alface.

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

Nome	Descrição
spring-cloud-azure-starter-integration-eventhubs	O início para usar o Azure Event Hubs e o Spring Integration.
spring-cloud-azure-starter-integration-servicebus	O início para usar o Azure Service Bus e o Spring Integration.
spring-cloud-azure-starter-integration-storage-queue	O início para usar Azure Storage 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 Azure Event Hubs e o Spring Cloud Stream Binder.
spring-cloud-azure-starter-stream-servicebus	O início para usar o Azure Service Bus e o Spring Cloud Stream Binder.

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

Nome	Descrição
spring-cloud-azure-starter-jdbc-mysql	O início para usar Azure MySQLs e JDBC por meio da autenticação Microsoft Entra.

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

Nome	Descrição
spring-cloud-azure-starter-jdbc-postgresql	O início para usar Azure PostgreSQL e JDBC por meio da autenticação Microsoft Entra.

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

Ponta

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.
• O Azure support expandido em Spring Initializr para abranger Kafka, Hubs de Eventos, Azure Cache for Redis e Azure App Configuration.
• Dependências do módulo Spring rearquitecadas para remover camadas em excesso e emaranhamento.
• Suporte à Identidade Gerenciada para Azure App Configuration, Hubs de Eventos, Service Bus, Azure Cosmos DB, Key Vault, Blob de Armazenamento e Fila de Armazenamento.
• Suporte contínuo para métodos de autenticação no Azure SDK subjacente de nossas bibliotecas spring, como token SAS e autenticação de credenciais de token com Service Bus e Hubs de Eventos.
• 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 Service Bus fila) para habilitar uma melhor governança de segurança e a adesão às políticas de TI.
• Mais opções expostas de uma maneira spring-idiomatica por meio de uma cobertura de configuração automática aprimorada de Azure SDK clientes para cenários síncronos e assíncronos.
• Foram adicionados indicadores de integridade para Azure App Configuration, 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 Azure SDKs baseados em HTTP.