前言
歡迎來(lái)到菜鳥(niǎo)SpringCloud實(shí)戰(zhàn)入門(mén)系列(SpringCloudForNoob),該系列通過(guò)層層遞進(jìn)的實(shí)戰(zhàn)視角,來(lái)一步步學(xué)習(xí)和理解SpringCloud。
本系列適合有一定Java以及SpringBoot基礎(chǔ)的同學(xué)閱讀。
每篇文章末尾都附有本文對(duì)應(yīng)的Github源代碼,方便同學(xué)調(diào)試。
實(shí)戰(zhàn)版本
- SpringBoot:2.0.3.RELEASE
- SpringCloud:Finchley.RELEASE
-----正文開(kāi)始-----
配置中心Spring Cloud Config初體驗(yàn)
使用Git存放配置文件
每個(gè)項(xiàng)目都會(huì)有很多的配置文件,如果采用分布式的開(kāi)發(fā)模式,需要的配置文件隨著服務(wù)增加而不斷增多。配置中心便是解決此類(lèi)問(wèn)題的靈丹妙藥。
Spring Cloud Config核心功能:
- 提供服務(wù)端和客戶(hù)端支持
- 集中管理各環(huán)境的配置文件
- 配置文件修改之后,可以快速的生效
- 可以進(jìn)行版本管理
- 支持大的并發(fā)查詢(xún)
- 支持各種語(yǔ)言
Spring Cloud Config項(xiàng)目是一個(gè)解決分布式系統(tǒng)的配置管理方案。它包含了Client和Server兩個(gè)部分,server提供配置文件的存儲(chǔ)、以接口的形式將配置文件的內(nèi)容提供出去,client通過(guò)接口獲取數(shù)據(jù)、并依據(jù)此數(shù)據(jù)初始化自己的應(yīng)用。Spring cloud使用git或svn存放配置文件,默認(rèn)情況下使用git,我們先以git為例做一套示例。
創(chuàng)建配置倉(cāng)庫(kù)文件夾
在github上面創(chuàng)建了一個(gè)文件夾config-repo用來(lái)存放配置文件,為了模擬生產(chǎn)環(huán)境,我們創(chuàng)建以下三個(gè)配置文件:
// 開(kāi)發(fā)環(huán)境
spring-cloud-config-dev.properties
// 測(cè)試環(huán)境
spring-cloud-config-test.properties
// 生產(chǎn)環(huán)境
spring-cloud-config-prod.properties
目錄為:
每個(gè)配置文件中都寫(xiě)一個(gè)屬性config.hello,屬性值分別是 hello Im dev/test/pro 。
配置server端
下面我們開(kāi)始配置server端,我們新建一個(gè)模塊名為config-server,創(chuàng)建模塊請(qǐng)參考教程第一章。
pom中添加依賴(lài):
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
</dependencies>
然后修改配置文件:
這里需要配置你自己的github或者別的git倉(cāng)庫(kù),并且需要填寫(xiě)自己的賬戶(hù)密碼,你可以fork我的springcloud_for_noob項(xiàng)目,在項(xiàng)目基礎(chǔ)上進(jìn)行修改。
server:
port: 8769
spring:
application:
name: spring-cloud-config-server
cloud:
config:
server:
git:
uri: https://github.com/xxxxx(你自己的賬戶(hù)名)/springcloud_for_noob.git # 配置git倉(cāng)庫(kù)的地址
search-paths: config-repo # git倉(cāng)庫(kù)地址下的相對(duì)地址,可以配置多個(gè),用,分割。
username: xxxxxxxxx # git倉(cāng)庫(kù)的賬號(hào)
password: xxxxxxx
Spring Cloud Config也提供本地存儲(chǔ)配置的方式。我們只需要設(shè)置屬性spring.profiles.active=native,Config Server會(huì)默認(rèn)從應(yīng)用的src/main/resource目錄下檢索配置文件。也可以通過(guò)spring.cloud.config.server.native.searchLocations=file:E:/properties/屬性來(lái)指定配置文件的位置。雖然Spring Cloud Config提供了這樣的功能,但是為了支持更好的管理內(nèi)容和版本控制的功能,還是推薦使用git的方式。
啟動(dòng)類(lèi)添加@EnableConfigServer:
@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
}
}
直接查看配置文件中的配置信息可訪(fǎng)問(wèn):
http://localhost:8769/spring-cloud-config-dev.properties
這樣服務(wù)端就建立好了,并且連接上了遠(yuǎn)程配置文件倉(cāng)庫(kù)。
配置client端
server搞起來(lái)之后,最終還是要在業(yè)務(wù)項(xiàng)目中去獲取server端的配置信息
我們新建一個(gè)模塊名為config-client,創(chuàng)建模塊請(qǐng)參考教程第一章。
pom中添加依賴(lài):
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<!--無(wú)法引入:spring-cloud-config-server-->
<artifactId>spring-cloud-config-client</artifactId>
</dependency>
</dependencies>
配置文件:
為了方便起見(jiàn),我們回歸使用properties文件
需要配置兩個(gè)配置文件:
- application.properties
- bootstrap.properties
application.properties如下:
server.port = 8771
spring.application.name = spring-cloud-config-client
bootstrap.properties如下:
spring.cloud.config.name = spring-cloud-config
spring.cloud.config.profile = dev
spring.cloud.config.uri = http://localhost:8769/
spring.cloud.config.label = master
- spring.application.name:對(duì)應(yīng){application}部分
- spring.cloud.config.profile:對(duì)應(yīng){profile}部分
- spring.cloud.config.label:對(duì)應(yīng)git的分支。如果配置中心使用的是本地存儲(chǔ),則該參數(shù)無(wú)用
- spring.cloud.config.uri:配置中心的具體地址
- spring.cloud.config.discovery.service-id:指定配置中心的service-id,便于擴(kuò)展為高可用配置集群。
特別注意:
上面這些與spring-cloud相關(guān)的屬性必須配置在bootstrap.properties中,config部分內(nèi)容才能被正確加載。
因?yàn)閏onfig的相關(guān)配置會(huì)先于application.properties,而bootstrap.properties的加載也是先于application.properties。
啟動(dòng)類(lèi):
啟動(dòng)類(lèi)不用附加注解,直接可以開(kāi)始了。
測(cè)試類(lèi)HelloController:
為了測(cè)試客戶(hù)端能否正確獲取參數(shù),我們創(chuàng)建一個(gè)測(cè)試類(lèi)HelloController
最終測(cè)試:
啟動(dòng)項(xiàng)目后訪(fǎng)問(wèn):http://localhost:8769/hello ,返回:

如圖所示,拿到了配置參數(shù),我們完成了客戶(hù)端的測(cè)試。
但實(shí)際中,如更改了配置并將其push到了git服務(wù)器上,我們通過(guò)客戶(hù)端訪(fǎng)問(wèn),仍然會(huì)獲取舊的參數(shù)。這是因?yàn)閟pringboot項(xiàng)目只有在啟動(dòng)的時(shí)候才會(huì)獲取配置文件的值,修改git信息后,client端并沒(méi)有再次去獲取。下一章我們的目標(biāo)就是使client實(shí)現(xiàn)刷新機(jī)制。
本章代碼:
https://github.com/qqxx6661/springcloud_for_noob/tree/master/06-config-server-config-client
參考
springcloud(六):配置中心git示例
http://www.ityouknow.com/springcloud/2017/05/22/springcloud-config-git.html