Spring入門(八)：自動裝配的歧義性

申城異鄉人發表於2019-08-15

1. 什麼是自動裝配的歧義性?

在Spring中，裝配bean有以下3種方式：

自動裝配
Java配置
xml配置

在這3種方式中，自動裝配為我們帶來了很大的便利，大大的降低了我們需要手動裝配bean的程式碼量。

不過，自動裝配也不是萬能的，因為僅有一個bean匹配條件時，Spring才能實現自動裝配，如果出現不止1個bean匹配條件時，Spring就會不知道要裝配哪個bean，丟擲org.springframework.beans.factory.NoUniqueBeanDefinitionException異常，這就是自動裝配的歧義性。

為了方便理解，我們舉個具體的例子。

首先，我們新建個介面Dessert，該介面僅有1個方法showName()：

package chapter03.ambiguity;

public interface Dessert {
    void showName();
}

然後定義3個該介面的實現類Cake，Cookies，IceCream：

package chapter03.ambiguity;

import org.springframework.stereotype.Component;

@Component
public class Cake implements Dessert {
    @Override
    public void showName() {
        System.out.println("蛋糕");
    }
}

package chapter03.ambiguity;

import org.springframework.stereotype.Component;

@Component
public class Cookies implements Dessert {
    @Override
    public void showName() {
        System.out.println("餅乾");
    }
}

package chapter03.ambiguity;

import org.springframework.stereotype.Component;

@Component
public class IceCream implements Dessert {
    @Override
    public void showName() {
        System.out.println("冰激凌");
    }
}

然後新建甜點店類DessertShop，該類的setDessert()方法需要裝配1個Dessert的例項bean：

package chapter03.ambiguity;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Component
public class DessertShop {
    private Dessert dessert;

    public Dessert getDessert() {
        return dessert;
    }

    @Autowired
    public void setDessert(Dessert dessert) {
        this.dessert = dessert;
    }

    public void showDessertName() {
        this.dessert.showName();
    }
}

不過現在符合裝配條件的有3個bean，它們的bean ID(預設情況下是類名首字母小寫)分別為cake，cookies，iceCream，Spring該自動裝配哪個呢？

帶著這個疑問，我們先新建配置類AmbiguityConfig：

package chapter03.ambiguity;

import org.springframework.context.annotation.ComponentScan;

@ComponentScan
public class AmbiguityConfig {
}

這個類的關鍵是新增了@ComponentScan註解，讓Spring自動掃描已經定義好的bean。

最後，新建類Main，在其main()方法中新增如下測試程式碼：

package chapter03.ambiguity;

import org.springframework.context.annotation.AnnotationConfigApplicationContext;

public class Main {
    public static void main(String[] args) {
        AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AmbiguityConfig.class);

        DessertShop dessertShop = context.getBean(DessertShop.class);
        dessertShop.showDessertName();

        context.close();
    }
}

執行程式碼，發現丟擲org.springframework.beans.factory.NoUniqueBeanDefinitionException異常，如下所示：

Spring入門(八)：自動裝配的歧義性

那麼如何解決自動裝配的歧義性呢？Spring提供了以下2種方案：

標記首選的bean
使用限定符

2. 標記首選的bean

既然現在有3個匹配條件的bean，我們可以通過@Primary註解標記下哪個是首選的bean，這樣當Spring發現有不止1個匹配條件的bean時，就會選擇這個首選的bean。

比如3種甜點裡，我最喜歡吃餅乾，那麼我就把Cookies標記為首選的bean：

package chapter03.ambiguity;

import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;

@Component
@Primary
public class Cookies implements Dessert {
    @Override
    public void showName() {
        System.out.println("餅乾");
    }
}

再次執行測試程式碼，輸出結果如下所示：

餅乾

圓滿解決了歧義性的問題，不過有一天，有個同事不小心在IceCream上也新增了@Primary註解：

package chapter03.ambiguity;

import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;

@Component
@Primary
public class IceCream implements Dessert {
    @Override
    public void showName() {
        System.out.println("冰激凌");
    }
}

編譯都正常，因此都沒注意，但釋出後執行時，卻丟擲如下異常：

Spring入門(八)：自動裝配的歧義性

意思就是發現了不止1個首選的bean，因為此時Spring又不知道該選擇哪個了，也就是有了新的歧義性，所以甩鍋丟擲了異常。

3. 使用限定符

3.1 基於bean ID的限定符

Spring還提供了另一個註解@Qualifier註解來解決自動裝配的歧義性，它可以與@Autowired或者@Inject一起使用，在注入的時候指定想要注入哪個bean。

比如，我們把IceCream注入到setDessert()的方法引數之中：

@Autowired
@Qualifier("iceCream")
public void setDessert(Dessert dessert) {
    this.dessert = dessert;
}

這裡傳遞的iceCream指的是IceCream類預設生成的bean ID。

再次執行測試程式碼，輸出結果如下所示：

冰激凌

我們可以發現，使用了@Qualifier註解後，我們之前標記的@Primary註解被忽略了，也就是說，@Qualifier註解的優先順序比@Primary註解的優先順序高。

使用預設的限定符雖然解決了問題，不過可能會引入一些問題。比如我在重構程式碼時，將IceCream類名修改成了Gelato：

package chapter03.ambiguity;

import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;

@Component
@Primary
public class Gelato implements Dessert {
    @Override
    public void showName() {
        System.out.println("冰激凌");
    }
}

此時執行程式碼，會發現丟擲org.springframework.beans.factory.NoSuchBeanDefinitionException異常，如下所示：

Spring入門(八)：自動裝配的歧義性

這是因為IceCream重新命名為Gelato之後，bean ID由iceCream變成了gelato，但我們注入地方的程式碼仍然使用的是iceCream這個bean ID，導致沒有找到匹配條件的bean。

鑑於使用預設的限定符的這種侷限性，我們可以使用自定義的限定符來解決這個問題。

為不影響後面程式碼的測試結果，將Gelato類再改回IceCream

3.2 基於面向特性的限定符

為了避免因為修改類名而導致自動裝配失效的問題，我們可以在@Component或者@Bean註解宣告bean時新增上@Qualifier註解，如下所示：

package chapter03.ambiguity;

import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Component;

@Component
@Qualifier("cold")
public class IceCream implements Dessert {
    @Override
    public void showName() {
        System.out.println("冰激凌");
    }
}

然後在注入的地方，不再使用預設生成的bean ID，而是使用剛剛指定的cold限定符：

@Autowired
@Qualifier("cold")
public void setDessert(Dessert dessert) {
    this.dessert = dessert;
}

執行測試程式碼，輸入結果如下所示：

冰激凌

此時將IceCream類重新命名為Gelato，程式碼可以正常執行，不會受影響。

然後有一天，某位開發又新建了類Popsicle，該類也使用了cold限定符：

package chapter03.ambiguity;

import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.stereotype.Component;

@Component
@Qualifier("cold")
public class Popsicle implements Dessert {
    @Override
    public void showName() {
        System.out.println("棒冰");
    }
}

此時又帶來了新的歧義性問題，因為Spring又不知道該如何選擇了，執行程式碼會丟擲org.springframework.beans.factory.NoUniqueBeanDefinitionException異常，如下所示：

Spring入門(八)：自動裝配的歧義性

此時，我們就需要用到自定義的限定符了。

3.3 自定義的限定符註解

首先，我們新建以下3個註解：

package chapter03.ambiguity;

import org.springframework.beans.factory.annotation.Qualifier;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Cold {
}

package chapter03.ambiguity;

import org.springframework.beans.factory.annotation.Qualifier;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Creamy {
}

package chapter03.ambiguity;

import org.springframework.beans.factory.annotation.Qualifier;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target({ElementType.CONSTRUCTOR, ElementType.FIELD, ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface Fruity {
}

注意事項：這3個註解在定義時都新增了@Qualifier註解，因此它們具有了@Qualifier註解的特性

然後將IceCream類修改為：

package chapter03.ambiguity;

import org.springframework.stereotype.Component;

@Component
@Cold
@Creamy
public class IceCream implements Dessert {
    @Override
    public void showName() {
        System.out.println("冰激凌");
    }
}

將Popsicle類修改為：

package chapter03.ambiguity;

import org.springframework.stereotype.Component;

@Component
@Cold
@Fruity
public class Popsicle implements Dessert {
    @Override
    public void showName() {
        System.out.println("棒冰");
    }
}

最後，修改下注入地方的程式碼，使其只能匹配到1個滿足條件的bean，如下所示：

@Autowired
@Cold
@Creamy
public void setDessert(Dessert dessert) {
    this.dessert = dessert;
}

執行測試程式碼，輸出結果如下所示：

冰激凌

由此，我們也可以發現，自定義註解與@Qualifier註解相比，有以下2個優點：

可以同時使用多個自定義註解，但@Qualifier註解只能使用1個
使用自定義註解比@Qualifier註解更為型別安全

4. 原始碼及參考

原始碼地址：https://github.com/zwwhnly/spring-action.git，歡迎下載。

Craig Walls 《Spring實戰（第4版）》

5. 最後

打個小廣告，歡迎掃碼關注微信公眾號：「申城異鄉人」，定期分享Java技術乾貨，讓我們一起進步。

Spring入門(八)：自動裝配的歧義性

Spring裝配Bean(五)profile註解和解決自動注入的歧義性
2018-05-31
SpringBean
Spring入門(二)：自動化裝配bean
2019-03-06
SpringBean
Spring Boot 基礎: 使用 `@ConfigurationProperties` 實現自定義屬性的自動裝配
2020-12-18
Spring Boot
Spring自動裝配Beans
2018-09-13
SpringBean
Spring Boot 自動裝配原理
2021-03-16
Spring Boot
Spring-04 Bean的自動裝配
2021-02-27
SpringBean
SpringBoot自動裝配-自定義Start
2021-07-22
Spring Boot
2、spring注入及自動裝配
2018-03-26
Spring
淺嘗Spring註解開發_自定義註冊元件、屬性賦值、自動裝配
2022-04-29
Spring元件賦值
Spring入門(三)：通過JavaConfig裝配bean
2019-03-06
SpringJavaBean
深入理解Spring框架的自動裝配原理
2023-12-29
Spring框架
bean 的自動裝配
2020-06-22
Bean
徹底搞明白Spring中的自動裝配和Autowired
2019-03-10
Spring
Spring框架使用@Autowired自動裝配引發的討論
2019-07-31
Spring框架
SpringBoot - 自動裝配
2024-08-07
Spring Boot
springboot之自動裝配
2018-12-23
Spring Boot
SpringBoot 自動裝配的原理分析
2022-12-12
Spring Boot
深度剖析Spring Boot自動裝配機制實現原理
2021-11-26
Spring Boot
springboot自動裝配（1）---@SpringBootApplication註解怎麼自動裝配各種元件
2019-07-15
Spring BootAPP元件
spring裝配
2020-11-21
Spring
Bean的自動裝配及作用域
2018-12-20
Bean
SpringBoot自動裝配原理分析
2021-09-09
Spring Boot
SpringBoot系列--自動裝配原理
2021-04-11
Spring Boot
SpringBoot是如何做到自動裝配的
2022-02-21
Spring Boot
SpringBoot自動裝配-原始碼分析
2021-08-02
Spring Boot原始碼
SpringBoot | 2.1 SpringBoot自動裝配原理
2021-07-18
Spring Boot
SpringBoot系列--自動裝配原理2
2021-04-17
Spring Boot
SpringBoot自動裝配原理解析
2021-03-09
Spring Boot
Spring bean 裝配
2019-04-15
SpringBean
常用的自動裝配註解@Autowired @RequiredArgsConstructor @AllArgsConstructor
2019-06-11
UIStruct
【面試普通人VS高手系列】Spring Boot中自動裝配機制的原理
2022-04-25
面試Spring Boot
Spring裝配Bean(四)
2018-05-23
SpringBean
Spring裝配Bean(一)
2018-05-21
SpringBean
Spring裝配Bean(二)
2018-05-21
SpringBean
二、Spring裝配Bean
2020-05-27
SpringBean
PHP 物件導向（八）類的自動載入
2020-01-18
PHP物件
Spring Cloud 快速入門（八）訊息系統整合框架 Spring Cloud Stream
2020-10-14
SpringCloud框架
Springboot學習日記（三）自動裝配
2018-12-05
Spring Boot

Spring入門(八)：自動裝配的歧義性

1. 什麼是自動裝配的歧義性?

2. 標記首選的bean

3. 使用限定符

3.1 基於bean ID的限定符

3.2 基於面向特性的限定符

3.3 自定義的限定符註解

4. 原始碼及參考

5. 最後

相關文章