O que é o Spring Cloud Azure?

Artigo
01/31/2025

O Spring Cloud Azure é um projeto de software livre que ajuda a facilitar o uso de serviços do Azure em aplicativos Spring.

O Spring Cloud Azure é um projeto de software livre, com todos os recursos disponíveis para o público. A lista a seguir fornece links para esses recursos:

Código-fonte: Azure/azure-sdk-for-java.
Exemplos de códigos: Azure-Samples/azure-spring-boot-samples.
Documentação: Spring Cloud Azure.

Para que o Spring Cloud Azure é usado?

O Azure do Spring Cloud pode ajudar a facilitar a realização das seguintes tarefas em aplicativos Spring:

Gerenciando propriedades de configuração com a Configuração de Aplicativos do Azure.
Enviando e recebendo mensagens com Azure Event Hubs, Azure Service Buse Azure Storage Queue.
Gerenciando segredos e certificados com o Azure Key Vault .
Suporte à entrada do usuário com contas corporativas ou de estudante provisionadas com o Microsoft Entra ID.
Suporte para autenticação de usuários com contas sociais como Facebook e Google, utilizando o Azure Active Directory B2C .
Protegendo suas APIs Web e acessando as APIs protegidas, como o Microsoft Graph, para trabalhar com os dados dos usuários e da organização com o Microsoft Entra ID e o Azure Active Directory B2C.
Armazenando dados estruturados com o Azure Cosmos DB.
Armazenando dados não estruturados, como texto ou dados binários, com o Armazenamento de Blobs do Azure .
Armazenando arquivos com Arquivos do Azure.

Benefícios de usar o Spring Cloud Azure

A seção a seguir demonstra os benefícios de usar o Spring Cloud Azure. Nesta seção, a recuperação de segredos armazenados no Azure Key Vault é usada como exemplo. Esta seção compara as diferenças entre o desenvolvimento de um aplicativo Spring Boot com e sem o Spring Cloud Azure.

Sem o Spring Cloud Azure

Sem o Spring Cloud Azure, se você quiser recuperar segredos armazenados no Azure Key Vault, precisará das seguintes etapas:

Adicione as seguintes dependências ao arquivo pom.xml:

<dependency>
   <groupId>com.azure</groupId>
   <artifactId>azure-security-keyvault-secrets</artifactId>
   <version>4.5.2</version>
</dependency>

Construa uma instância de classe SecretClient usando um código semelhante ao seguinte exemplo:

public class DemoClass {
    public static void main(String... args) {
    SecretClient client = new SecretClientBuilder()
        .vaultUrl("vaultUrl")
        .credential(new ClientSecretCredentialBuilder()
            .tenantId("tenantId")
            .clientId("clientId")
            .clientSecret("clientSecret")
            .build())
        .buildClient();
    }
}

Evite informações de codificação rígida, como client-id e client-secret, tornando essas propriedades configuráveis, conforme mostrado no exemplo a seguir:

@ConfigurationProperties("azure.keyvault")
public class KeyVaultProperties {
    private String vaultUrl;
    private String tenantId;
    private String clientId;
    private String clientSecret;

    public KeyVaultProperties(String vaultUrl, String tenantId, String clientId, String clientSecret) {
        this.vaultUrl = vaultUrl;
        this.tenantId = tenantId;
        this.clientId = clientId;
        this.clientSecret = clientSecret;
    }

    public String getVaultUrl() {
        return vaultUrl;
    }

    public void setVaultUrl(String vaultUrl) {
        this.vaultUrl = vaultUrl;
    }

    public String getTenantId() {
        return tenantId;
    }

    public void setTenantId(String tenantId) {
        this.tenantId = tenantId;
    }

    public String getClientId() {
        return clientId;
    }

    public void setClientId(String clientId) {
        this.clientId = clientId;
    }

    public String getClientSecret() {
        return clientSecret;
    }

    public void setClientSecret(String clientSecret) {
        this.clientSecret = clientSecret;
    }
}

Atualize o código do aplicativo, conforme mostrado neste exemplo:

@SpringBootApplication
@EnableConfigurationProperties(KeyVaultProperties.class)
public class SecretClientApplication implements CommandLineRunner {
    private KeyVaultProperties properties;

    public SecretClientApplication(KeyVaultProperties properties) {
        this.properties = properties;
    }

    public static void main(String[] args) {
        SpringApplication.run(SecretClientApplication.class, args);
    }

    @Override
    public void run(String... args) {
        SecretClient client = new SecretClientBuilder()
            .vaultUrl(properties.getVaultUrl())
            .credential(new ClientSecretCredentialBuilder()
                .tenantId(properties.getTenantId())
                .clientId(properties.getClientId())
                .clientSecret(properties.getClientSecret())
                .build())
            .buildClient();
        System.out.println("sampleProperty: " + client.getSecret("sampleProperty").getValue());
    }
}

Adicione as propriedades necessárias ao arquivo application.yml, conforme mostrado no exemplo a seguir:
```
azure:
  keyvault:
    vault-url:
    tenant-id:
    client-id:
    client-secret:
```
Se você precisar usar SecretClient em vários lugares, defina um SecretClient bean. Em seguida, conecte automaticamente SecretClient aos locais relevantes.

Com o Spring Cloud Azure

Com o Spring Cloud Azure, se você quiser recuperar segredos armazenados no Azure Key Vault, os requisitos serão mais simples, conforme mostrado nas seguintes etapas:

Adicione as seguintes dependências ao arquivo pom.xml:

<dependencies>
  <dependency>
    <groupId>com.azure.spring</groupId>
    <artifactId>spring-cloud-azure-starter-keyvault-secrets</artifactId>
  </dependency>
</dependencies>

Use uma fatura de materiais (BOM) para gerenciar a versão do Spring Cloud Azure, conforme mostrado no exemplo a seguir:
```
<dependencyManagement>
  <dependencies>
    <dependency>
      <groupId>com.azure.spring</groupId>
      <artifactId>spring-cloud-azure-dependencies</artifactId>
      <version>5.20.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>
```
Nota

Se você estiver usando o Spring Boot 2.x, defina a versão spring-cloud-azure-dependencies como 4.19.0. Essa Nota de Material (BOM) deve ser configurada na seção <dependencyManagement> do arquivo 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 este BOM, consulte qual versão do Spring Cloud Azure devo usar.

Adicione as seguintes propriedades ao arquivo application.yml:

spring:
  cloud:
    azure:
      keyvault:
        secret:
          endpoint:

Entre com a CLI do Azure usando o comando a seguir. Suas credenciais serão fornecidas pela CLI do Azure, portanto, não será necessário adicionar outras informações de credencial, como client-id e client-secret.
```
az login
```

Conecte automaticamente o SecretClient aos locais relevantes, conforme mostrado no exemplo a seguir:

@SpringBootApplication
public class SecretClientApplication implements CommandLineRunner {

    private final SecretClient secretClient;

    public SecretClientApplication(SecretClient secretClient) {
        this.secretClient = secretClient;
    }

    public static void main(String[] args) {
        SpringApplication.run(SecretClientApplication.class, args);
    }

    @Override
    public void run(String... args) {
        System.out.println("sampleProperty: " + secretClient.getSecret("sampleProperty").getValue());
    }
}

O Spring Cloud Azure fornecerá alguns outros recursos além do SecretClientconfigurado automaticamente. Por exemplo, você pode usar @Value para obter o valor do segredo, conforme mostrado no exemplo a seguir:

@SpringBootApplication
public class PropertySourceApplication implements CommandLineRunner {

    @Value("${sampleProperty1}")
    private String sampleProperty1;

    public static void main(String[] args) {
        SpringApplication.run(PropertySourceApplication.class, args);
    }

    public void run(String[] args) {
        System.out.println("sampleProperty1: " + sampleProperty1);
    }

}

Componentes do Spring Cloud Azure

Suporte do Azure

Fornece suporte de configuração automática para os serviços do Azure, como Service Bus, Armazenamento, Active Directory e assim por diante.

Microsoft Entra ID

Fornece suporte de integração para o Spring Security com a ID do Microsoft Entra para autenticação. Para obter mais informações, consulte Suporte do Spring Cloud Azure para Spring Security.

Azure Key Vault

Fornece suporte à anotação @Value Spring para integração com os Segredos do Azure Key Vault. Para obter mais informações, consulte Gerenciamento de segredos do Spring Cloud Azure.

Armazenamento do Azure

Fornece suporte do Spring Boot para serviços de Armazenamento do Azure. Para obter mais informações, consulte Tratamento de recursos do Spring Cloud Azure.

Obter suporte

Se você precisar de suporte para o Spring Cloud Azure, poderá pedir ajuda das seguintes maneiras:

Crie tíquetes de suporte do Azure. Os clientes com um plano de suporte do Azure podem abrir um tíquete de suporte do Azure. Recomendamos essa opção se o problema exigir atenção imediata.
Registrar problemas no GitHub no repositório Azure/azure-sdk-for-java . Usamos os problemas do GitHub para rastrear bugs, perguntas e solicitações de recurso. As issues do GitHub são gratuitas, mas o tempo de resposta não é garantido. Para obter mais informações, consulte processo de suporte para problemas do GitHub.

Compartilhar via