在分散式系統中,由於服務數量巨多,為了方便服務配置檔案統一管理,實時更新,所以需要分散式配置中心元件。在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
實現分散式配置的工作流
服務端配置
Config Server
新建專案 spring-cloud-config-server
新增依賴
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
複製程式碼
開啟服務註冊
在程式的啟動類 ConfigServerApplication
通過 @EnableConfigServer
開啟 SpringCloudConfig
服務端
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
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
測試服務
啟動程式 ConfigApplication
類
訪問 Spring Cloud Config Server
服務:
http://localhost:8888/springCloudConfig/dev/master
{
"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
新增依賴
<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
值的內容
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
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
類
下一篇,繼續Spring Cloud Config Server
整合 eureka
, 等更多特性
原始碼下載
GitHub:github.com/souyunku/sp…
Contact
- 作者:鵬磊
- 出處:www.ymq.io
- Email:admin@souyunku.com
- 版權歸作者所有,轉載請註明出處
- Wechat:關注公眾號,搜雲庫,專注於開發技術的研究與知識分享