[TOC] 在分布式系統中，由于服務數量巨多，為了方便服務配置文件統一管理，實時更新，所以需要分布式配置中心組件。在`Spring Cloud`中，有分布式配置中心組件`spring cloud config`，它支持配置服務放在配置服務的內存中（即本地），也支持放在遠程Git倉庫中。在`spring cloud config` 組件中，分兩個角色，一是`config server`，二是`config client`，業界也有些知名的同類開源產品，比如百度的`disconf`。 相比較同類產品，`SpringCloudConfig`最大的優勢是和`Spring`無縫集成，支持`Spring`里面`Environment`和`PropertySource`的接口，對于已有的`Spring`應用程序的遷移成本非常低，在配置獲取的接口上是完全一致，結合`SpringBoot`可使你的項目有更加統一的標準（包括依賴版本和約束規范），避免了應為集成不同開軟件源造成的依賴版本沖突。 # Spring Cloud Config 簡介 `SpringCloudConfig`就是我們通常意義上的配置中心，把應用原本放在本地文件的配置抽取出來放在中心服務器，從而能夠提供更好的管理、發布能力。`SpringCloudConfig`分服務端和客戶端，服務端負責將`git svn`中存儲的配置文件發布成`REST`接口，客戶端可以從服務端REST接口獲取配置。但客戶端并不能主動感知到配置的變化，從而主動去獲取新的配置，這需要每個客戶端通過`POST`方法觸發各自的`/refresh`。 `SpringCloudBus`通過一個輕量級消息代理連接分布式系統的節點。這可以用于廣播狀態更改（如配置更改）或其他管理指令。`SpringCloudBus`提供了通過`POST`方法訪問的`endpoint/bus/refresh`，這個接口通常由`git`的鉤子功能調用，用以通知各個`SpringCloudConfig`的客戶端去服務端更新配置。 注意：這是工作的流程圖，實際的部署中`SpringCloudBus`并不是一個獨立存在的服務，這里單列出來是為了能清晰的顯示出工作流程。 下圖是`SpringCloudConfig`結合`SpringCloudBus`實現分布式配置的工作流 ![SpringCloudConfig結合SpringCloudBus實現分布式配置的工作流][1] # 服務端配置 ## Config Server **新建項目** `spring-cloud-config-server` ## 添加依賴 ```xml <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-config-server</artifactId> </dependency> ``` ## 開啟服務注冊 在程序的啟動類 `ConfigServerApplication` 通過 `@EnableConfigServer` 開啟 `SpringCloudConfig` 服務端 ```java package io.ymq.example.config.server; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.cloud.config.server.EnableConfigServer; @EnableConfigServer @SpringBootApplication public class ConfigServerApplication { public static void main(String[] args) { SpringApplication.run(ConfigServerApplication.class, args); } } ``` ## 添加配置 配置文件 `application.properties` ```sh spring.application.name=config-server server.port=8888 spring.cloud.config.label=master spring.cloud.config.server.git.uri=https://github.com/souyunku/spring-cloud-config.git spring.cloud.config.server.git.search-paths=spring-cloud-config #spring.cloud.config.server.git.username=your username #spring.cloud.config.server.git.password=your password ``` - spring.cloud.config.server.git.uri：配置git倉庫地址 - spring.cloud.config.server.git.searchPaths：配置倉庫路徑 - spring.cloud.config.label：配置倉庫的分支 - spring.cloud.config.server.git.username：訪問git倉庫的用戶名 - spring.cloud.config.server.git.password：訪問git倉庫的用戶密碼 Git倉庫如果是私有倉庫需要填寫用戶名密碼，示例是公開倉庫，所以不配置密碼。 **遠程Git倉庫** `spring-cloud-config` 文件夾下有 `application-dev.properties`,`application-test.properties` 三個文件，內容依次是：`content=hello dev`,`content=hello test`,`content=hello pre` ![遠程Git倉庫][2] ## 測試服務 啟動程序 `ConfigApplication` 類 訪問 `Spring Cloud Config Server`服務： [http://localhost:8888/springCloudConfig/dev/master](http://localhost:8888/springCloudConfig/dev/master) ```json { "name": "springCloudConfig", "profiles": [ "dev" ], "label": "master", "version": "b6fbc2f77d1ead41d5668450e2601a03195eaf16", "state": null, "propertySources": [ { "name": "https://github.com/souyunku/spring-cloud-config.git/application-dev.properties", "source": { "content": "hello dev" } } ] } ``` 證明配置服務中心可以從遠程程序獲取配置信息。 http請求地址和資源文件映射如下: - `/{application}/{profile}[/{label}]` - `/{application}-{profile}.yml` - `/{label}/{application}-{profile}.yml` - `/{application}-{profile}.properties` - `/{label}/{application}-{profile}.properties` # 客戶端配置 ## Config Client **新建項目** `spring-cloud-config-client` ## 添加依賴 ```xml <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-config-client</artifactId> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> ``` ## 開啟服務注冊 在程序的啟動類 `ConfigClientApplication` 通過 `@Value` 獲取服務端的 `content` 值的內容 ```java package io.ymq.example.config.client; @RestController @SpringBootApplication public class ConfigClientApplication { @Value("${content}") String content; @RequestMapping("/") public String home() { return "content:" + content; } public static void main(String[] args) { SpringApplication.run(ConfigClientApplication.class, args); } } ``` ## 添加配置 配置文件 `application.properties` ```sh spring.application.name=config-client server.port=8088 spring.cloud.config.label=master spring.cloud.config.profile=dev spring.cloud.config.uri=http://localhost:8888/ ``` - spring.cloud.config.label 指明遠程倉庫的分支 - spring.cloud.config.profile - dev開發環境配置文件 - test測試環境 - pro正式環境 - spring.cloud.config.uri= http://localhost:8888/ 指明配置服務中心的網址。 ## 測試服務 啟動程序 `ConfigClientApplication` 類 訪問服務：[http://localhost:8088/](http://localhost:8088/) ![訪問服務][4] **下一篇，繼續`Spring Cloud Config Server` 整合 `eureka`, 等更多特性** [1]: https://www.souyunku.com/images/2017/SpringCloud/config/1.png [2]: https://www.souyunku.com/images/2017/SpringCloud/config/2.png [3]: https://www.souyunku.com/images/2017/SpringCloud/config/3.png [4]: https://www.souyunku.com/images/2017/SpringCloud/config/4.png # 源碼下載 **GitHub：**[https://github.com/souyunku/spring-cloud-examples/tree/master/spring-cloud-config](https://github.com/souyunku/spring-cloud-examples/tree/master/spring-cloud-config) **碼云：**[https://gitee.com/souyunku/spring-cloud-examples/tree/master/spring-cloud-config](https://gitee.com/souyunku/spring-cloud-examples/tree/master/spring-cloud-config)