問題的引入

在Spring應(yīng)用收到/actuator/refresh的POST請(qǐng)求后，標(biāo)注了@RefreshScope以及@ConfiguratioinProperties的bean會(huì)被Spring容器重新加載。這樣，如果配置文件（一般來自于配置中心，或者k8s的ConfigMap）發(fā)生了變化，那么這些變化就會(huì)因?yàn)锽ean的重新加載而被應(yīng)用感知。

但是，在實(shí)際應(yīng)用中，可能會(huì)發(fā)現(xiàn)有些標(biāo)注了@ConfigurationProperties的bean，并沒有按照預(yù)期被Spring容器加載。本文將討論導(dǎo)致這種未按預(yù)期刷新的一種原因。

結(jié)論

在進(jìn)行詳細(xì)的討論之前，先把結(jié)論寫出來。如果大家時(shí)間緊張，而且碰巧遇到了這樣的問題，可以直接根據(jù)結(jié)論把問題解決掉。

確保標(biāo)注了@ConfigurationProperties注解的bean沒有被任何Advisor依賴

比如：如下的Bean就不會(huì)被Spring容器刷新。

@ConfigurationProperties(prefix="com.dadaer.test")
public class MyProp {
  //...
}

// ............

@Component
public class MyAdvisor extends AbstractPointcutAdvisor {
   
   private final MyProp myProp;
   
   public class MyAdvisor(MyProp myProp) {
     this.myProp = myProp;
   }

  //...
}

這里的MyAdvisor依賴了MyProp，所以在收到/actuator/refresh的請(qǐng)求以后，MyProp的bean不會(huì)被重新加載。

分析

應(yīng)用啟動(dòng)階段

在Spring應(yīng)用啟動(dòng)時(shí)，在執(zhí)行到AbstractApplicationContext#refresh方法初始化容器的時(shí)候，其中有一個(gè)步驟（12大步中的第5步），Spring會(huì)向容器中注入所有的BeanPostProcessor，代碼如下：

// Register bean processors that intercept bean creation.
registerBeanPostProcessors(beanFactory);

而其中有一個(gè)BeanPostProcessor叫做：ConfigurationPropertiesBeans，是一個(gè)用來注冊(cè)所有標(biāo)注了@ConfigurationProperties注解的后置處理器。

在初始化BeanPostProcessor的時(shí)候，會(huì)經(jīng)歷到下面的一段代碼：

@Override
protected boolean shouldSkip(Class<?> beanClass, String beanName) {
    // TODO: Consider optimization by caching the list of the aspect names
    List<Advisor> candidateAdvisors = findCandidateAdvisors();
    for (Advisor advisor : candidateAdvisors) {
       if (advisor instanceof AspectJPointcutAdvisor pointcutAdvisor &&
             pointcutAdvisor.getAspectName().equals(beanName)) {
          return true;
       }
    }
    return super.shouldSkip(beanClass, beanName);
}

這里，會(huì)查找所有的Advisor并初始化。這樣，如果某個(gè)Advisor（比如上述MyAdvisor）依賴了一個(gè)@ConfigurationProperties注解的類（比如上述MyProp）。那么此時(shí)MyProp就需要在BeanPostProcessor之前初始化完成，即：MyProp先于ConfigurationPropertiesBeans完成初始化。

應(yīng)用運(yùn)行階段

在應(yīng)用運(yùn)行階段，當(dāng)收到/actuator/refresh的POST請(qǐng)求時(shí)，會(huì)觸發(fā)RefreshEndpoint：

@Endpoint(id = "refresh")
public class RefreshEndpoint {
    //...
    @WriteOperation
    public Collection<String> refresh() {
       Set<String> keys = this.contextRefresher.refresh();
       return keys;
    }
}

然后調(diào)用ContextRefresher#refresh方法進(jìn)入下面的代碼：

public synchronized Set<String> refreshEnvironment() {
    Map<String, Object> before = extract(this.context.getEnvironment().getPropertySources());
    updateEnvironment();
    Set<String> keys = changes(before, extract(this.context.getEnvironment().getPropertySources())).keySet();
    this.context.publishEvent(new EnvironmentChangeEvent(this.context, keys));
    return keys;
}

這里，發(fā)送了一個(gè)EnvironmentChangeEvent事件，這個(gè)事件會(huì)被ConfigurationPropertiesRebinder捕獲，如下：

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

然后rebind方法被調(diào)用：

@ManagedOperation
public void rebind() {
    this.errors.clear();
    for (String name : this.beans.getBeanNames()) {
       rebind(name);
    }
}

這里beans變量的類型是：ConfigurationPropertiesBeans，它里面保存了所有待刷新的ConfigurationProperties的bean。

結(jié)論

因?yàn)閱?dòng)階段中，MyProp優(yōu)先于ConfigurationPropertiesBeans被加載，導(dǎo)致ConfigurationPropertiesBeans里面不會(huì)包含MyProp這個(gè)bean，從而導(dǎo)致它不會(huì)被刷新。

以上就是Spring應(yīng)用中使用acutator/refresh刷新屬性不生效的問題分析及解決的詳細(xì)內(nèi)容，更多關(guān)于Spring使用acutator/refresh不生效的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論