關於Spring的@Autowired依賴註入常見錯誤的總結

Posted on by

做不到雨露均沾

經常會遇到，required a single bean, but 2 were found。

根據ID移除學生
DataService是個接口，其實現依賴Oracle：

現在期望把部分非核心業務從Oracle遷移到Cassandra，自然會先添加上一個新的DataService實現：

@Repository
@Slf4j
public class CassandraDataService implements DataService{
    @Override
    public void deleteStudent(int id) {
        log.info("delete student info maintained by cassandra");
    }
}

當完成支持多個數據庫的準備工作時，程序就已經無法啟動瞭，報錯如下：

解析

當一個Bean被構建時的核心步驟：

  • 執行AbstractAutowireCapableBeanFactory#createBeanInstance：通過構造器反射出該Bean，如構建StudentController實例
  • 執行AbstractAutowireCapableBeanFactory#populate：填充設置該Bean，如設置StudentController實例中被 @Autowired 標記的dataService屬性成員。

“填充”過程的關鍵就是執行各種BeanPostProcessor處理器，關鍵代碼如下：

protected void populateBean(String beanName, RootBeanDefinition mbd, @Nullable BeanWrapper bw) {
      //省略非關鍵代碼
      for (BeanPostProcessor bp : getBeanPostProcessors()) {
         if (bp instanceof InstantiationAwareBeanPostProcessor) {
            InstantiationAwareBeanPostProcessor ibp = (InstantiationAwareBeanPostProcessor) bp;
            PropertyValues pvsToUse = ibp.postProcessProperties(pvs, bw.getWrappedInstance(), beanName);
          //省略非關鍵代碼
         }
      }
   }   
}

因為StudentController含標記為Autowired的成員屬性dataService，所以會使用到AutowiredAnnotationBeanPostProcessor完成“裝配”：找出合適的DataService bean，設置給StudentController#dataService。
裝配過程：

1.尋找所有需依賴註入的字段和方法：AutowiredAnnotationBeanPostProcessor#postProcessProperties

2.根據依賴信息尋找依賴並完成註入。比如字段註入，參考AutowiredFieldElement#inject方法：

@Override
protected void inject(Object bean, @Nullable String beanName, @Nullable PropertyValues pvs) throws Throwable {
   Field field = (Field) this.member;
   Object value;
   // ...
      try {
          DependencyDescriptor desc = new DependencyDescriptor(field, this.required);
         // 尋找“依賴”，desc為"dataService"的DependencyDescriptor
         value = beanFactory.resolveDependency(desc, beanName, autowiredBeanNames, typeConverter);
      }
      
   }
   // ...
   if (value != null) {
      ReflectionUtils.makeAccessible(field);
      // 裝配“依賴”
      field.set(bean, value);
   }
}

案例中的錯誤就發生在上述“尋找依賴”的過程中，DefaultListableBeanFactory#doResolveDependency

當根據DataService類型找依賴時，會找出2個依賴：

  • CassandraDataService
  • OracleDataService

在這樣的情況下，如果同時滿足以下兩個條件則會拋出本案例的錯誤：

  • 調用determineAutowireCandidate方法來選出優先級最高的依賴，但是發現並沒有優先級可依據。具體選擇過程可參考
DefaultListableBeanFactory#determineAutowireCandidate：
protected String determineAutowireCandidate(Map<String, Object> candidates, DependencyDescriptor descriptor) {
   Class<?> requiredType = descriptor.getDependencyType();
   String primaryCandidate = determinePrimaryCandidate(candidates, requiredType);
   if (primaryCandidate != null) {
      return primaryCandidate;
   }
   String priorityCandidate = determineHighestPriorityCandidate(candidates, requiredType);
   if (priorityCandidate != null) {
      return priorityCandidate;
   }
   // Fallback
   for (Map.Entry<String, Object> entry : candidates.entrySet()) {
      String candidateName = entry.getKey();
      Object beanInstance = entry.getValue();
      if ((beanInstance != null && this.resolvableDependencies.containsValue(beanInstance)) ||
            matchesBeanName(candidateName, descriptor.getDependencyName())) {
         return candidateName;
      }
   }
   return null;
}

優先級的決策是先根據@Primary，其次是@Priority，最後根據Bean名嚴格匹配。
如果這些幫助決策優先級的註解都沒有被使用，名字也不精確匹配，則返回null，告知無法決策出哪種最合適。

@Autowired要求是必須註入的（required默認值true），或註解的屬性類型並不是可以接受多個Bean的類型，例如數組、Map、集合。
這點可以參考DefaultListableBeanFactory#indicatesMultipleBeans：

private boolean indicatesMultipleBeans(Class<?> type) {
   return (type.isArray() || (type.isInterface() &&
         (Collection.class.isAssignableFrom(type) || Map.class.isAssignableFrom(type))));
}

案例程序能滿足這些條件，所以報錯並不奇怪。而如果我們把這些條件想得簡單點，或許更容易幫助我們去理解這個設計。就像我們遭遇多個無法比較優劣的選擇，卻必須選擇其一時，與其偷偷地隨便選擇一種，還不如直接報錯，起碼可以避免更嚴重的問題發生。

修正

打破上述兩個條件中的任何一個即可，即讓候選項具有優先級或根本不選擇。
但並非每種條件的打破都滿足實際需求：
如可以通過使用**@Primary**讓被標記的候選者有更高優先級，但並不一定符合業務需求，好比我們本身需要兩種DB都能使用，而非不可兼得。

@Repository
@Primary
@Slf4j
public class OracleDataService implements DataService{
    //省略非關鍵代碼
}

要同時支持多種DataService，不同情景精確匹配不同的DataService，可這樣修改：

@Autowired
DataService oracleDataService;

將屬性名和Bean名精確匹配，就能實現完美的註入選擇：

  • 需要Oracle時指定屬性名為oracleDataService
  • 需要Cassandra時則指定屬性名為cassandraDataService

顯式引用Bean時首字母忽略大小寫

還有另外一種解決辦法，即采用@Qualifier顯式指定引用服務，例如采用下面的方式：

@Autowired()
@Qualifier("cassandraDataService")
DataService dataService;

這樣能讓尋找出的Bean隻有一個（即精確匹配），無需後續的決策過程：

DefaultListableBeanFactory#doResolveDependency

@Nullable
public Object doResolveDependency(DependencyDescriptor descriptor, @Nullable String beanName,
      @Nullable Set<String> autowiredBeanNames, @Nullable TypeConverter typeConverter) throws BeansException {
      //省略其他非關鍵代碼
      //尋找bean過程
      Map<String, Object> matchingBeans = findAutowireCandidates(beanName, type, descriptor);
      if (matchingBeans.isEmpty()) {
         if (isRequired(descriptor)) {
            raiseNoMatchingBeanFound(type, descriptor.getResolvableType(), descriptor);
         }
         return null;
      }
      //省略其他非關鍵代碼
      if (matchingBeans.size() > 1) {
         //省略多個bean的決策過程，即案例1重點介紹內容
      } 
     //省略其他非關鍵代碼
}

使用 @Qualifier 指定名稱匹配，最終隻找到唯一一個。但使用時，可能會忽略Bean名稱首字母大小寫。
如：

@Autowired
@Qualifier("CassandraDataService")
DataService dataService;

運行報錯：

Exception encountered during context initialization - cancelling refresh
attempt: org.springframework.beans.factory.UnsatisfiedDependencyException:
 Error creating bean with name 'studentController': Unsatisfied dependency
  expressed through field 'dataService'; nested exception is
   org.springframework.beans.factory.NoSuchBeanDefinitionException: No
    qualifying bean of type 'com.spring.puzzle.class2.example2.DataService'
     available: expected at least 1 bean which qualifies as autowire
      candidate. Dependency annotations:
       {@org.springframework.beans.factory.annotation.Autowired(required=true),
        @org.springframework.beans.factory.annotation.Qualifier(value=CassandraDataService)}

若未顯式指定 bean 名稱，默認就是類名，不過首字母小寫！

假設要支持SQLServer，定義瞭一個名為SQLServerDataService的實現：

@Autowired
@Qualifier("sQLServerDataService")
DataService dataService;

依然出現之前錯誤，而若改成SQLServerDataService，則運行通過。
這真是瘋瞭呀！

顯式引用Bean時，首字母到底是大寫還是小寫？

答疑

raiseNoMatchingBeanFound(type, descriptor.getResolvableType(),
	descriptor);

當因名稱問題（例如引用Bean首字母搞錯瞭）找不到Bean，會拋NoSuchBeanDefinitionException。

不顯式設置名字的Bean，其默認名稱首字母到底是大寫還是小寫呢？
Spring Boot應用會自動掃包，找出直接或間接標記瞭 @Component 的BeanDefinition。例如CassandraDataService、SQLServerDataService都被標記瞭@Repository，而Repository本身被@Component標記，所以都間接標記瞭@Component。

一旦找出這些Bean信息，就可生成Bean名，然後組合成一個個BeanDefinitionHolder返回給上層:

ClassPathBeanDefinitionScanner#doScan

BeanNameGenerator#generateBeanName產生Bean名，有兩種實現方式：

因為DataService實現都是使用註解，所以Bean名稱的生成邏輯最終調用的其實是

AnnotationBeanNameGenerator#generateBeanName

看Bean有無顯式指明名稱，若：

  • 有

用顯式名稱

  • 沒有

生成默認名稱

案例沒有給Bean指名，所以生成默認名稱，通過方法：

buildDefaultBeanName

首先，獲取一個簡短的ClassName，然後調用Introspector#decapitalize方法，設置首字母大寫或小寫，具體參考下面的代碼實現：

  • 一個類名是以兩個大寫字母開頭，則首字母不變
  • 其它情況下默認首字母變成小寫

SQLServerDataService的Bean，其名稱應該就是類名本身，而CassandraDataService的Bean名稱則變成瞭首字母小寫（cassandraDataService）。

修正

引用處修正

@Autowired
@Qualifier("cassandraDataService")
DataService dataService;

定義處顯式指定Bean名字，我們可以保持引用代碼不變，而通過顯式指明CassandraDataService 的Bean名稱為CassandraDataService來糾正這個問題。

@Repository("CassandraDataService")
@Slf4j
public class CassandraDataService implements DataService {
  //省略實現
}

如果你不太瞭解源碼，不想糾結於首字母到底是大寫還是小寫，建議第二種方法

引用內部類的Bean遺忘類名

這就能搞定所有Bean顯式引用不出 bug 嗎？
沿用上面案例，稍微再添加點別的需求，例如我們需要定義一個內部類來實現一種新的DataService，代碼如下：

public class StudentController {
    @Repository
    public static class InnerClassDataService implements DataService{
        @Override
        public void deleteStudent(int id) {
          //空實現
        }
    }
    // ...
 }

這時一般都用下面的方式直接去顯式引用這個Bean：

@Autowired
@Qualifier("innerClassDataService")
DataService innerClassDataService;

那直接采用首字母小寫，這樣就萬無一失瞭嗎？
仍報錯“找不到Bean”，why？

答疑

現在問題是“如何引用內部類的Bean”。
在AnnotationBeanNameGenerator#buildDefaultBeanName，隻關註瞭首字母是否小寫，而在最後變換首字母前，有這麼一行處理 class 名稱的：

我們可以看下它的實現：

ClassUtils#getShortName

假設是個內部類，例如下面的類名：

com.javaedge.StudentController.InnerClassDataService

經過該方法處理後，得到名稱：

StudentController.InnerClassDataService

最後經Introspector.decapitalize首字母變換，得到Bean名稱：

studentController.InnerClassDataService

所以直接使用 innerClassDataService 找不到想要的Bean。

修正

@Autowired
@Qualifier("studentController.InnerClassDataService")
DataService innerClassDataService;

總結

像第一個案例，同種類型的實現，可能不是同時出現在自己的項目代碼中，而是有部分實現出現在依賴的類庫。看來研究源碼的確能讓我們少寫幾個 bug！

到此這篇關於關於Spring的@Autowired依賴註入常見錯誤的總結的文章就介紹到這瞭,更多相關Spring @Autowired 依賴註入內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

推薦閱讀：