Java 實(shí)用注解篇之@Qualifier 深度解析及實(shí)戰(zhàn)案例
前言
在 Spring 框架中,@Qualifier 是一個(gè)常見(jiàn)的注解,主要用于 解決依賴注入(DI)時(shí)的歧義性。當(dāng)一個(gè)接口有多個(gè)實(shí)現(xiàn)類(lèi)時(shí),Spring 無(wú)法自動(dòng)決定該注入哪個(gè)具體的 Bean,此時(shí) @Qualifier 可以幫助我們 指定要注入的 Bean 名稱。
一、@Qualifier 的作用
1?? 解決 Spring 依賴注入沖突
當(dāng)有多個(gè) Bean 可用于注入時(shí),Spring 需要知道應(yīng)該選擇哪一個(gè):
- 如果沒(méi)有
@Qualifier,Spring 會(huì)拋出 NoUniqueBeanDefinitionException。 - 使用
@Qualifier,可以明確指定要注入的 Bean。
2?? @Qualifier 基本使用
示例:多個(gè)相同類(lèi)型的 Bean 時(shí),Spring 無(wú)法自動(dòng)選擇
@Component
public class Dog implements Animal {
@Override
public void speak() {
System.out.println("汪汪!");
}
}
@Component
public class Cat implements Animal {
@Override
public void speak() {
System.out.println("喵喵!");
}
}@Service
public class AnimalService {
private final Animal animal;
@Autowired
public AnimalService(Animal animal) {
this.animal = animal;
}
public void makeSound() {
animal.speak();
}
}此時(shí)運(yùn)行時(shí)會(huì)報(bào)錯(cuò):
NoUniqueBeanDefinitionException: No qualifying bean of type 'Animal' available
因?yàn)?Dog 和 Cat 都實(shí)現(xiàn)了 Animal,Spring 不知道該注入哪個(gè)。
? 解決方案:使用 @Qualifier 指定具體 Bean
@Service
public class AnimalService {
private final Animal animal;
@Autowired
public AnimalService(@Qualifier("dog") Animal animal) {
this.animal = animal;
}
public void makeSound() {
animal.speak();
}
}這樣 AnimalService 只會(huì)注入 dog 這個(gè) Bean,避免了沖突。
二、@Qualifier 源碼解析
1?? @Qualifier 注解的定義
Spring 框架中的 @Qualifier 是一個(gè) 標(biāo)準(zhǔn)注解,定義如下:
@Target({ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Qualifier {
String value();
}可以看到:
@Target允許它用于 字段、參數(shù)、方法和類(lèi)。@Retention(RetentionPolicy.RUNTIME)讓它在 運(yùn)行時(shí)生效。String value()方法表示指定的 Bean 名稱。
2?? Spring 解析 @Qualifier
Spring 在 AutowiredAnnotationBeanPostProcessor 中解析 @Qualifier:
if (methodParameter.hasParameterAnnotation(Qualifier.class)) {
String beanName = methodParameter.getParameterAnnotation(Qualifier.class).value();
bean = beanFactory.getBean(beanName, methodParameter.getParameterType());
}解析過(guò)程:
- 檢查
@Qualifier是否存在,如果存在就獲取value()。 - 根據(jù)
value()找到 Bean 并進(jìn)行注入。
三、@Qualifier 實(shí)戰(zhàn)案例
1?? @Qualifier 結(jié)合 @Autowired
如果有多個(gè) Bean,使用 @Qualifier 指定注入的 Bean:
@Component("catBean")
public class Cat implements Animal {
@Override
public void speak() {
System.out.println("喵喵!");
}
}
@Component("dogBean")
public class Dog implements Animal {
@Override
public void speak() {
System.out.println("汪汪!");
}
}@Service
public class AnimalService {
@Autowired
@Qualifier("dogBean")
private Animal animal;
public void makeSound() {
animal.speak();
}
}? AnimalService 只會(huì)注入 dogBean,避免 NoUniqueBeanDefinitionException。
2?? @Qualifier 結(jié)合 @Bean
如果 Bean 是通過(guò) @Bean 方法創(chuàng)建的,也可以使用 @Qualifier 指定:
@Configuration
public class AnimalConfig {
@Bean
@Qualifier("bigDog")
public Animal bigDog() {
return new Dog();
}
@Bean
@Qualifier("smallDog")
public Animal smallDog() {
return new Dog();
}
}@Service
public class AnimalService {
@Autowired
@Qualifier("bigDog")
private Animal animal;
}? 這樣可以選擇 bigDog 而不是 smallDog。
3?? @Qualifier 結(jié)合 @Primary
如果希望默認(rèn)注入某個(gè) Bean,但仍然允許 @Qualifier 選擇其他 Bean,可以結(jié)合 @Primary:
@Component
@Primary
public class DefaultAnimal implements Animal {
@Override
public void speak() {
System.out.println("我是默認(rèn)動(dòng)物!");
}
}@Service
public class AnimalService {
@Autowired
private Animal animal; // 默認(rèn)注入 DefaultAnimal
@Autowired
@Qualifier("dog")
private Animal dog; // 指定注入 Dog
}? animal 默認(rèn)注入 DefaultAnimal,dog 注入 Dog,兩者互不干擾。
四、@Qualifier 使用注意事項(xiàng)
? 1. @Qualifier 不能用于構(gòu)造方法
? 錯(cuò)誤示例
@Service
public class AnimalService {
private final Animal animal;
@Autowired
public AnimalService(@Qualifier("dog") Animal animal) { // ? 無(wú)效
this.animal = animal;
}
}? 正確方式
@Service
public class AnimalService {
private final Animal animal;
@Autowired
public AnimalService(@Qualifier("dogBean") Animal animal) { // ? 正確
this.animal = animal;
}
}? 2. @Qualifier 不能和 @Primary 沖突
@Component
@Primary
@Qualifier("dog")
public class Dog implements Animal { } // ? 不要同時(shí)使用 @Primary 和 @Qualifier@Primary 和 @Qualifier 邏輯上是沖突的,應(yīng)該 只使用一個(gè) 來(lái)指定注入。
? 3. @Qualifier 必須匹配 Bean 名稱
如果 @Qualifier("dogBean"),但 Bean 名稱是 "dog",會(huì)導(dǎo)致找不到 Bean:
@Autowired
@Qualifier("dogBean") // ? 錯(cuò)誤
private Animal animal;Spring 需要 @Qualifier("dog") 才能正確注入。
五、總結(jié)
| 重點(diǎn) | 說(shuō)明 |
|---|---|
@Qualifier | 解決多個(gè) Bean 注入沖突,指定具體 Bean |
@Qualifier + @Autowired | 選擇特定 Bean 進(jìn)行注入 |
@Qualifier + @Bean | 在 @Configuration 中手動(dòng)指定 Bean |
@Primary + @Qualifier | 默認(rèn)注入 @Primary,但可以用 @Qualifier 覆蓋 |
| 注意事項(xiàng) | @Qualifier 必須匹配 Bean 名稱,避免和 @Primary 沖突 |
六、思考與拓展
@Qualifier能否和@Lazy結(jié)合使用?@Qualifier在 Spring Boot@Conditional配置中的應(yīng)用?@Qualifier結(jié)合 Spring AOP 是否有特殊用法?
到此這篇關(guān)于Java 實(shí)用注解篇之@Qualifier 深度解析及實(shí)戰(zhàn)案例的文章就介紹到這了,更多相關(guān)Java 注解@Qualifier 內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
JavaWeb實(shí)現(xiàn)簡(jiǎn)單上傳文件功能
這篇文章主要為大家詳細(xì)介紹了JavaWeb實(shí)現(xiàn)簡(jiǎn)單上傳文件功能,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2022-06-06
詳解mybatis-plus使用@EnumValue注解的方式對(duì)枚舉類(lèi)型的處理
這篇文章主要介紹了詳解mybatis-plus使用@EnumValue注解的方式對(duì)枚舉類(lèi)型的處理,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2020-12-12
mybatis xml注釋sql的注意事項(xiàng)及說(shuō)明
這篇文章主要介紹了mybatis xml注釋sql的注意事項(xiàng)及說(shuō)明,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2023-07-07
SpringBoot+ShardingSphereJDBC實(shí)現(xiàn)讀寫(xiě)分離詳情
這篇文章主要介紹了SpringBoot+ShardingSphereJDBC實(shí)現(xiàn)讀寫(xiě)分離詳情,通過(guò)用??MySQL??進(jìn)行一主一從的主從復(fù)制展開(kāi)全文內(nèi)容,需要的朋友可以參考一下2022-08-08
EL表達(dá)式簡(jiǎn)介_(kāi)動(dòng)力節(jié)點(diǎn)Java學(xué)院整理
EL全名為Expression Language,這篇文章主要給大家介紹EL表達(dá)式的主要作用及內(nèi)容簡(jiǎn)介,感興趣的朋友一起看看2017-07-07
用Java實(shí)現(xiàn)全國(guó)天氣預(yù)報(bào)的api接口調(diào)用示例
查詢天氣預(yù)報(bào)在APP中常用的一個(gè)常用功能,本文實(shí)例講述了java調(diào)用中國(guó)天氣網(wǎng)api獲得天氣預(yù)報(bào)信息的方法。分享給大家供大家參考。2016-10-10
5分鐘快速學(xué)會(huì)spring boot整合Mybatis的方法
這篇文章主要給大家介紹了如何通過(guò)5分鐘快速學(xué)會(huì)spring boot整合Mybatis的相關(guān)資料,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家學(xué)習(xí)或者使用spring boot具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2019-12-12

