SpringCloud（第 037 篇）通过bus/refresh半自动刷新ConfigClient配置

一、大致介绍

1、上章节我们讲到了手动刷新配置，但是我们假设如果微服务一多的话，那么我们是不是需要对每台服务进行手动刷新呢？2、答案肯定是不需要的，我们也可以采用 rabbitmq 消息中间件产品来增强刷新机制；3、这里还顺便列举下配置路径的规则：/**************************************************************************************** * 配置服务的路劲规则： * * /{application}/{profile}[/{label}] * /{application}-{profile}.yml * /{label}/{application}-{profile}.yml * /{application}-{profile}.properties * /{label}/{application}-{profile}.properties ****************************************************************************************/

二、实现步骤

2.1 添加 maven 引用包


    
        
     
      4.0.0
         
     
      springms-config-client-refresh-bus
         
     
      1.0-SNAPSHOT
         
     
      jar
         
             
      
       com.springms.cloud
              
      
       springms-spring-cloud
              
      
       1.0-SNAPSHOT
          
         
             
              
                  
       
        org.springframework.cloud
                   
       
        spring-cloud-starter-config
               
              
              
                  
       
        org.springframework.boot
                   
       
        spring-boot-starter-web
               
              
              
                  
       
        org.springframework.boot
                   
       
        spring-boot-starter-actuator
               
              
              
                  
       
        org.springframework.cloud
                   
       
        spring-cloud-starter-bus-amqp

2.2 添加应用配置文件（springms-config-client-refresh-bus/src/main/resources/application.yml）

server:  port: 8300###################################################################################################### 配置服务客户端Client应用入口（正常测试 ConfigClient ）# profile: profile-dev########################################################################################################################################################################################################### 配置服务客户端Client应用入口（链接 ClientServer 测试，同时本地也有一份配置文件，那么该如何抉择呢？）# profile: profile-local-dev#####################################################################################################

2.3 添加 bootstrap.yml 应用配置文件（springms-config-client-refresh-bus/src/main/resources/bootstrap.yml）

###################################################################################################### 配置服务客户端Client应用入口（链接 ClientServer 测试）spring:  cloud:    config:      uri: http://localhost:8220      profile: refreshbus      label: master #当 ConfigServer 的后端存储的是 Git 的时候，默认就是 master    bus:      trace:        enabled: true   # 设置节点状态跟踪，也可以通过网页 http://localhost:8300/trace 可以看到相关发送事件的数据内容  application:    name: foobar  #取 foobar-refreshbus.yml 这个文件的 application 名字，即为 foobar 名称########################################################################################################################################################################################################### rabbitmq 配置：  rabbitmq:    host: localhost   # 登录 Rabbitmq 后台管理页面地址为：http://localhost:15672    port: 5672    username: guest   # 默认账户    password: guest   # 默认密码#####################################################################################################

2.4 添加Web控制层类(springms-config-client-refresh-bus/src/main/java/com/springms/cloud/controller/ConfigClientRefreshBusController.java）

package com.springms.cloud.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;/** * 配置客户端Controller。 * * @author hmilyylimh * * @version 0.0.1 * * @date 17/10/18 * */@RestController@RefreshScopepublic class ConfigClientRefreshBusController {    @Value("${profile}")    private String profile;    @GetMapping("/profile")    public String getProfile(){        return this.profile;    }}

2.5 添加应用启动类（springms-config-client-refresh-bus/src/main/java/com/springms/cloud/MsConfigClientRefreshBusApplication.java）

package com.springms.cloud;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;/** * 通过bus/refresh半自动刷新ConfigClient配置。
 * * ConfigClient 配置客户端服务想要实现自动刷新配置的话，ConfigServer 一端是不要做任何处理，只需要在 ConfigClient 一端处理即可。 * * @author hmilyylimh * * @version 0.0.1 * * @date 17/10/18 * */@SpringBootApplicationpublic class MsConfigClientRefreshBusApplication {    public static void main(String[] args) {        SpringApplication.run(MsConfigClientRefreshBusApplication.class, args);        System.out.println("【【【【【【 ConfigClientRefreshBus微服务 】】】】】】已启动.");    }}

三、测试

/**************************************************************************************** application.yml 涉及到的链接文件内容展示如下： 修改内容前： http://git.oschina.net/ylimhhmily/OpenSource_CustomCircleLineProgressBar/blob/master/foobar-refreshbus.yml profile: profile-refreshbus 修改内容后： http://git.oschina.net/ylimhhmily/OpenSource_CustomCircleLineProgressBar/blob/master/foobar-refreshbus.yml profile: profile-refreshbus-refresh ****************************************************************************************//**************************************************************************************** Rabbitmq 安装步骤（进入 Rabbitmq 官网：http://www.rabbitmq.com）： 1、下载 rabbitmq-server-3.6.11.exe、otp_win64_20.0-rc2.exe 两个 windows 安装软件； 2、双击安装 otp_win64_20.0-rc2.exe； 3、双击安装 rabbitmq-server-3.6.11.exe； 4、两个都安装完后会发现服务中多了一个 Rabbitmq 的服务，服务名称为：RabbitMQ； 5、如果想查看管理界面的话，执行命令：rabbitmq-plugins enable rabbitmq_management，然后重启 RabbitMQ 服务； 6、通过windows命令 netstat -aon|findstr "5672" 查看该端口是否被占用，占用的话，说明安装基本上一切正常； 7、通过 http://localhost:15672 地址可以进入服务端的管理页面； 总结：到此为止，Rabbitmq 已经安装完成，接下来准备接入 SpringCloud 生态圈。 ****************************************************************************************//**************************************************************************************** 一、配置刷新服务客户端Client应用入口（通过 bus/refresh 实现半自动动态刷新配置服务客户端配置）： 1、添加注解 RefreshScope，然后添加引用模块 spring-boot-starter-actuator 监控和管理生产环境的模块； 2、编辑 application.yml、bootstrap.yml 文件，添加相关客户端配置； 3、启动 springms-config-server 模块服务，启动1个端口； 4、启动 springms-config-client-refresh-bus 模块服务，启动3个端口（8300、8301、8302）； 5、在浏览器输入地址 http://localhost:8300/profile 正常情况下会输出远端服务的配置内容（内容为：profile: profile-refreshbus）； 6、在浏览器输入地址 http://localhost:8301/profile 正常情况下会输出远端服务的配置内容（内容为：profile: profile-refreshbus）； 7、在浏览器输入地址 http://localhost:8302/profile 正常情况下会输出远端服务的配置内容（内容为：profile: profile-refreshbus）； 8、修改 http://git.oschina.net/ylimhhmily/OpenSource_CustomCircleLineProgressBar/blob/master/foobar-refreshbus.yml 内容，修改后为 profile: profile-refreshbus-refresh； 9、打开windows命令窗口，执行命令： >curl.exe -X POST http://localhost:8300/bus/refresh 或者端口选择 8301、8302 都可以生效； 10、然后刷新 http://localhost:8300/profile 网页，正常情况下会输出远端服务的配置内容（内容为：profile: profile-refreshbus-refresh）； 11、然后刷新 http://localhost:8301/profile 网页，正常情况下会输出远端服务的配置内容（内容为：profile: profile-refreshbus-refresh）； 12、然后刷新 http://localhost:8302/profile 网页，正常情况下会输出远端服务的配置内容（内容为：profile: profile-refreshbus-refresh）； 总结：这里通过执行刷新命令，然后将多台 ConfigClient 客户端刷新，来达到获取最新的远端服务器配置。      但是这里终究还是得靠手动执行一条刷新命令，但总比每台服务器执行刷新命令要好很多； ****************************************************************************************//**************************************************************************************** 二、配置刷新服务客户端Client应用入口（设置 Git 的 WebHooks 属性，通过 Git 提交代码来实现全自动动态刷新配置服务客户端配置）： 总结：这里我就不做过多的测试，WebHooks 可以设置 POST 的地址，并附上密码，提交代码后动态通知相应服务来实现全自动动态刷新。 ****************************************************************************************//**************************************************************************************** 三、思考问题：凭什么 8300、8301、8302 三台服务器其中一台要承受刷新配置服务的任务？不应该三台服务的角色等级应该相同么？ 基于这种角色等同考虑，可以在 ConfigServer 也配上 Rabbitmq 链接上，然后我们在用命令刷新 ConfigServer 即可，这样就实现了三台 ConfigClient 服务器的角色又等同了； ****************************************************************************************/