Spring Cloud-Bus消息总线

简介

Spring Cloud Bus是Spring Cloud体系内的消息总线,用来连接分布式系统的所有节点。

Spring Cloud Bus将分布式的节点用轻量的消息代理(RibbitMQ、Kafka)连接起来。可以通过消息代理广播配置文件的更改,或服务之间的通讯,也可以用于监控。解决了微服务数据变更,及时同步的问题。

使用消息代理来构建一个主题,让所有微服务实例订阅,当该消息主题产生消息时会被所有微服务实例监听和消费。

下面我们以RabbitMQ为例来演示下使用Spring Cloud Bus动态刷新配置的功能。

RabbitMQ的安装

安装包:
Erlang:otp_win64_25.2.exe
RabbitMQ:rabbitmq-server-3.11.6.exe

erlang下载地址:
https://erlang.org/download/otp_versions_tree.html

rabbitmq下载地址:
https://www.rabbitmq.com/changelog.html

选择安装目录,直接下一步安装即可。

安装完成后,进入RabbitMQ安装目录下的sbin目录:

springcloud-bus-rabbitmq-sbin.pngspringcloud-bus-rabbitmq-sbin.png

打开cmd进入sbin目录,输入以下命令启动管理功能:
rabbitmq-plugins.bat enable rabbitmq_management

如下图示:

springcloud-bus-rabbitmq-plugins.pngspringcloud-bus-rabbitmq-plugins.png

执行完后,在浏览器访问地址查看是否安装成功:http://localhost:15672/

springcloud-bus-rabbitmq-admin.pngspringcloud-bus-rabbitmq-admin.png

输入账号密码guest/guest并登录。

动态刷新配置

使用Spring Cloud Bus动态刷新配置需要配合Spring Cloud Config一起使用,我们使用上一节的config-server、config-client模块来演示该功能。

给config-server添加消息总线支持

pom.xml添加相关依赖:

<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>

添加配置文件application-amqp.yml,主要是添加RabbitMQ的配置及暴露了刷新配置的Actuator端点。

server:
  port: 8904

spring:
  application:
    name: config-server
  cloud:
    config:
      server:
        git:
          # 配置存储配置信息的Git仓库
          uri: https://gitee.com/whwtree/springcloud-config.git
          username: whwtree
          password: Whw123$%
          # 开启启动时直接从git获取配置
          clone-on-start: true
          # 获取子目录下的配置
    #          search-paths: '{application}'
  # rabbitmq相干配置
  rabbitmq:
    host: localhost
    port: 5672
    username: guest
    password: guest

eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://localhost:8001/eureka/

# 暴露bus刷新配置的端点
management:
  endpoints:
    web:
      exposure:
        include: 'bus-refresh'

给config-client添加消息总线支持

pom.xml添加相关依赖:

<dependency>
    <groupId>org.springframework.cloud</groupId>
    <artifactId>spring-cloud-starter-bus-amqp</artifactId>
</dependency>

添加配置文件bootstra-amqp1.yml及bootstrap-amqp2.yml用于启动两个不同的config-client,两个配置文件只有端口号不同;

server:
  port: 9004

spring:
  application:
    name: config-client
  cloud:
    # config客户端配置
    config:
      # 分支名称
      label: master
      # 启用配置后缀名称
      profile: dev
      # 配置文件名称
      name: config
      discovery:
        enabled: true
        service-id: config-server
  # rabbitmq配置
  rabbitmq:
    host: localhost
    port: 5672
    username: guest
    password: guest

eureka:
  client:
    register-with-eureka: true
    fetch-registry: true
    service-url:
      defaultZone: http://localhost:8001/eureka/

management:
  endpoints:
    web:
      exposure:
        include: 'refresh'

动态刷新配置演示

启动相关服务:
eureka-server
config-server(application-amqp.yml)
config-client(bootstrap-amqp1.yml)
config-client(bootstrap-amqp2.yml)

启动所有服务后,登录RabbitMQ控制台可以发现,Spring Cloud Bus创建了springCloudBus的topic,如下图示:

springcloud-bus-rabbitmq-topic.pngspringcloud-bus-rabbitmq-topic.png

以及三个以springCloudBus.anonymous开头的队列,如下图示:

springcloud-bus-rabbitmq-queues.pngspringcloud-bus-rabbitmq-queues.png

调用http://localhost:9004/configInfo,响应结果:

config info for dev(master)

修改Git仓库中master分支下的config-dev.yml配置文件:

config:
  info: "config info for dev(master)"

修改为:

config:
  info: "update config info for dev(master)"
  

使用postman发送post请求调用注册中心的接口刷新所有配置:
http://localhost:8904/actuator/bus-refresh
如下图示:

springcloud-bus-rabbitmq-refresh.pngspringcloud-bus-rabbitmq-refresh.png

刷新后,再分别调用:
http://localhost:9004/configInfo
http://localhost:9005/configInfo
获取配置信息,发现都已经刷新问修改后的配置:

update config info for dev(master)

如果只需要刷新指定实例的配置,可以使用以下格式进行刷新:
http://localhost:8904/actuator/bus-refresh/{destination}
例如,刷新9004端口的config-client:
http://localhost:8904/actuator/bus-refresh/config-client:9004

配合WebHooks使用

WebHooks相当于是一个钩子函数,我们可以配置当向Git仓库push代码时触发这个钩子函数。
这里我们以Gitee为例来介绍下其使用方式,这里当我们向配置仓库push代码时,就会自动刷新服务配置了。
如下图示:

springcloud-bus-gitee-webhooks.pngspringcloud-bus-gitee-webhooks.png

Gitee项目源码地址:
https://gitee.com/whwtree/springcloud-learning.git

(完)

最后修改于:2023年01月07日 12:59

添加新评论