SpringCloud(七)-手把手教你使用消息总线Bus实现动态刷新

还记得在上篇文章中使用Config配置中心的时候，如果远程配置文件修改了，那么需要post刷新请求，配置客户端才会获取最新的配置。这个问题就是如果配置中心修改了，我们需要向每个微服务刷新，大大提高了操作难度。而消息总线Bus使用消息队列中的发布订阅模式来帮我们解决了这个问题。

系列文章
SpringCloud(一)-手把手教你创建springcloud微服务父子项目
 SpringCloud(二)-手把手教你搭建Eureka Server和Eureka Client
SpringCloud(三)-手把手教你通过Rinbbon实现客户端负载均衡
 SpringCloud(四)-手把手教你使用OpenFeign
SpringCloud(五)-手把手教你使用Hystrix配置服务熔断和降级以及Hystrix Dashboard
SpringCloud(六)-手把手教你搭建SpringCloud Config配置中心
 SpringCloud(七)-手把手教你使用消息总线Bus实现动态刷新
 SpringCloud(八)-手把手教你使用Stream消息驱动

1. 简介

Spring Cloud Bus将分布式系统的节点与轻量级消息代理链接。这可以用于广播状态更改（例如配置更改）或其他管理指令。一个关键的想法是，Bus就像一个扩展的Spring Boot应用程序的分布式执行器，但也可以用作应用程序之间的通信渠道。当前唯一的实现是使用AMQP代理作为传输，但是相同的基本功能集（还有一些取决于传输）在其他传输的路线图上。（复制的官方文档）

简单的来说通过消息中间件作为传输，来广播命令。

接下来就是项目案例了，在本例中使用RabbitMQ作为消息中间件。

2. 安装RabbitMQ

在笔者的另一篇文章中[RabbitMQ和Kafka:Win10安装教程] (https://www.jianshu.com/p/63d32ab9389f)，已经详细介绍了如何安装和启动RabbitMQ了，如果本机还没安装RabbitMQ的同学请参考上篇文章。

启动成功后的RabbitMQ，在浏览器中输入http://localhost:15672/#/ 可以看到如下界面，就说明RabbitMQ安装和启动成功。

RabbitMQ主界面

3. 配置中心config-server-8600

我们依旧通过config-server-8600项目来作为配置中心，要对Bus的支持，我们需要引入一些依赖并修改配置。

3.1 pom.xml引入依赖

config-server-8600中需要引入消息总线和监控中心的依赖

<!--消息总线bus-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bus-amqp</artifactId>
        </dependency>
        <!-- 监控中心-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-actuator</artifactId>
        </dependency>

然后总的pom.xml内容如下

<?xml version="1.0" encoding="UTF-8"?>
<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>springcloudtest</artifactId>
        <groupId>com.elio.springcloud</groupId>
        <version>1.0-SNAPSHOT</version>
    </parent>
    <modelVersion>4.0.0</modelVersion>

    <artifactId>springcloud-config-server-8600</artifactId>

    <dependencies>
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-config-server</artifactId>
        </dependency>
        <!--消息总线bus-->
        <dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-starter-bus-amqp</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-netflix-eureka-client</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
    </dependencies>
</project>

3.2 修改application.yml配置文件

需要加入RabbitMQ的相关配置，还有就是暴露刷新接口。
注意：

其中rabbitmq的服务端口是5672，而15672支持客户端的接口，不要配置错了。
bus-refresh 将会是刷新接口的地址，接下来会通过http://localhost:8600/actuator/bus-refresh 接口来进行刷新

  rabbitmq:
    host: localhost # rabbitmq主机
    port: 5672      # rabbitmq端口，注意是5672而不是15672
    username: guest # 用户名
    password: guest # 密码

management:
  endpoints:
    web:
      exposure:
        include: bus-refresh # 指定刷新地址

然后总的application.yml配置内容如下

server:
  port: 8600 #端口号

spring:
  application:
    name: springcloud-config-server # 应用名称
  cloud:
    config:
      server:
        git:
          uri: https:  #git地址
          username:  # git账号名
          password:  # git账号密码
  rabbitmq:
    host: localhost # rabbitmq主机
    port: 5672      # rabbitmq端口，注意是5672而不是15672
    username: guest # 用户名
    password: guest # 密码

eureka:
  instance:
    instance-id: ${spring.application.name}:${server.port}
  client:
    fetch-registry: true
    register-with-eureka: true
    service-url:
      defaultZone: http://localhost:8300/eureka/,http://localhost:8301/eureka/

management:
  endpoints:
    web:
      exposure:
        include: bus-refresh # 指定刷新地址

4. 配置客户端product-provider-8100

完成了配置中心的配置后，接下来就是要配置客户端product-provider-8100了。

4.1 修改pom.xml引入依赖

<!--消息总线bus-->
<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>
<!-- 监控中心-->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-actuator</artifactId>
</dependency>

4.2 修改bootstrap.yml配置文件

bootstrap.yml 只用加入rabbitMQ的相关配置即可

  rabbitmq:
      host: localhost
      port: 5672
      username: guest
      password: guest

总的bootstrap.yml内容如下

spring:
  cloud:
    config:
      name: configtest # 获取配置文件的名称
      profile: pro # 配置的策略pro-生产 test-测试 dev-开发
      label: master # 分支
      discovery:
        enabled: true # 开启配置信息发现
        service-id: springcloud-config-server # 指定配置中心的service-id
  rabbitmq:
      host: localhost
      port: 5672
      username: guest
      password: guest

eureka:
  instance:
    instance-id: ${spring.application.name}:${server.port}
  client:
    fetch-registry: true
    register-with-eureka: true
    service-url:
      defaultZone: http://localhost:8300/eureka/,http://localhost:8301/eureka/

management:
  endpoints:
    web:
      exposure:
        include: refresh,health

4.3 确定访问接口

获取远程配置文件的接口是没有变动的，记得要加上@RefreshScope注解

@RestController
@Slf4j
@RequestMapping("/")
@RefreshScope
public class ProductProviderController {

    @Resource
    private ProductService productService;

    @Value("${spring.application.name}")
    private String instantName;

    @Value("${server.port}")
    private String port;

    @Value("${hello}")
    private String hello;

    @GetMapping("product/provider/get/config/info")
    public Result getConfigInfo()throws Exception{
        return new Result(200,"",this.hello);
    }
}

5. 测试

依次启动eureka-server-8300，eureka-server-8301，config-server-8600，product-provider-8100项目后，接下来进行以下步骤：

修改码云上的configtest-pro.yml文件，文件内容修改成如下

hello: hello from configtest-pro modified three times

然后打开cmd窗口，输入以下命令

curl -X POST http://localhost:8600/actuator/bus-refresh

命令窗口

然后浏览器地址中输入product-provider-8100的访问接口http://localhost:8100/product/provider/get/config/info

成功刷新

最终测试结果和预期的一样，在这个例子中笔者只用一个微服务来做测试，其实多个微服务效果一样，可以通过消息总件的形式，就能够实现广播配置文件变动事件了。

总结

本文简单的介绍了如何通过Bus + RabbitMQ来实现动态刷新，具体的原理和工作流程本文没有叙述，希望对只是想通过小实践来学习的同学有所帮助。