在分布式系統中,配置文件散落在每個項目中,難于集中管理,抑或修改了配置需要重啟才能生效。下面我們使用 spring cloud config 來解決這個痛點。
config server
我們把 config-server 作為 config server,只需要加入依賴:
1
2
3
4
|
<dependency> <groupid>org.springframework.cloud</groupid> <artifactid>spring-cloud-config-server</artifactid> </dependency> |
在 application.yml 中,進行配置:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
spring: application: name: config-server # 名稱 cloud: config: server: git: uri: file: //users/yangdd/documents/code/github/config-repo # 使用本地倉庫(用于測試),格式為:file://${user.home}/config-repo 如果是 windows 則是 file:///${user.home}/config-repo #uri: https: //github.com/yangdd1205/spring-cloud-master/ #username: 用戶名 #password: 密碼 # default -label: config # 可以是 commit id,branch name, tag name,默認值為 master #search-paths: # 表示除了在根目錄搜索配置文件,還可以在以下目錄搜索 #- user server: port: 4001 # 端口 |
spring 的項目,一般有個“約定大于配置”的原則。所以我們 git 中的配置文件,一般以 {application}-{profile}.yml 或者 {application}-{profile}.properties 命名。
- {appliction} 映射到客戶端 spring.application.name 屬性值
- {profile} 映射到客戶端 spring.profiles.active 屬性值
我們在 config-repo 的 master 分支中,有兩個文件 client-dev.yml :
1
|
info: master-dev |
client-prod.yml :
1
|
info: master-prod |
在 config 分支中,有兩個文文件 client-dev.yml :
1
|
info: config-dev |
client-prod.yml :
1
|
info: config-prod |
啟動 config-server 我們可以通過下面的映射關系來訪問 git 中的配置文件:
1
2
3
4
5
|
/{application}/{profile}[/{label}] /{application}-{profile}.yml /{label}/{application}-{profile}.yml /{application}-{profile}.properties /{label}/{application}-{profile}.properties |
http://localhost:4001/client-dev.yml
config client
我們把 config-client 作為 config client,加入依賴:
1
2
3
4
5
6
7
|
<dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-web</artifactid> <dependency> <groupid>org.springframework.cloud</groupid> <artifactid>spring-cloud-starter-config</artifactid> </dependency> |
在 bootstrap.yml 中配置( bootstrap.yml 會先于 application.yml 加載):
1
2
3
4
5
6
7
8
9
10
11
|
spring: application: name: client cloud: config: uri: http: //localhost:4001/ ##表示配置中心的地址 profile: dev # 等同于 spring.profiles.active 屬性,但是優先級高于 spring.profiles.active #label: config # 如果不指定使用 server 中的 label,如果指定了則以 client 的為準 server: port: 4002 # 端口 |
在 config-client 創建 testcontroller :
1
2
3
4
5
6
7
8
9
10
|
@restcontroller public class testcontroller { @value ( "${info}" ) private string info; @requestmapping (value = "/getinfo" ) public string getinfo() { return this .info; } } |
訪問 http://localhost:4002/getinfo
修改 config-client 配置文件的中 profile 為 prod 再訪問,查看結果。
現在我們已經實現了,配置文件統一管理,但是修改配置文件后,如何不重啟生效呢?
我們在 config-client 中引入依賴:
1
2
3
4
|
<dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-actuator</artifactid> </dependency> |
在需要動態刷新的類上加上注解 @refreshscope ,這里我們在 testcontroller 加上。并在配置文件中把 actuator 的權限認證禁用:
1
2
3
|
management: security: enabled: false |
重啟項目, http://localhost:4002/getinfo 結果為: config-dev ,現在修改 config-dev.yml 文件:
1
|
info: config-dev- 1.0 |
調用 actuator 的方法,手動刷新, http://localhost:4002/refresh 注意:必須是 post 方式。 可以看到發生改變了的值有哪些:
1
2
3
|
[ "info" ] |
再訪問 http://localhost:4002/getinfo 結果為: config-dev-1.0 。
我們發現現在雖然可以動態刷新配置了,但是每次都要手動調用刷新方法,假如我有 1000 個服務,那就要調用 1000 次,有沒有更好的辦法呢?那就是結合 spring cloud bus 使用。
高可用
現在我們的 config server 是一個單點的服務,一旦掛掉后面的 config client 將無法使用。所以在生成中,config server 必須是高可用的,那怎么做呢?很簡單,跟我們前面講的 eureka 的高可用一樣,只需要將同一個 config server 多部署幾個即可。
我們將項目 eureka 作為注冊中心,端口為:7001。
復制 config-server 改為 config-server-1 ,端口為:4003,將兩個 config server 都注冊到注冊中心。
將 config-client 也注冊到注冊中心,并指定從 eureka 中獲取 config server:
1
2
3
4
5
6
7
8
9
|
spring: cloud: config: #uri: http: //localhost:4001/ ##表示配置中心的地址,直接指定 config server 地址 profile: dev #label: config discovery: enabled: true # 啟用從服務中獲取 config server service-id: config-server # config server 的服務名 |
以上就是本文的全部內容,希望對大家的學習有所幫助,也希望大家多多支持服務器之家。
原文鏈接:https://yangdongdong.org/2018/01/13/spring-cloud-config/