O que é o Spring Cloud Azure?

Artigo
02/14/2024

O Spring Cloud Azure é um projeto de código aberto que ajuda a facilitar o uso dos serviços do Azure em aplicativos Spring .

O Spring Cloud Azure é um projeto de código aberto, 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: Azure-Samples/azure-spring-boot-samples.
Documentação: Spring Cloud Azure.

Para que é utilizado o Spring Cloud Azure?

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

Gerenciando propriedades de configuração com a Configuração de Aplicativo do Azure.
Enviar e receber mensagens com os Hubs de Eventos do Azure, o Barramento de Serviço do Azure e a Fila de Armazenamento do Azure.
Gerenciando segredos e certificados com o Cofre de Chaves do Azure.
Suporte à entrada de usuários com contas corporativas ou de estudante provisionadas com o Microsoft Entra ID.
Suporte ao login de usuários com contas sociais como Facebook e Google com o Azure Active Directory B2C.
Proteger suas APIs da Web e acessar APIs protegidas como o Microsoft Graph para trabalhar com os dados de seus 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.

O diagrama a seguir fornece uma visão geral desses recursos:

Diagrama que fornece uma visão geral dos recursos do Spring Cloud 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 Cofre de Chaves do Azure é 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 Cofre de Chaves do Azure, 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 SecretClient classe usando código semelhante ao exemplo a seguir:

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ígidas, 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, faça o auto-fio SecretClient nos locais relevantes.

Com o Spring Cloud Azure

Com o Spring Cloud Azure, se você quiser recuperar segredos armazenados no Cofre de Chaves do Azure, 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 lista 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.11.0</version>
      <type>pom</type>
      <scope>import</scope>
    </dependency>
  </dependencies>
</dependencyManagement>
```
Observação

Se você estiver usando o Spring Boot 2.x, certifique-se de definir a spring-cloud-azure-dependencies versão como 4.17.0. Esta lista de materiais (BOM) deve ser configurada <dependencyManagement> na seção 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 esta 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 haverá necessidade de adicionar outras informações de credencial, como client-id e client-secret.
```
az login
```

Ligação SecretClient automática nos locais relevantes, como 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 sistema de configuração SecretClientautomática. Por exemplo, você pode usar @Value para obter o valor secreto, 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 Serviços do Azure, como Barramento de Serviço, Armazenamento, Active Directory e assim por diante.

Microsoft Entra ID

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

Cofre de Chave do Azure

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

Armazenamento do Azure

Fornece suporte ao 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 precisar de suporte para o Spring Cloud Azure, você pode 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 esta opção se o seu problema exigir atenção imediata.
Problemas de arquivo do GitHub no repositório Azure/azure-sdk-for-java. Usamos problemas do GitHub para rastrear bugs, perguntas e solicitações de recursos. Os problemas do GitHub são gratuitos, mas o tempo de resposta não é garantido. Para obter mais informações, consulte Processo de suporte a problemas do GitHub.