springboot多數(shù)據(jù)源使用@Qualifier自動(dòng)注入無效的解決

第springboot多數(shù)據(jù)源使用@Qualifier自動(dòng)注入無效的解決目錄@Qualifier自動(dòng)注入無效的解決問題問題的根本原因其中問題出在解決問題的方法@Qualifier的作用和應(yīng)用@Qualifier的作用

@Qualifier自動(dòng)注入無效的解決

問題

使用springboot進(jìn)行多數(shù)據(jù)源時(shí)，發(fā)生了單例DataSource對(duì)應(yīng)多個(gè)DataSourceBean的問題。

具體錯(cuò)誤如下：XXXXXrequiredasinglebean,but3werefound。通過@Qualifier來區(qū)分，或是在@Bean中添加name屬性來區(qū)分，都沒有作用。

問題的根本原因

主要在于SpringBoot的DataSourceInitializer，該類在autoConfigure包中，用來自動(dòng)初始化一個(gè)內(nèi)置的DataSource實(shí)例，在創(chuàng)建該實(shí)例的時(shí)候發(fā)生了注入的問題。

創(chuàng)建實(shí)例的流程（記錄一下方便以后再次調(diào)試）：

1.調(diào)用DataSourceInitializer的構(gòu)造方法

2.調(diào)用AbstractAutowireCapableBeanFactory的applyMergedBeanDefinitionPostProcessors方法

3.調(diào)用AbstractAutowireCapableBeanFactory的initializeBean方法

4.AbstractAutowireCapableBeanFactory的applyBeanPostProcessorsBeforeInitialization方法，其中有一個(gè)循環(huán)是用多種Bean處理器來處理DataSourceInitializer對(duì)象

5.之后使用反射的方式跳轉(zhuǎn)到DataSourceInitializer的init方法

6.里面通過this.applicationContext.getBean(DataSource.class)來獲取所有DataSource的實(shí)現(xiàn)類對(duì)象實(shí)例。

7.DefaultListableBeanFactory的resolveNamedBean方法中來選取實(shí)例對(duì)象，通過里面的getBeanNamesForType方法獲取到所有的符合requireType(也就是DataSource.class)的對(duì)象。

8.如果對(duì)象實(shí)例的實(shí)例數(shù)量大于1，則會(huì)進(jìn)入以下的兩個(gè)判斷：

判斷是否有Primary的實(shí)例，或者是優(yōu)先級(jí)高的實(shí)例對(duì)象，如果有，則將候選對(duì)象名賦值給candidateName。沒有則置為空，最后拋出多個(gè)實(shí)例的異常。

其中問題出在

因?yàn)轫?xiàng)目中只使用了@Qualifier，而且springboot的DataSourceInitializer沒有對(duì)@Qualifier的處理，所以沒有對(duì)實(shí)例進(jìn)行匹配。

造成多個(gè)數(shù)據(jù)源實(shí)例。對(duì)于存在多數(shù)據(jù)源的情況，他們做的補(bǔ)救措施是在代碼中添加了是否是Primary和是否是HighestPriority的判斷，

來處理采用哪個(gè)數(shù)據(jù)源。所以解決的方式也因此出來了。就是將某個(gè)實(shí)例標(biāo)記為Primary或者HighestPriority。

解決問題的方法

在某個(gè)@Bean上添加@Primary注解，就可以做到唯一區(qū)分。

這里其實(shí)應(yīng)該還可以通過優(yōu)先級(jí)來區(qū)分，但使用@Order發(fā)現(xiàn)并不是這個(gè)優(yōu)先級(jí)，也沒找到相關(guān)的資料，所以之后再研究一下。

@Qualifier的作用和應(yīng)用

@Qualifier的作用

這是官方的介紹

Thisannotationmaybeusedonafieldorparameterasaqualifierforcandidatebeanswhenautowiring.Itmayalsobeusedtoannotateothercustomannotationsthatcantheninturnbeusedasqualifiers.

簡單的理解就是：

在使用@Autowire自動(dòng)注入的時(shí)候，加上@Qualifier(“test”)可以指定注入哪個(gè)對(duì)象；

可以作為篩選的限定符，我們?cè)谧鲎远x注解時(shí)可以在其定義上增加@Qualifier，用來篩選需要的對(duì)象。這個(gè)理解看下面的代碼吧，不好解釋。

功能介紹

首先是對(duì)（1）的理解。

//我們定義了兩個(gè)TestClass對(duì)象，分別是testClass1和testClass2

//我們?nèi)绻诹硗庖粋€(gè)對(duì)象中直接使用@Autowire去注入的話，spring肯定不知道使用哪個(gè)對(duì)象

//會(huì)排除異常requiredasinglebean,but2werefound

@Configuration

publicclassTestConfiguration{

@Bean("testClass1")

TestClasstestClass1(){

returnnewTestClass("TestClass1");

@Bean("testClass2")

TestClasstestClass2(){

returnnewTestClass("TestClass2");

}

下面是正常的引用

@RestController

publicclassTestController{

//此時(shí)這兩個(gè)注解的連用就類似@Resource(name="testClass1")

@Autowired

@Qualifier("testClass1")

privateTestClasstestClass;

@GetMapping("/test")

publicObjecttest(){

returntestClassList;

@Autowired和@Qualifier這兩個(gè)注解的連用在這個(gè)位置就類似@Resource(name=“testClass1”)

對(duì)(2)的理解

@Configuration

publicclassTestConfiguration{

//我們調(diào)整下在testClass1上增加@Qualifier注解

@Qualifier

@Bean("testClass1")

TestClasstestClass1(){

returnnewTestClass("TestClass1");

@Bean("testClass2")

TestClasstestClass2(){

returnnewTestClass("TestClass2");

@RestController

publicclassTestController{

//我們這里使用一個(gè)list去接收testClass的對(duì)象

@Autowired

ListTestClasstestClassList=Collections.emptyList();

@GetMapping("/test")

publicObjecttest(){

returntestClassList;

}

我們調(diào)用得到的結(jié)果是

[

{

"name":"TestClass1"

},

{

"name":"TestClass2"

}

]

我們可以看到所有的testclass都獲取到了。接下來我們修改下代碼

@RestController

publicclassTestController{

@Qualifier//我們?cè)谶@增加注解

@Autowired

ListTestClasstestClassList=Collections.emptyList();

@GetMapping("/test")

publicObjecttest(){

returntestClassList;

}

和上面代碼對(duì)比就是在接收參數(shù)上增加了@Qualifier注解，這樣看是有什么區(qū)別，我們調(diào)用下，結(jié)果如下：

[

{

"name":"TestClass1"