一、案例場(chǎng)景

在使用 @Autowired 時(shí)，你或多或少都會(huì)遇過類似的錯(cuò)誤：

required a single bean, but 2 were found

為了重現(xiàn)這個(gè)錯(cuò)誤，我們可以先寫一個(gè)案例來模擬下。

@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 是一個(gè)接口，其實(shí)現(xiàn)依托于 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");
    }
}

截止目前，運(yùn)行并測(cè)試程序是毫無問題的。直到某天，我們接到節(jié)約成本的需求，希望把一些部分非核心的業(yè)務(wù)從 Oracle 遷移到社區(qū)版 Cassandra，所以我們自然會(huì)先添加上一個(gè)新的 DataService 實(shí)現(xiàn)，代碼如下：

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

此時(shí)，程序就已經(jīng)無法啟動(dòng)了，報(bào)錯(cuò)如下：

二、案例解析

首先，我們先來了解下 @Autowired 發(fā)生的位置和核心過程。當(dāng)一個(gè) Bean 被構(gòu)建時(shí)，核心包括兩個(gè)基本步驟：

• 執(zhí)行 AbstractAutowireCapableBeanFactory#createBeanInstance 方法：通過構(gòu)造器反射構(gòu)造出這個(gè) Bean，在此案例中相當(dāng)于構(gòu)建出 StudentController 的實(shí)例；
• 執(zhí)行 AbstractAutowireCapableBeanFactory#populateBean 方法：填充（即設(shè)置）這個(gè) Bean，在本案例中，相當(dāng)于設(shè)置 StudentController 實(shí)例中被 @Autowired 標(biāo)記的 dataService 屬性成員。

在步驟 2 中，“填充”過程的關(guān)鍵就是執(zhí)行各種 BeanPostProcessor 處理器，關(guān)鍵代碼如下：

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

在上述代碼執(zhí)行過程中，因?yàn)?StudentController 含有標(biāo)記為 Autowired 的成員屬性 dataService，所以會(huì)使用到AutowiredAnnotationBeanPostProcessor（BeanPostProcessor 中的一種）來完成“裝配”過程：找出合適的 DataService 的 bean 并設(shè)置給StudentController#dataService。如果深究這個(gè)裝配過程，又可以細(xì)分為兩個(gè)步驟：

• 尋找出所有需要依賴注入的字段和方法，參考 AutowiredAnnotationBeanPostProcessor#postProcessProperties 中的代碼行：

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

• 根據(jù)依賴信息尋找出依賴并完成注入，以字段注入為例，參考 AutowiredFieldElement#inject 方法：

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

當(dāng)我們根據(jù) DataService 這個(gè)類型來找出依賴時(shí)，我們會(huì)找出 2 個(gè)依賴，分別為 CassandraDataService 和 OracleDataService。在這樣的情況下，如果同時(shí)滿足以下兩個(gè)條件則會(huì)拋出本案例的錯(cuò)誤：

• 調(diào)用 determineAutowireCandidate 方法來選出優(yōu)先級(jí)最高的依賴，但是發(fā)現(xiàn)并沒有優(yōu)先級(jí)可依據(jù)。具體選擇過程可參考DefaultListableBeanFactory#determineAutowireCandidate。

優(yōu)先級(jí)的決策是先根據(jù) @Primary 來決策，其次是 @Priority 決策，最后是根據(jù) Bean 名字的嚴(yán)格匹配來決策。如果這些幫助決策優(yōu)先級(jí)的注解都沒有被使用，名字也不精確匹配，則返回 null，告知無法決策出哪種最合適。

• @Autowired 要求是必須注入的（即 required 保持默認(rèn)值為 true），或者注解的屬性類型并不是可以接受多個(gè) Bean 的類型，例如數(shù)組、Map、集合。這點(diǎn)可以參考 DefaultListableBeanFactory#indicatesMultipleBeans 的實(shí)現(xiàn)。

三、問題修正

第一，我們可以通過使用標(biāo)記 @Primary 的方式來讓被標(biāo)記的候選者有更高優(yōu)先級(jí)，從而避免報(bào)錯(cuò)。

@Repository
@Primary
@Slf4j
public class OracleDataService implements DataService{
  //省略非關(guān)鍵代碼
}

但是這種方式并不一定符合業(yè)務(wù)需求。

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

@Autowired
DataService oracleDataService;

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

第三，還可以采用 @Qualifier 來顯式指定引用的是那種服務(wù)，例如采用下面的方式：

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

這種方式之所以能解決問題，在于它能讓尋找出的 Bean 只有一個(gè)（即精確匹配），所以壓根不會(huì)出現(xiàn)后面的決策過程，可以參考 DefaultListableBeanFactory#doResolveDependency。

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

以上就是Autowired的注入過程源碼解析的詳細(xì)內(nèi)容，更多關(guān)于Autowired注入過程的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論