179
技術社區[雲棲]
springcloud：配置中心git示例
隨著線上項目變的日益龐大，每個項目都散落著各種配置文件，如果采用分布式的開發模式，需要的配置文件隨著服務增加而不斷增多。某一個基礎服務信息變更，都會引起一係列的更新和重啟，運維苦不堪言也容易出錯。配置中心便是解決此類問題的靈丹妙藥。
市麵上開源的配置中心有很多，BAT每家都出過，360的QConf、淘寶的diamond、百度的disconf都是解決這類問題。國外也有很多開源的配置中心Apache的Apache Commons Configuration、owner、cfg4j等等。這些開源的軟件以及解決方案都很優秀，但是我最鍾愛的卻是spring Cloud Config，因為它功能全麵強大，可以無縫的和spring體係相結合，夠方便夠簡單顏值高我喜歡。
Spring Cloud Config
在我們了解spring cloud config之前，我可以想想一個配置中心提供的核心功能應該有什麼
提供服務端和客戶端支持
集中管理各環境的配置文件
配置文件修改之後，可以快速的生效
可以進行版本管理
支持大的並發查詢
支持各種語言
Spring Cloud Config可以完美的支持以上所有的需求。
Spring Cloud Config項目是一個解決分布式係統的配置管理方案。它包含了Client和Server兩個部分，server提供配置文件的存儲、以接口的形式將配置文件的內容提供出去，client通過接口獲取數據、並依據此數據初始化自己的應用。Spring cloud使用Git或svn存放配置文件，默認情況下使用git，我們先以git為例做一套示例。
首先在github上麵創建了一個文件夾config-repo用來存放配置文件，為了模擬生產環境，我們創建以下三個配置文件：
// 開發環境
neo-config-dev.properties
// 測試環境
neo-config-test.properties
// 生產環境
neo-config-pro.properties
每個配置文件中都寫一個屬性neo.hello,屬性值分別是 hello im dev/test/pro 。下麵我們開始配置server端
server 端
1、添加依賴
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
</dependencies>
隻需要加入spring-cloud-config-server包引用既可。
2、配置文件
server:
port: 8040
spring:
application:
name: spring-cloud-config-server
cloud:
config:
server:
git:
uri: https://github.com/ityouknow/spring-cloud-starter/ # 配置git倉庫的地址
search-paths: config-repo # git倉庫地址下的相對地址，可以配置多個，用,分割。
username: # git倉庫的賬號
password: # git倉庫的密碼
3、啟動類
啟動類添加@EnableConfigServer，激活對配置中心的支持
@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
}
}
到此server端相關配置已經完成
4、測試
首先我們先要測試server端是否可以讀取到github上麵的配置信息，直接訪問：https://localhost:8001/neo-config/dev
返回信息如下：
{
"name": "neo-config",
"profiles": [
"dev"
],
"label": null,
"version": null,
"state": null,
"propertySources": [
{
"name": "https://github.com/ityouknow/spring-cloud-starter/config-repo/neo-config-dev.properties",
"source": {
"neo.hello": "hello im dev"
}
}
]
}
上述的返回的信息包含了配置文件的位置、版本、配置文件的名稱以及配置文件中的具體內容，說明server端已經成功獲取了git倉庫的配置信息。
如果直接查看配置文件中的配置信息可訪問：https://localhost:8001/neo-config-dev.properties，
返回：neo.hello: hello im dev
修改配置文件neo-config-dev.properties中配置信息為：neo.hello=hello im dev update,再次在瀏覽器訪問https://localhost:8001/neo-config-dev.properties，返回：neo.hello: hello im dev update。說明server端會自動讀取最新提交的內容
倉庫中的配置文件會被轉換成web接口，訪問可以參照以下的規則：
/{application}/{profile}[/{label}]
/{application}-{profile}.yml
/{label}/{application}-{profile}.yml
/{application}-{profile}.properties
/{label}/{application}-{profile}.properties
以neo-config-dev.properties為例子，它的application是neo-config，profile是dev。client會根據填寫的參數來選擇讀取對應的配置。
client 端
主要展示如何在業務項目中去獲取server端的配置信息
1、添加依賴
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
引入spring-boot-starter-web包方便web測試
2、配置文件
需要配置兩個配置文件，application.properties和bootstrap.properties
application.properties如下：
spring.application.name=spring-cloud-config-client
server.port=8002
bootstrap.properties如下：
spring.cloud.config.name=neo-config
spring.cloud.config.profile=dev
spring.cloud.config.uri=https://localhost:8001/
spring.cloud.config.label=master
spring.application.name：對應{application}部分
spring.cloud.config.profile：對應{profile}部分
spring.cloud.config.label：對應git的分支。如果配置中心使用的是本地存儲，則該參數無用
spring.cloud.config.uri：配置中心的具體地址
spring.cloud.config.discovery.service-id：指定配置中心的service-id，便於擴展為高可用配置集群。
特別注意：上麵這些與spring-cloud相關的屬性必須配置在bootstrap.properties中，config部分內容才能被正確加載。因為config的相關配置會先於application.properties，而bootstrap.properties的加載也是先於application.properties。
3、啟動類
啟動類添加@EnableConfigServer，激活對配置中心的支持
@SpringBootApplication
public class ConfigClientApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigClientApplication.class, args);
}
}
啟動類隻需要@SpringBootApplication注解就可以
4、web測試
使用@Value注解來獲取server端參數的值
@RestController
class HelloController {
@Value("${neo.hello}")
private String hello;
@RequestMapping("/hello")
public String from() {
return this.hello;
}
}
啟動項目後訪問：https://localhost:8002/hello，返回：`hello im dev update說明已經正確的從server端獲取到了參數。到此一個完整的服務端提供配置服務，客戶端獲取配置參數的例子就完成了。
我們在進行一些小實驗，手動修改neo-config-dev.properties中配置信息為：neo.hello=hello im dev update1提交到github,再次在瀏覽器訪問https://localhost:8002/hello，返回：neo.hello: hello im dev update，說明獲取的信息還是舊的參數，這是為什麼呢？因為spirngboot項目隻有在啟動的時候才會獲取配置文件的值，修改github信息後，client端並沒有在次去獲取，所以導致這個問題。如何去解決這個問題呢？留到下一章我們在介紹。
最後更新：2017-08-13 22:36:35