Spring Cloud Azure

什么是 Spring Cloud Azure？

Spring Cloud Azure 是一个开源项目，它使用 Spring 应用程序开发固有的传统表达式和配置，在您的 Spring 应用程序和 Azure 服务之间提供集成。

Spring Cloud Azure 有什么用？

Spring Cloud Azure 可以帮助简化 Spring 应用程序中完成以下任务

使用 Azure 应用配置管理配置属性。
使用 Azure 事件中心、Azure 服务总线和 Azure 存储队列发送和接收消息。
使用 Azure Key Vault 管理机密和证书。
支持使用 Azure Active Directory 预配的工作或学校帐户进行用户登录。
支持使用 Azure Active Directory B2C 进行社交帐户（如 Facebook 和 Google）的用户登录。
使用 Azure Active Directory 和 Azure Active Directory B2C 保护您的 Web API 并访问受保护的 API（如 Microsoft Graph），以处理用户和组织的数据。
使用 Azure Cosmos DB 存储结构化数据。
使用 Azure Blob 存储存储非结构化数据，如文本或二进制数据。
使用 Azure 文件存储文件。

以下图表概述了这些功能： Spring Cloud azure

使用 Spring Cloud Azure 的好处

以下部分演示了使用 Spring Cloud Azure 的好处。在本节中，检索存储在 Azure Key Vault 中的机密作为示例。本节比较了使用和不使用 Spring Cloud Azure 开发 Spring Boot 应用程序之间的差异。

不使用 Spring Cloud Azure

如果不使用 Spring Cloud Azure，如果您想检索存储在 Azure Key Vault 中的机密，您需要执行以下步骤

将以下依赖项添加到您的 pom.xml 文件中

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

使用类似于以下示例的代码构造一个 SecretClient 类实例

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();
    }
}

通过使这些属性可配置来避免硬编码信息，例如 client-id 和 client-secret，如以下示例所示

@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;
    }
}

更新您的应用程序代码，如本示例所示

@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());
    }
}

将必要的属性添加到您的 application.yml 文件中，如以下示例所示

azure:
  keyvault:
    vault-url:
    tenant-id:
    client-id:
    client-secret:

如果您需要在多个地方使用 SecretClient，请定义一个 SecretClient bean。然后，在相关的地方自动注入 SecretClient。

使用 Spring Cloud Azure

使用 Spring Cloud Azure，如果您想检索存储在 Azure Key Vault 中的机密，要求会更简单，如以下步骤所示

将以下依赖项添加到您的 pom.xml 文件中

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

使用物料清单 (BOM) 管理 Spring Cloud Azure 版本，如以下示例所示

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

将以下属性添加到您的 application.yml 文件中

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

使用以下命令通过 Azure CLI 登录。您的凭据将由 Azure CLI 提供，因此无需添加其他凭据信息，例如 client-id 和 client-secret。
```
az login
```

在相关的地方自动注入 SecretClient，如以下示例所示

@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());
    }
}

Spring Cloud Azure 除了提供自动配置的 SecretClient 外，还将提供一些其他功能。例如，您可以使用 @Value 获取机密值，如以下示例所示

@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);
    }

}