11.Config统一配置中心之手动刷新

Posted 2022-05-06 潮汐先生

Config统一配置中心之手动刷新

• • 前言
  • 手动刷新配置
  • • 实现步骤
    • • 1.@RefreshScope
      • 2.TestController.java
      • 3.开启所有web端点暴露
      • 4.启动
      • 5.修改远端配置文件
      • 6.手动刷新配置文件
      • 7.测试
    • 存在的问题

前言

在上篇文章10.微服务全局配置中心之Config中我们实现了统一配置中心。但是存在一个问题：实际开发中项目的配置文件需要经常变动，这个时候我们在远端修改了配置文件之后就需要挨个重启微服务中的节点（客户端）。有没有不需要重启节点（客户端）的方法呢？答案是肯定的。SpringCloud为我们提供了手动刷新和自动刷新多种方式；现在我们来看下如何使用手动刷新的方式来刷新统一配置中心。

手动刷新配置

上面我们说了，所谓手动刷新配置就是当远端Git仓库中的配置发生变化时，不需要重启微服务就可以直接读取远端修改之后的配置信息。但既然是手动刷新，少不了的还是需要手动执行的步骤。

实现步骤

1.@RefreshScope

该注解用来在不重启微服务的情况下，将当前scope域中的信息刷新为最新的配置信心。具体的使用方法：在使用到配置文件相关属性的java类（一般是Controller文件）上加上该注解即可

2.TestController.java

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
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.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @Author Christy
 * @Date 2021/7/13 9:48
 **/
@RestController
@RequestMapping("/test")
@RefreshScope
public class TestController 
    private static final Logger log = LoggerFactory.getLogger(TestController.class);

    @Value("$username")
    private String username;

    @GetMapping("/hello")
    public String sayHello()
        log.info("Hello " + username + ", Welcome!");
        return "Hello " + username + ", Welcome!";
    

3.开启所有web端点暴露

除了上面我们讲到过的@RefreshScope注解，我们还需要在所有的client端（微服务节点）开启所有web端点暴露

# 配置注册中心
spring.cloud.consul.host=localhost
spring.cloud.consul.port=8500

# 告诉当前Config Client统一配置中心在注册中心的服务id
spring.cloud.config.discovery.service-id=CONFIGSERVER
# 开启当前Config Client 根据服务id去注册中心获取
spring.cloud.config.discovery.enabled=true

# 获取那个配置文件 1.确定分支  2.确定文件名  3.确定环境
spring.cloud.config.label=master
spring.cloud.config.name=configclient
spring.cloud.config.profile=dev

management.endpoints.web.exposure.include=*

4.启动

上面的配置修改完毕后，我们依次启动consul、Config Server、Config client。浏览器输入http://localhost:8911/test/hello，结果如下：

5.修改远端配置文件

上面的预配置文件中我们加载的远端配置文件是configclient-dev.properties，现在我们修改username的值为developer

6.手动刷新配置文件

这个时候还不能直接去访问http://localhost:8911/test/hello，否则得到的结果跟之前是一样的。在这一步我们需要执行http://localhost:8911/actuator/refresh。

首先我们先以Postman的方式进行访问，结果如下：

返回的结果也告诉我们了配置文件中username的属性更新了；

需要注意的是该方法必须以POST方式进行访问；

如果有多个客户端（集群），每个客户端都需要以POST方式访问该URL

我们也可以使用命令行的方式访问该地址：curl -X POST http://localhost:8911/actuator/refresh，结果如下:

可以看到这个结果跟Postman中的结果是一样的；

该命令只可执行一次，如果在Postman或者命令行再次执行，会得到空的结果，如下图：

7.测试

上面工作做完以后，我们就可以测试一下最终的效果；在浏览器输入http://localhost:8911/test/hello，可以看到结果已经变成我们刚才修改的值，如下图：

存在的问题

虽然这种方式在不重启微服务的情况下也确实刷新了配置文件，但是上面我们也说了一旦某个模块（微服务集群）的配置文件修改了，则该集群下的所有节点都要执行上面的刷新操作。这在动辄几十上百的微服务集群中还是比较麻烦的。下一节我们将学习一下如何自动刷新配置文件。

本系列专题源码已经上传至gitee：https://gitee.com/tide001/springcloud_parent，欢迎下载交流