Spring Boot 配置如何实现动态刷新？ | 码猿技术专栏

<!-- springCloud的依赖-->
<dependencyManagement>
    <dependencies>
        <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-dependencies</artifactId>
                <version>Hoxton.SR3</version>
                <type>pom</type>
                <scope>import</scope>
            </dependency>
    </dependencies>
</dependencyManagement>

<!-- config的依赖-->
<dependency>
      <groupId>org.springframework.cloud</groupId>
      <artifactId>spring-cloud-starter-config</artifactId>
    </dependency>

  <!-- actuator的依赖-->
    <dependency>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>

配置文件中暴露Spring Boot的端点，如下：

1	management.endpoints.web.exposure.include=*

配置文件中新增三个属性配置：

1
2
3

config.version=22
config.app.name=dynamic-project
config.platform=mysql

结合 @RefreshScope 注解动态刷新，写个Controller，如下：

@RestController
//@RefreshScope该注解必须标注，否则无法完成动态更新
@RefreshScope
public class DynamicConfigController {
    @Value("${config.version}")
    private String version;

    @Value("${config.app.name}")
    private String appName;

    @Value("${config.platform}")
    private String platform;


    @GetMapping("/show/version")
    public String test(){
        return "version="+version+"-appName="+appName+"-platform="+platform;
    }

启动项目测试，浏览器访问 http://localhost:8080/show/version ，返回信息如下图：

修改 target 目录下的配置文件，如下：

1
2
3

config.version=33
config.app.name=dynamic-project
config.platform=ORACLE

POST请求 http://localhost:8080/actuator/refresh 接口，手动刷新下配置（必须，否则不能自动刷新）

浏览器再次输入 http://localhost:8080/show/version ，结果如下图：

可以看到，配置已经自动修改了，结束。

方案二（推荐）

看到了方案一觉得如何？是不是有点鸡肋了

第一个问题：为什么还要调用一次手动刷新呢？

第二个问题：只能手动的在配置文件中改吗？如果想在后台管理系统改怎么办？

想要解决上述两个问题还是要看下 Config 的源码，代码关键部分在 org.springframework.cloud.context.refresh.ContextRefresher#refresh() 方法中，如下图：

因此只需要在修改属性之后调用下 ContextRefresher#refresh() （异步，避免一直阻塞等待）方法即可。

为了方便测试，我们自己手动写一个refresh接口，如下：

@GetMapping("/show/refresh")
    public String refresh(){
        //修改配置文件中属性
        HashMap<String, Object> map = new HashMap<>();
        map.put("config.version",99);
        map.put("config.app.name","appName");
        map.put("config.platform","ORACLE");
        MapPropertySource propertySource=new MapPropertySource("dynamic",map);
        //将修改后的配置设置到environment中
        environment.getPropertySources().addFirst(propertySource);
        //异步调用refresh方法，避免阻塞一直等待无响应
        new Thread(() -> contextRefresher.refresh()).start();
        return "success";
    }

上述代码中作者只是手动设置了配置文件中的值，实际项目中可以通过持久化的方式从数据库中读取配置刷新。

下面我们测试看看，启动项目，访问 http://localhost:8080/show/version ，发现是之前配置在 application.properties 中的值，如下图：

调用 refresh 接口： http://localhost:8080/show/refresh 重新设置属性值；

再次调用 http://localhost:8080/show/version 查看下配置是否修改了，如下图：

从上图可以发现，配置果然修改了，达到了动态刷新的效果。

总结

本文从微服务的配置中心介绍到Spring Boot 搭建简易的配置中心，详细介绍了几种可行性的方案，作者强力推荐最后一种方案，简化版的 Config ，完全适用于单体应用。