Spring Cloud Config為服務端和客戶端提供了分布式系統的外部化配置支持。配置服務器為各應用的所有環境提供了一個中心化的外部配置。它實現了對服務端和客戶端對Spring Environment和PropertySource抽象的映射,所以它除了適用於Spring構建的應用程序,也可以在任何其他語言運行的應用程序中使用。作為一個應用可以通過部署管道來進行測試或者投入生產,我們可以分別為這些環境創建配置,並且在需要遷移環境的時候獲取對應環境的配置來運行。
置服務器默認采用git來存儲配置信息,這樣就有助於對環境配置進行版本管理,並且可以通過git客戶端工具來方便的管理和訪問配置內容。當然他也提供本地化文件系統的存儲方式。
使用 spring Cloud 進行集中式配置管理,將以往的配置文件從項目中摘除后放到Git 或svn中集中管理,並在需要變更的時候,可以通知到各應用程序,應用程序刷新配置不需要重啟。
基本原理
git 上存放我們的遠程配置文件
config-server 連接到 git
config-client 連接到config-server
當我們啟動config-client 服務的時候,client 會通過連接的 config-server 拿到遠程git 上面的配置文件,然后通過 Spring 加載到對象中。
構建Config Server
pom.xml依賴
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-config-server</artifactId> </dependency>
創建Spring Boot的程序主類,並添加@EnableConfigServer
注解,開啟Config Server
@EnableConfigServer @SpringBootApplication public class Application { public static void main(String[] args) { new SpringApplicationBuilder(Application.class).web(true).run(args); } }
application.properties
中配置服務信息以及git信息
spring.application.name=config-server #spring boot port server.port=7001 # git管理配置 spring.cloud.config.server.git.uri=http://git.oschina.net/zjb_china/SpringCloud-Learning
spring.cloud.config.server.git.searchPaths=Chapter9-1-4/config-repo
spring.cloud.config.server.git.username=username
spring.cloud.config.server.git.password=password
- spring.cloud.config.server.git.uri:配置git倉庫位置
- spring.cloud.config.server.git.searchPaths:配置倉庫路徑下的相對搜索位置,可以配置多個
- spring.cloud.config.server.git.username:訪問git倉庫的用戶名
- spring.cloud.config.server.git.password:訪問git倉庫的用戶密碼
到這里,使用一個通過Spring Cloud Config實現,並使用git管理內容的配置中心已經完成了,啟動該應用
Spring Cloud Config也提供本地存儲配置的方式
我們只需要設置屬性spring.profiles.active=native
,Config Server會默認從應用的src/main/resource
目錄下檢索配置文件。
也可以通過spring.cloud.config.server.native.searchLocations=file:F:/properties/
屬性來指定配置文件的位置。
服務端驗證
Chapter9-1-4/ 下創建了一個config-repo目錄作為配置倉庫,並根據不同環境新建了下面四個配置文件:
- didispace.properties
- didispace-dev.properties
- didispace-test.properties
- didispace-prod.properties
其中設置了一個from屬性,為每個配置文件分別設置了不同的值,如:
- from=git-default-1.0
- from=git-dev-1.0
- from=git-test-1.0
- from=git-prod-1.0
同時創建一個config-label-test分支,並將各配置文件中的值用2.0作為后綴
URL與配置文件的映射關系如下:
- /{application}/{profile}[/{label}]
- /{application}-{profile}.yml
- /{label}/{application}-{profile}.yml
- /{application}-{profile}.properties
- /{label}/{application}-{profile}.properties
上面的url會映射{application}-{profile}.properties
對應的配置文件,{label}
對應git上不同的分支,默認為master。
要訪問config-label-test分支,didispace應用的prod環境,可以通過這個url:http://localhost:7001/didispace/prod/config-label-test
如何在微服務應用中獲取配置信息
pom.xml依賴
<dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-config</artifactId> </dependency>
創建bootstrap.properties
配置,來指定config server
#bootstrap.properties的加載也是先於application.properties #bootstrap.properties配置,來指定config server #對應前配置文件中的{application}部分 spring.application.name=didispace #對應前配置文件中的{profile}部分 spring.cloud.config.profile=test #對應前配置文件的git分支 spring.cloud.config.label=config-label-test #配置中心的地址 spring.cloud.config.uri=http://localhost:7001/ #spring boot port server.port=7002
- spring.application.name:對應前配置文件中的{application}部分
- spring.cloud.config.profile:對應前配置文件中的{profile}部分
- spring.cloud.config.label:對應前配置文件的git分支
- spring.cloud.config.uri:配置中心的地址
上面這些屬性必須配置在bootstrap.properties
中,config部分內容才能被正確加載。因為config的相關配置會先於application.properties
,而bootstrap.properties
的加載也是先於application.properties
。
創建最基本的Spring Boot啟動主類
@SpringBootApplication public class Application { public static void main(String[] args) { new SpringApplicationBuilder(Application.class).web(true).run(args); } }
創建一個Rest Api來返回配置中心的from屬性
@RefreshScope @RestController class TestController { @Value("${from}") private String from; @RequestMapping("/from") public String from() { return this.from; } }
通過@Value("${from}")綁定配置服務中配置的from屬性。
啟動該應用,並訪問:http://localhost:7002/from ,我們就可以根據配置內容輸出對應環境的from內容了。
如何在不重啟 config-client 服務的情況下讓項目中引用的配置信息更新呢?
config-client 工程中添加依賴監控模塊,其中包含了/refresh
刷新API
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-actuator</artifactId> <optional>true</optional> </dependency>
在需要自動更新配置變量的Java類上,使用注解 @RefreshScope 修飾
以后當我們再更新git上面的配置文件后,在 config-client 端執行POST 請求 http://localhost:8080/refresh 就可以更新刷新配置變量到內存中了。
如果我們 config-client 做的是分布式部署,豈不是要每一個機器都POST一下 /refresh 請求,這樣顯然不是最好的方法。
Spring Cloud Bus 為我們解決了這樣的問題。
通過Spring Cloud Bus來實現以消息總線的方式進行通知配置信息的變化,完成集群上的自動化更新。
Cloud Bus 需要依賴AMQP、Redis、Kafka 這樣的組件做為代理才可以使用。