Autowired的注入過程原始碼解析

2022-09-04 18:04:04

一、案例場景

在使用 @Autowired 時，你或多或少都會遇過類似的錯誤：

required a single bean, but 2 were found

為了重現這個錯誤，我們可以先寫一個案例來模擬下。

@RestController
@Slf4j
@Validated
public class StudentController {
    @Autowired
    DataService dataService;
    @RequestMapping(path = "students/{id}", method = RequestMethod.DELETE)
    public void deleteStudent(@PathVariable("id") @Range(min = 1,max = 100) int id) {
        dataService.deleteStudent(id);
    }
}

其中 DataService 是一個介面，其實現依託於 Oracle，程式碼示意如下：

public interface DataService {
    void deleteStudent(int id);
} 
@Repository
@Slf4j
public class OracleDataService implements DataService {
    @Override
    public void deleteStudent(int id) {
        log.info("delete student info maintained by 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");
    }
}

此時，程式就已經無法啟動了，報錯如下：

二、案例解析

首先，我們先來了解下 @Autowired 發生的位置和核心過程。當一個 Bean 被構建時，核心包括兩個基本步驟：

執行 AbstractAutowireCapableBeanFactory#createBeanInstance 方法：通過構造器反射構造出這個 Bean，在此案例中相當於構建出 StudentController 的範例；
執行 AbstractAutowireCapableBeanFactory#populateBean 方法：填充（即設定）這個 Bean，在本案例中，相當於設定 StudentController 範例中被 @Autowired 標記的 dataService 屬性成員。

在步驟 2 中，“填充”過程的關鍵就是執行各種 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（BeanPostProcessor 中的一種）來完成“裝配”過程：找出合適的 DataService 的 bean 並設定給StudentController#dataService。如果深究這個裝配過程，又可以細分為兩個步驟：

尋找出所有需要依賴注入的欄位和方法，參考 AutowiredAnnotationBeanPostProcessor#postProcessProperties 中的程式碼行：

InjectionMetadata metadata = findAutowiringMetadata(beanName, bean.getClass(), pvs);

根據依賴資訊尋找出依賴並完成注入，以欄位注入為例，參考 AutowiredFieldElement#inject 方法：

@Override
protected void inject(Object bean, @Nullable String beanName, @Nullable PropertyValues pvs) throws Throwable {
    Field field = (Field) this.member;
    Object value;
    //省略非關鍵程式碼
    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);
    }
}

當我們根據 DataService 這個型別來找出依賴時，我們會找出 2 個依賴，分別為 CassandraDataService 和 OracleDataService。在這樣的情況下，如果同時滿足以下兩個條件則會丟擲本案例的錯誤：

呼叫 determineAutowireCandidate 方法來選出優先順序最高的依賴，但是發現並沒有優先順序可依據。具體選擇過程可參考DefaultListableBeanFactory#determineAutowireCandidate。

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

@Autowired 要求是必須注入的（即 required 保持預設值為 true），或者註解的屬性型別並不是可以接受多個 Bean 的型別，例如陣列、Map、集合。這點可以參考 DefaultListableBeanFactory#indicatesMultipleBeans 的實現。

三、問題修正

第一，我們可以通過使用標記 @Primary 的方式來讓被標記的候選者有更高優先順序，從而避免報錯。

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

但是這種方式並不一定符合業務需求。

第二，我們可以使用下面的方式去修改：

@Autowired
DataService oracleDataService;

將屬性名和 Bean 名字精確匹配，這樣就可以讓注入選擇不犯難：需要 Oracle 時指定屬性名為 oracleDataService，需要 Cassandra 時則指定屬性名為 cassandraDataService。

第三，還可以採用 @Qualifier 來顯式指定參照的是那種服務，例如採用下面的方式：

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

這種方式之所以能解決問題，在於它能讓尋找出的 Bean 只有一個（即精確匹配），所以壓根不會出現後面的決策過程，可以參考 DefaultListableBeanFactory#doResolveDependency。

public Object doResolveDependency(DependencyDescriptor descriptor, String beanName,
		Set&lt;String&gt; autowiredBeanNames, TypeConverter typeConverter) throws BeansException {
    //...
    Object value = getAutowireCandidateResolver().getSuggestedValue(descriptor);
    //...
}

以上就是Autowired的注入過程原始碼解析的詳細內容，更多關於Autowired注入過程的資料請關注it145.com其它相關文章！

Autowired的注入過程原始碼解析

目錄

一、案例場景

二、案例解析

三、問題修正

熱門文章