Spring竟然可以建立“重複”名稱的bean？—一次專案中存在多個bean名稱重複問題的排查

京東雲開發者發表於2023-03-28
SpringBean

作者：京東科技 韓國凱

一、專案中存在了名稱重複的bean

眾所周知，在Spring中時不能夠建立兩個名稱相同的bean的，否則會在啟動時報錯：

image-20230322100944642

但是我卻在我們的spring專案中發現了兩個相同名稱的bean，並且專案也可以正常啟動，對應的bean也可以正常使用。

因為專案原因中會用到多個redis叢集，所以有配置了多個redis環境，並且在id上做了區分。

但是在配置redis環境的時候，兩個環境bean的id卻是相同的。

<bean id="cacheClusterConfigProvider" class="com.xxx.rediscluster.provider.CacheClusterConfigProvider">
    <property name="providers">
        <list>
            //建立了一個名為 ccProvider 的bean
            <bean id="ccProvider" class="com.xxx.rediscluster.provider.CCProvider">
                <!--# 替換為當前環境的R2M 3C配置中心地址（詳見上方R2M 3C服務地址）-->
                <property name="address" value="${r2m.zkConnection}"/>
                <!--# 替換為R2M叢集名-->
                <property name="appName" value="${r2m.appName}"/>
                <!--# 替換為當前環境的客戶端對應配置中心token口令（參考上方token獲取方式）-->
                <property name="token" value="${r2m.token}"/>
                <!--# 替換為叢集認證密碼-->
                <property name="password" value="${r2m.password}"/>
            </bean>
        </list>
    </property>
</bean>

<bean id="tjCacheClusterConfigProvider" class="com.xxx.rediscluster.provider.CacheClusterConfigProvider">
    <property name="providers">
        <list>
            //這裡竟然也是 ccProvider 
            <bean id="ccProvider" class="com.xxx.rediscluster.provider.CCProvider">
                <!--# 替換為當前環境的R2M 3C配置中心地址（詳見上方R2M 3C服務地址）-->
                <property name="address" value="${r2m.tj.zkConnection}"/>
                <!--# 替換為R2M叢集名-->
                <property name="appName" value="${r2m.tj.appName}"/>
                <!--# 替換為當前環境的客戶端對應配置中心token口令（參考上方token獲取方式）-->
                <property name="token" value="${r2m.tj.token}"/>
                <!--# 替換為叢集認證密碼-->
                <property name="password" value="${r2m.tj.password}"/>
            </bean>
        </list>
    </property>
</bean>

大家也都知道，<bean>標籤可以宣告一個bean，是肯定會被spring解析並且使用的，那麼為什麼在這裡面兩個相同的bean名稱卻不會報錯呢？

image-20230322103204708

可以看到我們建立的bean是正常的，並且從功能上來說也是可以使用的。

二、問題的排查過程

2.1 嘗試直接找到建立重複bean位置

首先debug嘗試找到建立重複bean時的相關資訊，看看有沒有什麼思路

image-20230322103624912

然後重啟專案，選擇debug模式，但是在執行之後IDEA提示斷點被跳過了

image-20230322104033613

查閱了一些資料跟方式都不起作用，遂放棄此思路。

2.2 從建立其父bean開始尋找思路

放棄了上述思路後想到，可以憑藉之前學習的spring原始碼從程式碼層面去排查此問題

將斷點設定到建立reids bean處

image-20230322104714244

果然，斷點在這裡是能進來的

image-20230322104804469

那麼我們的思路就很簡單了。

在spring中，裝配屬性的步驟發生在：populateBean(beanName, mbd, instanceWrapper)的過程中，如果發現其屬性也是一個bean，那麼會先獲取bean，如果不存在則會先建立其屬性bean，然後建立完成之後將屬性bean賦值給要裝配的bean。

//迴圈要裝配bean的所有屬性
for (PropertyValue pv : original) {
   if (pv.isConverted()) {
      deepCopy.add(pv);
   }
   else {
      String propertyName = pv.getName();
      Object originalValue = pv.getValue();
      //獲取真正要裝配的bean
      Object resolvedValue = valueResolver.resolveValueIfNecessary(pv, originalValue);
      Object convertedValue = resolvedValue;
      boolean convertible = bw.isWritableProperty(propertyName) &&
            !PropertyAccessorUtils.isNestedOrIndexedProperty(propertyName);
   }
}

從debug中也可以看出，我們bean的屬性只有一個，也就是providers，符合我們在上面xml中配置的屬性

image-20230322105338830

我們從真正建立要裝配的bean的地方開始找找什麼時候開始建立bean的

private Object resolveInnerBean(Object argName, String innerBeanName, BeanDefinition innerBd) {
   RootBeanDefinition mbd = null;
   try {
      ...
      // 真正建立bean的地方
      Object innerBean = this.beanFactory.createBean(actualInnerBeanName, mbd, null);
      if (innerBean instanceof FactoryBean) {
         boolean synthetic = mbd.isSynthetic();
         return this.beanFactory.getObjectFromFactoryBean(
               (FactoryBean<?>) innerBean, actualInnerBeanName, !synthetic);
      }
      else {
         return innerBean;
      }
   }
   catch (BeansException ex) {
      throw new BeanCreationException(
            this.beanDefinition.getResourceDescription(), this.beanName,
            "Cannot create inner bean '" + innerBeanName + "' " +
            (mbd != null && mbd.getBeanClassName() != null ? "of type [" + mbd.getBeanClassName() + "] " : "") +
            "while setting " + argName, ex);
   }
}

createBean(actualInnerBeanName, mbd, null)這行程式碼如果有小夥伴閱讀過spring原始碼一定不陌生，透過這個方法可以獲得要建立的bean物件。

image-20230322152949119

從debug中也可以看到真正要建立的beanName已經換成了我們的想要裝配的屬性ccProvider

至此我們已經發現了，和我們的預期一致，<bean>標籤無論在什麼位置確實會建立一個bean物件。

那麼為什麼這裡的beanName不怕重複呢？

2.3 為什麼這裡的bean不會出現重複的問題

回顧剛剛之前提到的spring不允許重複名稱的bean，其實很好理解，因為我們在建立bean的過程中，會將建立好的bean以beanName為key放到快取的map中，如果我們有兩個相同名稱的bean，那麼當存在重複的bean時，第二個bean會將第一個bean給覆蓋掉。

這樣的話，就不存在唯一性了，別的bean需要依賴重複的bean的時候有可能返回的並不是同一個bean。

那麼為什麼這裡兩個bean並不會重複呢？

其實細心的讀者已經發現了，這裡變數名稱是innerBean，說明他是一個內部bean，那麼innerBean與普通的bean有什麼不同呢？為什麼innerBean並不會產生 名稱重複的問題呢？

我們重新梳理下建立普通bean的流程：

innerbean.drawio

其實答案已經很明顯了：

如果我們建立的是一個普通bean，在建立完成之後會將bean放置到快取中，如果有其他bean要使用直接從快取中取走就可以了，而beanName不能重複也是基於此考慮。

而建立innerBean則基於createBean()原子性操作前提，只會返回建立好的bean，並不會將其加入到spring的bean快取中，因此也就不存在beanName重複的問題了

三、總結

3.1 為什麼spring可以存在”重複“名稱的bean

我們這裡重新梳理下bean的建立流程：

在spring注入一個普通bean的過程中，會將透過反射建立的空屬性物件賦值，如果發現其依賴的屬性也是一個bean，那麼會首先去獲取這個bean，如果獲取不到的話則會轉而去建立bean。

而此時要建立的bean成為innerBean，並不會被spring其他bean共享，所以可以在名稱上是重複的。

3.2 innerBean的用法

還是我們剛剛的例子，我們可以將其改寫成下面的這個樣子：

<bean id="cacheClusterConfigProvider" class="com.wangyin.rediscluster.provider.CacheClusterConfigProvider">
    <property name="providers">
        <list>
            <!--# 引用ccProviderRef-->
            <ref bean="ccProviderRef"></ref>
        </list>
    </property>
</bean>

<!--# 定義了一個公共的ccProviderRef-->
<bean id="ccProviderRef" class="com.wangyin.rediscluster.provider.CCProvider">
    <!--# 替換為當前環境的R2M 3C配置中心地址（詳見上方R2M 3C服務地址）-->
    <property name="address" value="${r2m.zkConnection}"/>
    <!--# 替換為R2M叢集名-->
    <property name="appName" value="${r2m.appName}"/>
    <!--# 替換為當前環境的客戶端對應配置中心token口令（參考上方token獲取方式）-->
    <property name="token" value="${r2m.token}"/>
    <!--# 替換為叢集認證密碼-->
    <property name="password" value="${r2m.password}"/>
</bean>

在上面的例子中我們定義了一個普通bean，並將其引用到我們想要的屬性中。

此時ccProviderRef作為一個普通bean，是可以被其他bean引用的，但是此時bean的名稱就不可重複。

相關文章