Spring Cloud ACM SDK的使用步驟

1. 增加Maven依賴。

   <dependency>
        <groupId>com.alibaba.cloud</groupId>
        <artifactId>spring-cloud-starter-acm</artifactId>
        <version>1.10.0</version>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>                   

   說明 請使用Spring Cloud Greenwich或Spring Boot 2.1.X.RELEASE。
2. 配置應用名和應用組。

   在Spring Boot應用中編輯application.properties文件，配置spring.application.group和spring.application.name。

   spring.application.group=com.alibaba.cloud.acm
   spring.application.name=sample-app

3. 配置ACM環境和認證信息。

   在Spring Boot應用中編輯application.properties文件，配置alibaba.acm.endpoint、alibaba.acm.namespace、alibaba.acm.accessKey和alibaba.acm.secretKey。

   spring.application.group=com.alibaba.cloud.acm
   spring.application.name=sample-app
   alibaba.acm.endpoint=xxx
   
   # 命名空間ID。
   alibaba.acm.namespace=xxx
   
   # 若通過ECS實例RAM角色訪問ACM，需添加。
   alibaba.acm.ramRoleName=xxx
   
   # 注意accessKey、secretKey的大小寫。
   alibaba.acm.accessKey=xxx
   alibaba.acm.secretKey=xxx
   
   # 如果是加密配置，則添加下面兩行進行自動解密。regionId可以通過命名空間詳情中的區域ID獲取。
   # alibaba.acm.openKMSFilter=true
   # alibaba.acm.regionId=xxx
   
   # 如果Group不是DEFAULT_GROUP，則需設置alibaba.acm.group。
   # alibaba.acm.group指配置的分組，注意與spring.application.group的區分
   # alibaba.acm.group=xxx
   
   # 如果file-extension不是properties，則需設置alibaba.acm.file-extension。
   # 可選值包括properties、yaml、yml，默認為properties （版本1.0.8以上支持更改此配置）
   # alibaba.acm.file-extension=properties
                       

4. 在ACM控制臺添加應用配置。

   前往ACM控制臺，在相應的命名空間（Namespace）下新建配置。

   • Data ID按照以下約定格式編寫：

     ${spring.application.group}:${spring.application.name}.{alibaba.acm.file-extension}

     例如：com.alibaba.cloud.acm:sample-app.properties

   • 配置格式選擇Properties，配置內容即為想要注入到應用中的具體Key-Value：

     user.id = 001
     user.name = juven2
     user.age = 88

5. 如果需要ACM加載多配置，則需要在Spring Boot應用中編輯application.properties文件，加上配置spring.profiles.active=dev,online。

   實際項目中，也可以在應用運行參數中加上-Dspring.profiles.active=dev,online。

   加上該配置后，ACM會加載三個配置：

   ${spring.application.group}:${spring.application.name}.{alibaba.acm.file-extension},
   ${spring.application.group}:${spring.application.name}-dev.{alibaba.acm.file-extension},
   ${spring.application.group}:${spring.application.name}-online.{alibaba.acm.file-extension}

6. 如果項目中需要用到公共配置的需求，可以利用ACM中的級聯方式，將公共的配置寫在一個特定格式的Data ID內，然后在應用中可按照一定的格式順序加載配置項，假設spring.application.group為com.alibaba.acm.biz，${spring.application.name}為demoapp，alibaba.acm.file-extension為properties（默認），此時ACM SDK加載配置的Data ID順序如下所示。

   #首先加載原有格式的配置
   ${spring.application.group}:${spring.application.name}.${alibaba.acm.file-extension}
   com.alibaba.acm.biz:demoapp.properties
   
   #隨后根據Group按照“.”切分后，拼接application.properties依次加載，如：
   com.alibaba.acm:application.properties
   com.alibaba:application.properties
   com:application.properties

備注

• spring-cloud-starter-acm 1.0.7及更高版本已支持Spring Boot 2.x。
• spring-cloud-starter-acm 1.0.8及更高版本已支持YAML格式。
• 推薦使用2.0.1.RELEASE及更高版本的Spring Boot 2.x。2.0.0.RELEASE版本有讀取舊數據的Bug。
• 如需下載完整示例代碼，請單擊：spring-cloud-acm-sample.zip。

相關文檔

通過ECS實例RAM角色訪問ACM