快捷導(dǎo)航

apollo動態(tài)刷新ConfigurationProperties注解標(biāo)注的配置類方式

更新時間：2025年12月02日 09:25:53 作者：一只豬啊啊

文章介紹了在Spring Boot中使用Apollo動態(tài)刷新ConfigurationProperties注解標(biāo)注的配置類時遇到的問題,以及官方推薦的兩種解決方案：@RefreshScope和通過EnvironmentChangeEvent,文章通過創(chuàng)建一個Apollo監(jiān)聽類并觸發(fā)EnvironmentChangeEvent來實現(xiàn)配置屬性的實時更新

apollo動態(tài)刷新ConfigurationProperties注解標(biāo)注的配置類

默認(rèn)情況下 apollo無法刷新 ConfigurationProperties標(biāo)注的屬性實時更新

我查看官方文檔他推薦了兩種實現(xiàn)思路

@RefrashScope和通過EnvironmentChangeEvent

這兩個都是在spring-cloud-context中提供的

我簡單舉個例子

/**
 * @Description
 * @Author changyandong
 * @Emoji (゜ - ゜)つ干杯
 * @Created Date: 2019/11/20 9:01
 * @ClassName MsGatewayProperties
 * @Version: 1.0
 */
@Component
@ConfigurationProperties("ms.gateway")
public class MsGatewayProperties {
    private MsGatewayUrlProperties url = new MsGatewayUrlProperties();

    public MsGatewayUrlProperties getUrl() {
        return url;
    }

    public void setUrl(MsGatewayUrlProperties url) {
        this.url = url;
    }
}

/**
 * @Description
 * @Author changyandong
 * @Emoji (゜ - ゜)つ干杯
 * @Created Date: 2019/11/20 9:02
 * @ClassName MsGatewayUrlProperties
 * @Version: 1.0
 */
public class MsGatewayUrlProperties {
    private String sss;
    private String xxx;

    public String getSss() {
        return sss;
    }

    public void setSss(String sss) {
        this.sss = sss;
    }

    public String getXxx() {
        return xxx;
    }

    public void setXxx(String xxx) {
        this.xxx = xxx;
    }
}

然后我創(chuàng)建一個apollo監(jiān)聽類這里的ConfigChangeService是我們框架封裝的

如果自己寫的話一個普通的@ApolloConfigChangeListener類即可

/**
 * @Description
 * @Author changyandong
 * @Emoji (゜ - ゜)つ干杯
 * @Created Date: 2019/11/20 9:00
 * @ClassName MsGatewayAppolloChangeSerivce
 * @Version: 1.0
 */
@Component
public class MsGatewayApolloChangeService implements ConfigChangeService, ApplicationContextAware {

    private Logger logger = LoggerFactory.getLogger(MsGatewayApolloChangeService.class);

    private ApplicationContext applicationContext;

    @Override
    public void detectConfigChanges(ConfigChangeEvent changeEvent) {
        boolean gatewayPropertiesChanged = false;

        for (String changedKey : changeEvent.changedKeys()) {

            //前綴為spring.cloud.gateway的key發(fā)生了改變(gateway的配置發(fā)生了改變)
            if (changedKey.startsWith("ms.gateway")) {
                gatewayPropertiesChanged = true;
                break;
            }
        }

        //更新gateway配置
        if (gatewayPropertiesChanged) {
            refreshGatewayProperties(changeEvent);
        }

    }

    /**
     * 更新SpringApplicationContext對象，并更新路由
     *
     * @param changeEvent
     */
    private void refreshGatewayProperties(ConfigChangeEvent changeEvent) {
        //更新配置
        this.applicationContext.publishEvent(new EnvironmentChangeEvent(changeEvent.changedKeys()));
    }


    @Override
    public int getOrder() {
        return 1;
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }
}

這時他給spring推了一個事件 EnvironmentChangeEvent

這時會觸發(fā)ConfigurationPropertiesRebinder的onApplicationEvent方法進(jìn)而觸發(fā)rebind方法

@Component
@ManagedResource
public class ConfigurationPropertiesRebinder
  implements ApplicationContextAware, ApplicationListener<EnvironmentChangeEvent> {

 private ConfigurationPropertiesBeans beans;

 private ApplicationContext applicationContext;

 private Map<String, Exception> errors = new ConcurrentHashMap<>();

 public ConfigurationPropertiesRebinder(ConfigurationPropertiesBeans beans) {
  this.beans = beans;
 }

 @Override
 public void setApplicationContext(ApplicationContext applicationContext)
   throws BeansException {
  this.applicationContext = applicationContext;
 }

 /**
  * A map of bean name to errors when instantiating the bean.
  * @return The errors accumulated since the latest destroy.
  */
 public Map<String, Exception> getErrors() {
  return this.errors;
 }

 @ManagedOperation
 public void rebind() {
  this.errors.clear();
  // 這里會把標(biāo)注了ConfigurationProperties的所有類都掃一遍
  for (String name : this.beans.getBeanNames()) {
   rebind(name);
  }
 }

 @ManagedOperation
 public boolean rebind(String name) {
  if (!this.beans.getBeanNames().contains(name)) {
   return false;
  }
  // 這里他把對象 銷毀再創(chuàng)建  但是由于我只想刷新我自己的類 這里卻把所有帶ConfigurationProperties注解的都銷毀重新創(chuàng)建 
  // 這樣就很難以讓我們采用這種方式
  if (this.applicationContext != null) {
   try {
    Object bean = this.applicationContext.getBean(name);
    if (AopUtils.isAopProxy(bean)) {
     bean = ProxyUtils.getTargetObject(bean);
    }
    if (bean != null) {
     this.applicationContext.getAutowireCapableBeanFactory()
       .destroyBean(bean);
     this.applicationContext.getAutowireCapableBeanFactory()
       .initializeBean(bean, name);
     return true;
    }
   }
   catch (RuntimeException e) {
    this.errors.put(name, e);
    throw e;
   }
   catch (Exception e) {
    this.errors.put(name, e);
    throw new IllegalStateException("Cannot rebind to " + name, e);
   }
  }
  return false;
 }

 @ManagedAttribute
 public Set<String> getBeanNames() {
  return new HashSet<>(this.beans.getBeanNames());
 }

 @Override
 public void onApplicationEvent(EnvironmentChangeEvent event) {
  if (this.applicationContext.equals(event.getSource())
    // Backwards compatible
    || event.getKeys().equals(event.getSource())) {
   rebind();
  }
 }
}