@RefreshScope 自动刷新配置文件的实例讲解

来一份完整攻略。

什么是@RefreshScope

@RefreshScope 是 Spring Cloud 提供的一种自动刷新配置文件的机制，它可以实时刷新被标记为 @RefreshScope 的 Bean 中的属性。

使用该注解时，需要将需要动态刷新的配置加入Spring Cloud的配置中心(如Spring Cloud Config Server)，之后在应用程序启动时将从配置中心加载 bean 的初始属性。在刷新时，应用程序将重新从配置中心加载所需的属性。

@RefreshScope的应用

1. 配置文件包含 @Value 注解

当配置文件中包含了使用 @Value 注解的属性，我们可以在代码中直接使用 @Value 注解获取配置值，比如：

@Component
@RefreshScope
public class MyConfig {
    @Value("${my.config.property}")
    private String myConfigProperty;

    public String getMyConfigProperty() {
        return myConfigProperty;
    }
}

在应用启动时，会从配置中心加载 my.config.property 的值。如果后续在配置中心中修改了该属性的值，对应的 Bean 会在下次获取 myConfigProperty 时得到新值。

1. 使用 environment 获取配置

如果在 Bean 中，没有使用 @Value 注解获取配置项,而是使用 environment 对象获取，例如：

@Component
@RefreshScope
public class MyConfig {
    @Autowired
    private Environment environment;

    public String getMyConfigProperty() {
        return environment.getProperty("my.config.property");
    }
}

同样地，在启动时会从配置中心加载 my.config.property 的值，当 my.config.property 的值发生变化时，该 Bean 内部的属性也会实时更新。

配置文件的更新

当我们修改了配置中心中的配置文件，如果要让使用 @RefreshScope 的 Bean 获取到最新的配置，需要执行 /actuator/refresh 接口。

可以通过发送 POST 请求 http://localhost:8080/actuator/refresh 来实现配置文件的刷新。当接口调用成功后，相关的 Bean 会在下一次获取值时得到新的属性值。

另外，如果有多个实例的应用同时使用配置中心中的配置文件，只需要修改一处，其他的应用配置也会随之自动更新。

以上就是 @RefreshScope 自动刷新配置文件的攻略。