Spring Cloud Azure

什麼是 Spring Cloud Azure？

Spring Cloud Azure 是一個開源專案，它使用 Spring 應用開發原生的常規表達方式和配置，提供 Spring 應用與 Azure 服務之間的整合。

Spring Cloud Azure 有哪些用途？

Spring Cloud Azure 可以幫助更輕鬆地在 Spring 應用中完成以下任務

使用 Azure App Configuration 管理配置屬性。
使用 Azure Event Hubs、Azure Service Bus 和 Azure Storage Queue 傳送和接收訊息。
使用 Azure Key Vault 管理金鑰和證書。
支援使用 Azure Active Directory 預配的工作或學校帳戶進行使用者登入。
支援使用 Azure Active Directory B2C 透過 Facebook 和 Google 等社交帳戶進行使用者登入。
使用 Azure Active Directory 和 Azure Active Directory B2C 保護您的 Web API 並訪問 Microsoft Graph 等受保護的 API，以處理使用者和組織的資料。
使用 Azure Cosmos DB 儲存結構化資料。
使用 Azure Blob Storage 儲存非結構化資料，如文字或二進位制資料。
使用 Azure Files 儲存檔案。

以下圖表提供了這些功能的概覽： 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());
    }
}

除了自動配置的 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);
    }

}