，后者是一个 Web 托管平台，旨在在 Azure 上运行 Spring Apps。

Spring Cloud Azure 用途是什么？

Spring Cloud Azure 可以帮助在 Spring 应用程序中更轻松地完成以下任务

• 使用 Azure App Configuration 管理配置属性。
• 使用 Azure Event Hubs、Azure Service Bus 和 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 的好处。在本部分中，将使用存储在 Azure Key Vault 中的机密进行检索作为示例。本部分比较了使用 Spring Cloud Azure 和不使用 Spring Cloud Azure 开发 Spring Boot 应用程序之间的差异。

不使用 Spring Cloud Azure

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

1. 将以下依赖项添加到 pom.xml 文件

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

2. 使用类似于以下示例的代码构造一个 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();
       }
   }
   

3. 避免对诸如 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;
       }
   }
   

4. 如本示例所示，更新应用程序代码

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

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

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

6. 如果需要在多个位置使用 SecretClient，请定义一个 SecretClient bean。然后，在相关位置自动装配 SecretClient。

使用 Spring Cloud Azure

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

1. 将以下依赖项添加到 pom.xml 文件

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

2. 使用物料清单 (BOM) 来管理 Spring Cloud Azure 版本，如下面的示例所示

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

3. 将以下属性添加到你的 application.yml 文件

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

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

   az login
   

5. 在相关位置自动装配 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());
       }
   }
   

除了自动配置的 SecretClient，Spring Cloud Azure 还将提供一些其他功能。例如，你可以使用 @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);
    }

}

Spring Cloud Azure 的组件

Azure 支持

为 Azure 服务（如服务总线、存储、活动目录等）提供自动配置支持。

Azure Active Directory

为 Spring Security 提供与 Azure Active Directory 集成的身份验证支持。有关详细信息，请参阅 Spring 安全支持部分的 Spring Cloud Azure 开发人员指南。

Azure Key Vault

为与 Azure Key Vault Secrets 集成提供 Spring @Value 注释支持。有关详细信息，请参阅 机密管理部分的 Spring Cloud Azure 开发人员指南。

Azure 存储

为 Azure 存储服务提供 Spring Boot 支持。有关详细信息，请参阅 资源处理 部分的 Spring Cloud Azure 开发人员指南。

资源

• 源代码：Azure/azure-sdk-for-java
• 示例：Azure-Samples/azure-spring-boot-samples
• 文档：Spring Cloud Azure

获取支持

如果你需要 Spring Cloud Azure 的支持，你可以通过以下方式寻求帮助

• 创建 Azure 支持票证。拥有 Azure 支持计划 的客户可以打开 Azure 支持票证。如果你的问题需要立即关注，我们建议你选择此选项。
• 在 Azure/azure-sdk-for-java 存储库 中归档 GitHub 问题。我们使用 GitHub 问题来跟踪 bug、问题和功能请求。GitHub 问题是免费的，但响应时间无法保证。有关详细信息，请参阅 GitHub 问题支持流程。