SpringCloud學習系列之五-----配置中心(Config)和消息總線(Bus)完美使用版
前言
在上篇中介紹了SpringCloud Config的使用,本篇則介紹基於SpringCloud(基於SpringBoot2.x,.SpringCloud Finchley版)中的分布式配置中心(SpringCloud Config)的配置刷新和消息總線(RabbitMQ和Kafka)使用教程。
SpringCloud Config Refresh
在上一篇中我們介紹了springcloud配置中心的本地使用和Git使用的用法,但是當重新修改配置文件提交後,客戶端獲取的仍然是修改前的信息,需要客戶端重啟才可以獲取最新的信息。因此我們需要客戶端能夠動態進行更新,幸好springcloud官方已經給出方案,所以我們只需要使用就行了。
開發準備
開發環境
- JDK:1.8
- SpringBoot:2.0.6.RELEASE
- SpringCloud:Finchley.SR2
註:不一定非要用上述的版本,可以根據情況進行相應的調整。需要註意的是SpringBoot2.x以後,jdk的版本必須是1.8以上!
確認了開發環境之後,我們再來添加相關的pom依賴。
<dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-config</artifactId> </dependency> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId> </dependency> </dependencies>
服務端
服務端以及註冊中心這塊配置和代碼和之前springcloud-config配置基本一樣即可。註冊中心新項目的的名稱為springcloud-config-bus-eureka
,服務端新項目的的名稱為springcloud-config-bus-server
。
註冊中心pom
配置、application.properties
配置和代碼如下:
pom:
<dependencies> <dependency> <groupId>org.springframework.cloud</groupId> <artifactId>spring-cloud-starter-netflix-eureka-server</artifactId> </dependency>
application.properties:
spring.application.name=springcloud-config-bus-eureka
server.port=8006
eureka.client.register-with-eureka=false
eureka.client.fetch-registry=false
eureka.client.serviceUrl.defaultZone=http://localhost:${server.port}/eureka/
代碼:
@SpringBootApplication
@EnableEurekaServer
public class ConfigBusEurekaApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigBusEurekaApplication.class, args);
System.out.println("config bus 註冊中心服務啟動...");
}
}
服務端pom
配置、application.properties
配置和代碼如下:
pom:
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
</dependencies>
application.properties:
spring.application.name=springcloud-config-server
server.port=9005
eureka.client.serviceUrl.defaultZone=http://localhost:8005/eureka/
spring.cloud.config.server.git.uri = https://github.com/xuwujing/springcloud-study/
spring.cloud.config.server.git.search-paths = /springcloud-config/config-repo
spring.cloud.config.server.git.username =
spring.cloud.config.server.git.password =
代碼:
@EnableDiscoveryClient
@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
System.out.println("配置中心服務端啟動成功!");
}
}
客戶端
客戶端這邊在之前springcloud-config-client項目中進行改造,新項目的的名稱為springcloud-config-bus-client
,在pom文件中新增如下配置:
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
spring-boot-starter-actuator
表示對該程序進行監控,可以通過http接口得到該程序的各種信息,詳細的使用可以查看我的這個項目springboot-actuator,可以在註釋中查詢各種接口的使用。
然後再到配置文件application.properties
中添加如下配置:
management.endpoints.web.exposure.include=refresh
該配置表示暴露刷新的地址為refresh。
註:如果是SpringBoot1.x的版本,那麽配置改成management.security.enabled=false
即可。
最後在客戶端的Controller增加一個@RefreshScope
註解,該註解表示在接到SpringCloud配置中心配置刷新的時候,自動將新的配置更新到該類對應的字段中。
@RestController
@RefreshScope
public class ClientController {
@Value("${word}")
private String word;
@RequestMapping("/hello")
public String index(@RequestParam String name) {
return name+","+this.word;
}
}
測試
完成上述的代碼開發後,我們來進行測試Spring-Config是否可以進行配置實時更新。
首先依次啟動springcloud-config-bus-eureka
、springcloud-config-bus-server
和springcloud-config-bus-client
這三個項目。其中9005是服務端springcloud-config-bus-server
的端口,9006是第一個客戶端springcloud-config-bus-client
的端口。
啟動成功之後,在瀏覽器輸入:
http://localhost:9006//hello?name=pancm
界面返回:
pancm,hello world!!
可以正常得到服務端configtest-pro.properties
的配置信息。
然後在把configtest-pro.properties
的配置更改為:
word=hello
然後我們再瀏覽器輸入:
http://localhost:9006//hello?name=pancm
界面返回:
pancm,hello world!!
可以發現配置並沒有實時的刷新,查閱官方文檔得知,需要客戶端通過POST方法觸發各自的/refresh,所以這裏我們就用Postman工具模擬post請求刷新,然後再查看信息。
使用POST請求如下地址:
http://localhost:9006/actuator/refresh
返回:
[
"word"
]
說明完成了word配置的刷新,我們再瀏覽器輸入:
http://localhost:9006//hello?name=pancm
界面返回:
pancm,hello
發現已經成功實現配置刷新了!
示例圖:
SpringCloud Config Bus
上述的示例中,我們客戶端發現每次獲取最新配置都需要手動進行刷新,如果少的的話還可以使用,但是多的話就比較繁瑣了,雖然我們可以使用類似Github的WebHook的工具。
WebHook是當某個事件發生時,通過發送http post請求的方式來通知信息接收方。
但是當客戶端越來越多的時候WebHook已經不好使用了,每次新增客戶端都需要更改WebHook會顯得很麻煩,springcloud官方給出了非常好的解決方案,Spring Cloud Bus
。
Spring cloud bus通過輕量消息代理連接各個分布的節點。這會用在廣播狀態的變化(例如配置變化)或者其他的消息指令。Spring bus的一個核心思想是通過分布式的啟動器對spring boot應用進行擴展,也可以用來建立一個多個應用之間的通信頻道。目前唯一實現的方式是用AMQP消息代理作為通道,同樣特性的設置(有些取決於通道的設置)在更多通道的文檔中。
為什麽使用Spring Cloud Bus
就可以解決這個問題了呢?
我們不一定非要透徹的理解其原理才可以知道,我們只需要知道它的實現步驟,就可以知道了為什麽可以解決了。
步驟如下:
- 首先,在配置中進行更新配置文件信息,它就會自動觸發post發送bus/refresh;
- 然後服務端就會將更新的配置並且發送給Spring Cloud Bus;
- 繼而Spring Cloud bus接到消息之後並通知給使用該配置的客戶端;
- 最後使用該配置的客戶端收到通知後,就會獲取最新的配置進行更新;
這裏我也簡單的畫了下使用Spring Cloud Bus
之前和之後的流程圖,方便進行理解。
不使用Spring Cloud Bus
獲取配置信息流程圖:
使用Spring Cloud Bus
獲取配置信息流程圖:
開發準備
和上述的環境一樣即可。
RabbitMQ 的安裝教程可以看我之前寫的這篇文章:RabbitMQ的環境安裝及配置。
Kafka 的安裝教程可以看我之前寫的這篇文章:kafka安裝使用教程。
服務端
Spring Cloud Bus 主要的使用的MQ主要使用的是,RabbitMQ和Kafka。至於使用的話就可以根據情況來進行選擇,主要使用的是哪個MQ就用哪一個就行了。這裏我們就用RabbitMQ作為示例來進行講解,Kafka的使用也差不多,也無在乎配置更改而已。
首先在springcloud-config-bus-server
服務端的pom文件添加如下配置:
<dependencies>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-config-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-server</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>
</dependencies>
註: spring-boot-starter-actuator
這個是必須的,不然是無法在服務端進行配置刷新請求的。如果是使用的kafka的話,只需將spring-cloud-starter-bus-amqp
改成spring-cloud-starter-bus-kafka
即可。
然後再到配置文件中添加如下配置:
配置信息:
spring.application.name=springcloud-config-bus-server
server.port=9005
eureka.client.serviceUrl.defaultZone=http://localhost:8006/eureka/
spring.cloud.config.server.git.uri = https://github.com/xuwujing/springcloud-study/
spring.cloud.config.server.git.search-paths = /springcloud-config/config-repo
spring.cloud.config.server.git.username =
spring.cloud.config.server.git.password =
management.endpoints.web.exposure.include= bus-refresh
spring.cloud.bus.enabled = true
spring.cloud.bus.trace.enabled = true
spring.rabbitmq.host:127.0.0.1
spring.rabbitmq.port:5672
spring.rabbitmq.username:guest
spring.rabbitmq.password:guest
配置說明:
- spring.application.name : 這個是指定服務名稱。
- server.port:服務指定的端口。
- eureka.client.serviceUrl.defaultZone: 這個是設置與Eureka Server交互的地址,客戶端的查詢服務和註冊服務都需要依賴這個地址。
- spring.cloud.config.server.git.uri: 配置的Git長褲的地址。
- spring.cloud.config.server.git.search-paths: git倉庫地址下的相對地址 多個用逗號","分割。
- spring.cloud.config.server.git.username:git倉庫的賬號。
- spring.cloud.config.server.git.password:git倉庫的密碼。
- management.endpoints.web.exposure.include:SpringBoot2.x之後必須添加次配置,和上述的客戶端
springcloud-config-bus-client
增加的的配置一樣,名稱不一樣是為了做區分。 - spring.cloud.bus.enabled:是否啟用springcloud config bus。
- spring.cloud.bus.trace.enabled:開啟跟蹤總線事件。
- spring.rabbitmq.host: rabbitmq的地址。
- spring.rabbitmq.port: rabbitmq的端口。
- spring.rabbitmq.username: rabbitmq的用戶名。
- spring.rabbitmq.password: rabbitmq的密碼。
註:如果是kafka的話,添加kafka的配置信息spring.kafka.bootstrap-servers
,填寫kafka的地址和端口即可。
服務端代碼和之前一樣即可,在程序主類中,額外添加@EnableConfigServer
註解,該註解表示啟用config配置中心功能。代碼如下:
@EnableDiscoveryClient
@EnableConfigServer
@SpringBootApplication
public class ConfigServerApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigServerApplication.class, args);
System.out.println("配置中心服務端啟動成功!");
}
}
完成上述代碼之後,我們的配置中心服務端已經構建完成了。
註冊中心和之前保持一致就可以了。
客戶端
客戶端這邊的變動基本不大,增加一個rabbitmq的jar包和相應的配置文件即可。
在springcloud-config-bus-clinet
的pom文件添加如下配置:
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-config</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>
</dependencies>
bootstrap.properties
文件的配置信息和之前的基本一樣,完整的配置如下:
配置信息:
spring.cloud.config.name=configtest
spring.cloud.config.profile=pro
spring.cloud.config.label=master
spring.cloud.config.discovery.enabled=true
spring.cloud.config.discovery.serviceId=springcloud-config-bus-server
eureka.client.serviceUrl.defaultZone=http://localhost:8006/eureka/
配置說明:
- spring.cloud.config.name: 獲取配置文件的名稱。
- spring.cloud.config.profile: 獲取配置的策略。
- spring.cloud.config.label:獲取配置文件的分支,默認是master。如果是是本地獲取的話,則無用。
- spring.cloud.config.discovery.enabled: 開啟配置信息發現。
- spring.cloud.config.discovery.serviceId: 指定配置中心的service-id,便於擴展為高可用配置集群。
- eureka.client.serviceUrl.defaultZone: 這個是設置與Eureka Server交互的地址,客戶端的查詢服務和註冊服務都需要依賴這個地址。
註:上面這些與spring-cloud相關的屬性必須配置在bootstrap.properties中,config部分內容才能被正確加載。因為bootstrap.properties的相關配置會先於application.properties,而bootstrap.properties的加載也是先於application.properties。需要註意的是eureka.client.serviceUrl.defaultZone
要配置在bootstrap.properties,不然客戶端是無法獲取配置中心參數的,會啟動失敗!
application.properties
配置文件新增的配置基本和服務端的一樣,完整的配置如下:
spring.application.name=springcloud-config-bus-client
server.port=9006
management.endpoints.web.exposure.include=refresh
spring.cloud.config.failFast=true
spring.cloud.bus.trace.enabled = true
spring.rabbitmq.host:127.0.0.1
spring.rabbitmq.port:5672
spring.rabbitmq.username:guest
spring.rabbitmq.password:guest
配置說明:
- spring.application.name: 這個是指定服務名稱。
- server.port:服務指定的端口。
- management.endpoints.web.exposure.include:暴露刷新的地址。
- spring.cloud.bus.enabled:是否啟用springcloud config bus。
- spring.cloud.bus.trace.enabled:開啟跟蹤總線事件。
- spring.rabbitmq.host: rabbitmq的地址。
- spring.rabbitmq.port: rabbitmq的端口。
- spring.rabbitmq.username: rabbitmq的用戶名。
- spring.rabbitmq.password: rabbitmq的密碼。
程序主類代碼,和之前的基本一致。代碼如下:
主程序代碼示例:
@EnableDiscoveryClient
@SpringBootApplication
public class ConfigClientApplication {
public static void main(String[] args) {
SpringApplication.run(ConfigClientApplication.class, args);
System.out.println("配置中心客戶端啟動成功!");
}
}
控制層代碼:
@RestController
@RefreshScope
public class ClientController {
@Value("${word}")
private String word;
@RequestMapping("/hello")
public String index(@RequestParam String name) {
return name+","+this.word;
}
}
完成上述的項目開發之後,我們把上面的項目復制一下,項目名稱為springcloud-config-bus-client2
,然後把它的端口改為9007即可。
到此,客戶端的項目也就構建完成了。
功能測試
完成如上的工程開發之後,我們來進行測試。
我們首先啟動RabbitMQ服務,然後再依次啟動springcloud-config-bus-eureka
、springcloud-config-bus-server
、springcloud-config-bus-client
和springcloud-config-bus-client2
這四個項目。其中9005是服務端springcloud-config-bus-server
的端口,9006是第一個客戶端springcloud-config-bus-client
的端口,9007是是第二個客戶端springcloud-config-bus-client2
的端口。
全局刷新測試
啟動成功之後,在瀏覽器輸入:
http://localhost:9006//hello?name=pancm
界面返回:
pancm,hello
在瀏覽器輸入:
http://localhost:9007//hello?name=xuwujing
界面返回:
xuwujing,hello
可以正常得到服務端configtest-pro.properties
的配置信息。
然後在把configtest-pro.properties
的配置更改為:
word=hello!!
然後在使用Postman工具進行發起POST請求,只不過這次的地址是服務端的地址和端口。
使用POST請求如下地址:
http://localhost:9005/actuator/bus-refresh
然後我們再瀏覽器輸入:
http://localhost:9006//hello?name=pancm
界面返回:
pancm,hello!!
瀏覽器輸入:
http://localhost:9007//hello?name=pancm
界面返回:
xuwujing,hello!!
示例圖:
局部刷新測試
完成上述全局刷新測試之後,有時我們只想刷新部分微服務的配置,那麽便可以使用/actuator/bus-refresh/{destination}
端點的 destination
參數來定位要刷新的應用程序。
我們繼續更改configtest-pro.properties
的配置為:
word=hello!!!
然後依舊使用Postman工具發送post請求,地址為:
http://localhost:9005/actuator/bus-refresh/springcloud-config-bus-client2
然後我們再瀏覽器輸入:
http://localhost:9006//hello?name=pancm
界面返回:
pancm,hello!!
瀏覽器輸入:
http://localhost:9007//hello?name=pancm
界面返回:
xuwujing,hello!!!
發現只有springcloud-config-bus-client2
客戶端的配置更新,另一個springcloud-config-bus-client
沒有進行刷新,達到了我們的目的。
示例圖:
上述示例完成之後,我們把SpringCloud Config Refresh
的測試在進行一遍,發現依舊可以實現,因此我們發現只要開啟Spring Cloud Bus
後,不管是對服務端還是客戶端,執行/actuator/bus-refresh
都是可以更新配置的。
如果我們想進行跟蹤總線事件的話,只需要在刷新配置之後,在地址後面添加/trace
或/actuator/httptrace
即可。
其他
項目地址
基於SpringBoot2.x、SpringCloud的Finchley版本開發的地址:https://github.com/xuwujing/springcloud-study
如果感覺項目不錯,希望能給個star,謝謝!
音樂推薦
原創不易,如果感覺不錯,希望留言推薦!您的支持是我寫作的最大動力!
版權聲明:
作者:虛無境
博客園出處:http://www.cnblogs.com/xuwujing
CSDN出處:http://blog.csdn.net/qazwsxpcm
個人博客出處:http://www.panchengming.com
SpringCloud學習系列之五-----配置中心(Config)和消息總線(Bus)完美使用版