Spring Cloud之-Spring Cloud Bus消息总线- 14（个人笔记）
1、概述
Spring Cloud Bus是用来将分布式系统的结点与轻量级消息系统连接起来的框架，它整合了Java事件处理机制和消息中间件的功能，Spring Cloud Bus目前支持的MQ有：RabbitMQ和Kafka。Spring Cloud Bus可以使Spring Cloud Config实现配置的动态刷新。
观察下图，运维人员发送/bus/refresh的POST请求给其中一个Client，Client将消息发送给消息总线，最初收到POST请求的Client拉取最新的配置信息，监听Spring Cloud Bus的其他Client收到消息后，也去配置中心拉取最新配置信息。这种模式是不推荐的，下面会说原因。
Spring Cloud Bus能管理和传播分布式系统间的消息，类似一个分布式执行器，可用于广播状态更改、事件推送等，也可以作为微服务之间的通信信道。
在微服务架构系统中，通常会使用轻量级的消息代理来构建一个共用的消息主题，让所有的微服务实例都连接上来，这个主题中产生的消息会被所有实例监听和消费，所以称为消息总线。在总线上的实例还可以发送消息给总线，让总线上的其他监听者获取消息。
观察下图，运维人员发送/bus/refresh请求给配置中心，配置中心会获取最新的配置文件，并发送一个消息给消息总线，监听消息总线的其他Client会收到消息，并从配置中心拉取最新的配置文件,这种模式是推荐使用的。
用户向Config Server配置中心发送update的post请求，Config Server配置中心更新配置并把消息发送到总线的Topic主题中，Config Client客户端实例监听MQ中同一个Topic（默认是Spring Cloud Bus），所有实例监听同一个Topic主题的服务就都能收到通知，然后更新自身的配置。
2、RabbitMQ环境配置
2-1、Window版本
RabbitMQ服务器是用Erlang语言编写，需要下载Erlang运行环境，下载地址：https://www.erlang.org/downloads，然后安装RabbitMQ，下载地址：https://www.rabbitmq.com/download.html，在RabbitMQ的sbin目录下，cmd下运行rabbitmq-plugins enable rabbitmq_management添加可视化插件，运行之后，可以在安装目录看到几个插件，启动RabbitMQ Service-start，在浏览器访问http://localhost:15672/，输入用户名和密码，都是guest。
2-2、Linux版本
使用Docker安装RabbitMQ，输入命令docker pull rabbitmq:management拉取rabbitmq镜像，记得选择带management的，否则没有管理后台。使用命令docker run -d -p 5672:5672 -p 15672:15672 rabbitmq:management启动RabbitMQ服务。浏览器访问http://192.168.1.63:15672/，即可看到管理后台，输入用户名和密码，都是1guest1。
2-2、macOS版本
参考此篇博客。
3、Spring Cloud Bus动态刷新全局广播
为了演示广播的效果，我们还需要一个Config-Client，于是参考cloud-config-client-3355模块来创建cloud-config-client-3366模块。记得修改端口号，其他地方和cloud-config-client-3355模块几乎没什么变化，为了区分具体Client，在ConfigClientController的请求中，把端口号输出。
cloud-config-client-3366模块的pom.xml文件：
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>cloud2020artifactId>
<groupId>com.king.springcloudgroupId>
<version>1.0-SNAPSHOTversion>
parent>
<modelVersion>4.0.0modelVersion>
<artifactId>cloud-config-client-3366artifactId>
<dependencies>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-configartifactId>
dependency>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-netflix-eureka-clientartifactId>
dependency>
<dependency>
<groupId>com.king.springcloudgroupId>
<artifactId>cloud-api-commonsartifactId>
<version>${project.version}version>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-actuatorartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-devtoolsartifactId>
<scope>runtimescope>
<optional>trueoptional>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
<optional>trueoptional>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-testartifactId>
<scope>testscope>
dependency>
dependencies>
project>
cloud-config-client-3366模块的bootstrap.yml文件：
# 配置服务端口号
server:
port: 3366
# 配置应用信息
spring:
application:
name: cloud-config-client # 配置应用名称
cloud:
# Config客户端配置
config:
label: master # 分支名称
name: config # 配置文件前缀名称
profile: dev # 读取后缀名称
uri: http://localhost:3344 # 上诉3个综合就是master分支上config-dev.yml，读取目标资源路径，这里读取cloud-config-center-3344模块
# 配置eureka
eureka:
client:
service-url:
# 设置与Eureka Server交互的地址，查询服务和注册服务都需要依赖这个地址
defaultZone: http://eureka7001.com:7001/eureka/
# 暴露所有监控端点
management:
endpoints:
web:
exposure:
include: "*"
cloud-config-client-3366模块的主启动类：
package com.king.springcloud;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.netflix.eureka.EnableEurekaClient;
@EnableEurekaClient
@SpringBootApplication
public class ConfigClientMain3366 {
public static void main(String[] args) {
SpringApplication.run(ConfigClientMain3366.class, args);
}
}
cloud-config-client-3366模块的业务控制类：
package com.king.springcloud.controller;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* 用来实现动态配置、实例热加载
*/
@RefreshScope
@RestController
public class ConfigClientController {
// 获取服务端口号
@Value("${server.port}")
private String serverPort;
// 因为config仓库以rest形式暴露，所以客户端可以通过config服务端访问到GitHub上对应的文件信息
// ${config.info}的读取路径是GitHub仓库配置文件的路径，@Value("${config.info}")这种写法，项目的配置文件一定要是bootstrap.yml因为权限要高于application.yml文件
@Value("${config.info}")
private String configInfo;
@GetMapping("/configInfo")
public String getConfigInfo() {
return "serverPort:" + serverPort + "configInfo:" + configInfo;
}
}
上面提到了两种方案：一种是发给某一个ConfigClient，另一种是发给ConfigServer，这里推荐后者。原因如下：
-
ConfigClient也是一个微服务，它有自己的业务需要处理，如果把刷新配置的工作放在它上面，就破坏了单一职责原则。 -
如果
在某台ConfigClient加了刷新功能，它处理自身业务逻辑可能会受到影响，可能会拖慢本身的业务。 -
如果
ConfigClient迁移，要对地址进行修改，增加工作量，相对来说，ConfigServer迁移概率小一些。
所以，我们选择发送/bus/refresh给ConfigServer，ConfigServer获取最新配置信息后发送消息给Bus，监听Bus消息总线的ConfigClient收到消息后，从ConfigServer上拉取最新的配置信息。
修改cloud-config-server-3344模块添加Bus消息总线支持，cloud-config-server-3344模块pom.xml中加入spring-cloud-starter-bus-amqp的依赖。
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<parent>
<artifactId>cloud2020artifactId>
<groupId>com.king.springcloudgroupId>
<version>1.0-SNAPSHOTversion>
parent>
<modelVersion>4.0.0modelVersion>
<artifactId>cloud-config-center-3344artifactId>
<dependencies>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-bus-amqpartifactId>
dependency>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-config-serverartifactId>
dependency>
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-netflix-eureka-clientartifactId>
dependency>
<dependency>
<groupId>com.king.springcloudgroupId>
<artifactId>cloud-api-commonsartifactId>
<version>${project.version}version>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-webartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-actuatorartifactId>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-devtoolsartifactId>
<scope>runtimescope>
<optional>trueoptional>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
<optional>trueoptional>
dependency>
<dependency>
<groupId>org.springframework.bootgroupId>
<artifactId>spring-boot-starter-testartifactId>
<scope>testscope>
dependency>
dependencies>
project>
修改cloud-config-server-3344模块的application.yml指定MQ的信息，并暴露bus-refresh端口。
# 配置服务端口号
server:
port: 3344
# 配置应用信息
spring:
application:
name: cloud-config-center # 配置应用名称
cloud:
# Config客户端配置
config:
server:
git:
# uri: https://gitee.com/Lianglei0627/springcloudconfig2020.git # Github上的仓库地址
uri: [email protected]:Lianglei0627/springcloudconfig2020.git #设置git仓库地址，读取目标资源路径
search-paths: # 搜索目录，即配置文件的目录
- springcloudconfig2020
label: master # 分支名称
rabbitmq: # 指定MQ的信息
host: 127.0.0.1
port: 5672
username: guest
password: guest
# 配置eureka
eureka:
client:
service-url:
# 设置与Eureka Server交互的地址，查询服务和注册服务都需要依赖这个地址
defaultZone: http://eureka7001.com:7001/eureka/
management:
endpoints:
web:
exposure:
include: 'bus-refresh' # 暴露bus-refresh端口
再修改cloud-config-client-3355模块和cloud-config-client-3366模块添加消息总线支持，pom.xml中加入spring-cloud-starter-bus-amqp的依赖。
<dependency>
<groupId>org.springframework.cloudgroupId>
<artifactId>spring-cloud-starter-bus-amqpartifactId>
dependency>
再修改cloud-config-client-3355模块的bootstrap.yml文件：
# 配置服务端口号
server:
port: 3355
# 配置应用信息
spring:
application:
name: cloud-config-client # 配置应用名称
cloud:
# Config客户端配置
config:
label: master # 分支名称
name: config # 配置文件前缀名称
profile: dev # 读取后缀名称
uri: http://localhost:3344 # 上诉3个综合就是master分支上config-dev.yml，读取目标资源路径，这里读取cloud-config-center-3344模块
rabbitmq: # 指定MQ的信息
host: localhost
port: 5672
username: guest
password: guest
# 配置eureka
eureka:
client:
service-url:
# 设置与Eureka Server交互的地址，查询服务和注册服务都需要依赖这个地址
defaultZone: http://eureka7001.com:7001/eureka/
# 暴露所有监控端点
management:
endpoints:
web:
exposure:
include: "*"
再修改cloud-config-client-3366模块的bootstrap.yml文件：
# 配置服务端口号
server:
port: 3366
# 配置应用信息
spring:
application:
name: cloud-config-client # 配置应用名称
cloud:
# Config客户端配置
config:
label: master # 分支名称
name: config # 配置文件前缀名称
profile: dev # 读取后缀名称
uri: http://localhost:3344 # 上诉3个综合就是master分支上config-dev.yml，读取目标资源路径，这里读取cloud-config-center-3344模块
rabbitmq: # 指定MQ的信息
host: localhost
port: 5672
username: guest
password: guest
# 配置eureka
eureka:
client:
service-url:
# 设置与Eureka Server交互的地址，查询服务和注册服务都需要依赖这个地址
defaultZone: http://eureka7001.com:7001/eureka/
# 暴露所有监控端点
management:
endpoints:
web:
exposure:
include: "*"
启动RabbitMQ服务，先后启动Eureka7001，CloudServer3344，CloudConfig3355，CloudConfig3366模块，如果启动太快报错，就一个一个的启动。启动完成后，访问http://eureka7001.com:7001/查看微服务注册信息。
访问RabbitMQ管理后台，确定RabbitMQ正常启动了。
访问http://localhost:3344/master/config-dev.yml。
访问http://localhost:3355/configInfo，http://localhost:3366/configInfo确保都能正常访问后。
再去GitHub上修改config-dev.yml的内容。
再由运维工程师在终端发送如下命令（如正常情况下，没有任何返回信息），注意发送给ConfigServer服务端这台机器，一处修改，广播通知，处处生效。
test-MBP:~ test$
curl -X POST "http://localhost:3344/actuator/bus-refresh"
刷新成功后，再次访问http://localhost:3344/master/config-dev.yml，http://localhost:3355/configInfo，http://localhost:3366/configInfo，可以发现它们获取到了最新的配置信息。
查看RabbitMQ的管理后台，查看Exchanges交换机标签会看到一个springCloudBus的Topic主题，正是通过这个Topic主题，3355和3366客户端接收到刷新消息，自我刷新它们的配置文件。
4、Spring Cloud Bus动态刷新定点通知
上面的消息通知是发送给了所有监听springCloudBus的Client，如果只希望通知某些Client，就需要在发送curl请求的时候，做一些改动，将实际想发送的Client指定一下即可。
比如，修改Config Server配置中心的配置文件，只希望3355Client生效，3366Client不生效，那么发送的url为：curl -X POST "http://localhost:3344/actuator/bus-refresh/cloud-config-client:3355"。说明一下，这里的请求实际上还是发送给ConfigServer，也就是发送给localhost:3344，和之前不同的是，在bus-refresh后，带了一个参数，表明RabbitMQ需要通知给微服务名称（对应spring.application.name的值，也是注册进Eureka中微服务的名称）为cloud-config-client，端口号（对应server.port的值）为3355的微服务。
演示一下，在GitHub/Gitee上修改config-dev.yml的内容。
发送通知给ConfigServer，让其通知3355Client更新配置信息（正常情况下，没有任何返回信息）。
test-MBP:~ test$ curl -X POST “http://localhost:3344/actuator/bus-refresh/cloud-config-client:3355”
访问http://localhost:3344/master/config-dev.yml，http://localhost:3355/configInfo，http://localhost:3366/configInfo查看效果，3344信息更新，3355信息更新，3366信息没变，试验成功。
