Spring Cloud 如何动态刷新 Git 仓库配置？

2022-03-19 10:40:05

本文基于以下讲解：

Spring Cloud Greenwich.SR3
Spring Boot 2.1.7.RELEASE
基于 Git 的配置中心仓库

添加 actuator 依赖

在引用配置中心的项目中添加以下 actuator 依赖：

<dependencies>
    ...
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>   
    ...
</dependencies>

spring-boot-starter-actuator：这个模块的 /actuator/refresh (POST请求)端点可以刷新配置，更多的使用参考 Spring Boot 系列文章。

暴露 refresh 端点

actuator 默认是不暴露 refresh 端点的，需要我们主动暴露，在引用配置中心的项目中添加以下配置：

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

添加刷新范围

引用了配置中心的项目，在需要刷新的 Bean 上添加 @RefreshScope 注解。

示例1：

@RefreshScope
@RestController
public class TestController {

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

}

@RefreshScope
@ConfigurationProperties(prefix = "spring.mail")
public class MailProperties {

...

}

当配置更改时，标有 @RefreshScope 的 Bean 将得到特殊处理来生效配置，不然改了配置不会刷新的。@RefreshScope 的原理可以参考这篇文章：Spring Cloud @RefreshScope 原理是什么？，很详细。