前言
歡迎來到菜鳥SpringCloud實戰(zhàn)入門系列(SpringCloudForNoob),該系列通過層層遞進的實戰(zhàn)視角,來一步步學習和理解SpringCloud空盼。
本系列適合有一定Java以及SpringBoot基礎的同學閱讀。
每篇文章末尾都附有本文對應的Github源代碼,方便同學調(diào)試晦溪。
實戰(zhàn)版本
- SpringBoot:2.0.3.RELEASE
- SpringCloud:Finchley.RELEASE
-----正文開始-----
配置中心客戶端主動刷新機制 + 配置中心服務化和高可用改造
客戶端Refresh:客戶端主動獲取配置信息
經(jīng)過上一章節(jié)配置好Spring Cloud Config后,客戶端(config-client模塊)能夠獲得從服務端(config-server模塊)傳來的配置文件信息挣跋。
文末寫出了一個問題三圆,客戶端并不能獲取更新后的配置信息,想要刷新信息,必須重啟config-client模塊舟肉,這顯然不切實際修噪。
實驗:驗證客戶端無法更新
下面做一個實驗,啟動客戶端和服務端路媚,隨后更新dev配置文件黄琼,新加了(new):
隨后push到遠程倉庫,我們再次直接訪問服務端的 http://localhost:8769/spring-cloud-config-dev.properties :
發(fā)現(xiàn)更新成了新的配置文件整慎。
之后訪問客戶端:
發(fā)現(xiàn)依然是老的配置文件信息脏款,客戶端只在啟動時獲取了當時的配置文件信息。
開啟更新機制
我們只需要在config-server模塊中進行改動裤园。
實現(xiàn)Refresh機制需要添加依賴spring-boot-starter-actuator撤师,這個依賴在我們的root模塊中就已經(jīng)添加,在config-server模塊就不需要重復添加了拧揽。如果你在root父模塊沒有添加剃盾,那么就需要加上。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
大坑:
對需要刷新的類加上注解@RefreshScope:
當配置更改時强法,標有@RefreshScope的Bean將得到特殊處理來生效配置万俗。
注意這里不是直接加載主類上,除非你的controller寫在了主類里饮怯。
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RefreshScope
public class HelloController {
@Value("${config.hello}")
private String hello;
@RequestMapping("/hello")
public String from() {
return this.hello;
}
}
對于springboot 1.5.X 以上版本闰歪,需要在配置文件中關閉安全認證。
management.security.enabled=false
對于springboot 2蓖墅,上述配置不起作用库倘,需要修改server端配置文件,將端口暴露:
management:
endpoints:
web:
exposure:
include: "*"
還要將客戶端端口暴露:
management:
endpoints:
web:
exposure:
include: refresh
測試:
我們開啟服務端和客戶端论矾,先測試下未更新前獲取的配置信息:
隨后我們修改配置文件并push:
然后以post請求訪問 curl -v -X POST "http://localhost:8002/actuator/refresh"
:
得到了:
如果在不變更的情況下教翩,再次發(fā)送POST請求:
使用Webhook監(jiān)聽配置更新
WebHook是當某個事件發(fā)生時,通過發(fā)送http post請求的方式來通知信息接收方贪壳。Webhook來監(jiān)測你在Github.com上的各種事件饱亿,最常見的莫過于push事件。如果你設置了一個監(jiān)測push事件的Webhook闰靴,那么每當你的這個項目有了任何提交彪笼,這個Webhook都會被觸發(fā),這時Github就會發(fā)送一個HTTP POST請求到你配置好的地址蚂且。
如此一來配猫,你就可以通過這種方式去自動完成一些重復性工作,比如杏死,你可以用Webhook來自動觸發(fā)一些持續(xù)集成(CI)工具的運作泵肄,比如Travis CI捆交;又或者是通過 Webhook 去部署你的線上服務器。下圖就是github上面的webhook配置腐巢。
這種機制適用于只有少數(shù)微服務的情況品追,在大量未服務的情況下,這種機制就顯得捉襟見肘系忙。
消息總線機制
如果項目少配置少的情況可以通過/refresh來手動刷新配置诵盼,如果項目比較復雜的情況呢這種肯定是行不通的惠豺,Spring Cloud Bus消息總線可以解決配置修改的真正的動態(tài)刷新银还。我們放在下一章進行學習。
配置中心服務化和高可用改造
目前我們的兩個子模塊config-server和config-client是相互耦合的洁墙,client需要輸入server的地址來調(diào)用它蛹疯,這樣的調(diào)用違反了低耦合原則(低耦合:就是A模塊與B模塊存在依賴關系,那么當B發(fā)生改變時热监,A模塊仍然可以正常工作捺弦,那么就認為A與B是低耦合的。)
現(xiàn)在我們就是用之前學習的Eureka來對配置中心進行改造孝扛。
服務端改造
改造集中在兩方面列吼,一個是在注冊中心注冊,一個是開啟多個服務端達到高可用的目的苦始。
添加依賴(由于eureka的依賴在我們的父模塊已經(jīng)添加寞钥,所以對于config-server模塊我們不需要改動):
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-eureka</artifactId>
</dependency>
</dependencies>
配置文件新增注冊配置:
server:
port: 8769
spring:
application:
name: spring-cloud-config-server
cloud:
config:
server:
git:
uri: https://xxxxxxxxxxx.git # 配置git倉庫的地址
search-paths: config-repo # git倉庫地址下的相對地址,可以配置多個陌选,用,分割理郑。
username: xxxxxx # git倉庫的賬號
password: xxxxx # git倉庫的密碼
# 客戶端調(diào)用需要
management:
endpoints:
web:
exposure:
include: "*"
eureka:
client:
serviceUrl:
defaultZone: http://localhost:8761/eureka/
啟動類添加@EnableDiscoveryClient:
@SpringBootApplication
@EnableConfigServer
@EnableDiscoveryClient
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
}
}
客戶端改造
依賴修改:同服務端相同,我們不需要修改咨油,父模塊將注冊中心等都已經(jīng)引入(見第一章)
啟動類添加@EnableDiscoveryClient:同上您炉。
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
@SpringBootApplication
@EnableDiscoveryClient
public class ConfigClientApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigClientApplication.class, args);
}
}
配置文件yml修改:
在前面我們給config-client子模塊配置了兩個yml文件,一個是傳統(tǒng)application.yml一個是bootstrap.yml役电,bootstrap.yml的啟動優(yōu)先于application.yml
我們修改bootstrap.yml赚爵,添加注冊中心配置,并將config的配置加上:
- spring.cloud.config.discovery.enabled :開啟Config服務發(fā)現(xiàn)支持
- spring.cloud.config.discovery.serviceId :指定server端的name,也就是server端spring.application.name的值
- 刪除spring.cloud.config.uri
spring:
cloud:
config:
name: spring-cloud-config
profile: dev
label: master
discovery:
enabled: true
service-id: spring-cloud-config-server
eureka:
client:
serviceUrl:
defaultZone: http://localhost:8761/eureka/
隨后我們啟動三個模塊:
- Eureka子模塊
- config-server
- config-client
查看Eureka狀態(tài) http://localhost:8761/ :
為了達成高可用法瑟,我們將config-server的端口號再修改為8770冀膝,啟動一個新的config-server,這樣就有兩個config-server同時為我們服務瓢谢。
調(diào)用客戶端接口:
本章代碼
https://github.com/qqxx6661/springcloud_for_noob/tree/master/07-config-server-config-client-eureka
參考
http://www.ityouknow.com/springcloud/2017/05/23/springcloud-config-svn-refresh.html
https://blog.csdn.net/youanyyou/article/details/78993060
http://www.ityouknow.com/springcloud/2017/05/25/springcloud-config-eureka.html