Spring Boot中带@RefreshScope的Bean在POJO类本地变量如何刷新

方案1：依赖RefreshScope代理自动转发（最简实现） #

标注了@RefreshScope的Bean默认会被Spring封装为CGLIB动态代理对象，你在构造函数中通过getBean拿到的就是这个代理实例，只要后续使用配置时直接调用代理对象的getter方法获取属性，不需要额外开发就能自动拿到刷新后的最新值：

public class AssetTaggingEventProcessor
{
   private final ProjectSetting projectSetting;
   // 推荐使用构造注入代替直接从ApplicationContext取Bean，代码更优雅易测试
   AssetTaggingEventProcessor(ProjectSetting projectSetting)
   {
         this.projectSetting = projectSetting;
   }
   
   public void processEvent() {
       // 每次调用getter时，代理会自动路由到最新的配置实例，返回刷新后的值
       if (projectSetting.isSecurityEnabled()) {
           // 业务逻辑
       }
   }
}

注意：禁止在POJO初始化阶段就把securityEnabled这类单个属性值缓存成类的成员变量，否则缓存的静态值不会随配置更新。

方案2：监听刷新事件主动更新（适合需要本地缓存配置的场景） #

如果你确实需要把配置值缓存到POJO的本地变量中，避免每次调用getter的代理转发开销，可以监听Spring Cloud的RefreshScopeRefreshedEvent事件，配置刷新后主动拉取最新值更新本地缓存：

import org.springframework.cloud.context.scope.refresh.RefreshScopeRefreshedEvent;
import org.springframework.context.ApplicationListener;

public class AssetTaggingEventProcessor implements ApplicationListener<RefreshScopeRefreshedEvent>
{
   private final ProjectSetting projectSetting;
   // 本地缓存的配置值
   private boolean securityEnabled;
   
   AssetTaggingEventProcessor(ProjectSetting projectSetting)
   {
         this.projectSetting = projectSetting;
         // 初始化时加载配置
         refreshLocalConfig();
   }
   
   // 配置刷新时Spring会自动触发该方法
   @Override
   public void onApplicationEvent(RefreshScopeRefreshedEvent event) {
       refreshLocalConfig();
   }
   
   private void refreshLocalConfig() {
       this.securityEnabled = projectSetting.isSecurityEnabled();
       // 其余需要刷新的本地配置字段统一在该方法中赋值
   }
}

注意：该方案要求AssetTaggingEventProcessor必须是Spring管理的Bean才能正常接收到刷新事件。如果是你自行实例化的非Spring管理POJO，需要手动将实例注册到Spring上下文的监听器列表中，否则监听逻辑不生效。

方案3：使用@ConfigurationProperties规范配置（官方推荐写法） #

Spring Boot官方更推荐用@ConfigurationProperties封装批量配置属性，搭配@RefreshScope使用稳定性更好，不需要逐个写@Value注解：

// 配置属性类
@ConfigurationProperties(prefix = "security")
@RefreshScope
@Getter
@Setter
public class SecurityProperties {
    // 对应配置项security.enabled，默认值为true
    private boolean enabled = true;
}

在启动类上添加@EnableConfigurationProperties(SecurityProperties.class)注解即可正常注入使用，用法和你现有的ProjectSetting完全一致。

内容的提问来源于stack exchange，提问作者Nishant Modi