《Spring實戰》-第三章:Bean的高級裝配(3)-處理自動裝配Bean的歧義性

慢慢來比較快,虛心學技術

1、什麼是自動裝配Bean的歧義性

一個接口存在多個實現類或一個類存在多個bena定義的時候,如果使用自動裝配,Spring將無法明確應該使用哪一個Bean進行裝配注入,這時候就會報 NoUniqueBeanDefinitionException 的異常,這就是自動裝配Bean的歧義性

如現有一個接口BaseService,該接口有兩個實現類:BaseServiceImpl1和BaseServiceImpl2,還有一個基本類BaseBean

//基本類
@Component
public class BaseBean {
    private String name="BaseBean";

    public void setName(String name){
        this.name = name;
    }
}

//接口
public interface BaseService {
    void update();
}

//接口實現類1
@Component
public class BaseServiceImpl1 implements BaseService {

    @Autowired
    private BaseBean baseBean;

    @Override
    public void update() {
        System.out.println("BaseServiceImpl1  "+baseBean.getName());
    }
}

//接口實現類2
@Component
public class BaseServiceImpl2 implements BaseService {
    @Autowired
    private BaseBean baseBean;

    @Override
    public void update() {
        System.out.println("BaseServiceImpl2  "+baseBean.getName());
    }
}

//測試類:
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(loader = AnnotationConfigContextLoader.class,classes = {ComponentConfig.class})
public class AppComponentTest {

    @Autowired
    private ApplicationContext applicationContext;

    //注入baseService
    @Autowired
    private BaseService baseService;

    @Test
    public void testPrimary(){
        baseService.update();
    }
}

//測試結果:注入失敗,BaseService不止有一個實現類
org.springframework.beans.factory.NoUniqueBeanDefinitionException: 
No qualifying bean of type 'com.my.spring.service.BaseService' available: 
expected single matching bean but found 2: baseServiceImpl1,baseServiceImpl2

2、怎麼處理自動裝配Bean的歧義性

當應用內的接口存在多個實現類或一個類存在多個bean定義,我們有兩個處理方式:

Ⅰ、標識首選Bean

當存在歧義Bean的時候,我們可以使用 @Primary註解指定首選Bean,告訴Spring當發生歧義的時候,優先使用該Bean

如上述代碼將BaseServiceImpl1設定爲首選Bean

@Component
@Primary
public class BaseServiceImpl1 implements BaseService {

    @Autowired
    private BaseBean baseBean;

    @Override
    public void update() {
        System.out.println("BaseServiceImpl1  "+baseBean.getName());
    }
}

此時運行測試結果表明注入成功

BaseServiceImpl1  BaseBean

那麼問題來了,假如使用xml配置如何設置首選Bean

假設BaseBean使用xml配置,我們可以通過設置<bean>節點的primary屬性爲true將其設置爲首選bean

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd">
        <!--將第一個bean定義設置爲首選bean-->
        <bean id="baseBean" class="com.my.spring.bean.BaseBean" primary ="true">
            <constructor-arg name="name" value="baseBeanOne"></constructor-arg>
        </bean>

       <bean id="baseBean" name = "dev" class="com.my.spring.bean.BaseBean">
            <constructor-arg name="name" value="baseBeanTwo"></constructor-arg>
       </bean>
</beans>

Ⅱ、自定義特殊標識

設置首選 bean 的侷限性在於 @Primary 無法將可選方案的範圍限定到唯一一個無歧義性的選項中。它只能標示一個優先的可選方案。當首選bean 的數量超過一個時,我們並沒有其他的方法進一步縮小可選範圍。

此時我們需要通過自定義特殊標識即Spring限定符@Qualifier來爲每一個Bean指定,如我們可以爲上述BaseServiceImpl1和BaseServiceImpl2分別加上特殊標識,然後結合@Autowired註解進行特定注入

//接口實現類1
@Component
@Qualifier("BaseService1")
public class BaseServiceImpl1 implements BaseService {

    @Autowired
    private BaseBean baseBean;

    @Override
    public void update() {
        System.out.println("BaseServiceImpl1  "+baseBean.getName());
    }
}

//接口實現類2
@Component
@Qualifier("BaseService2")
public class BaseServiceImpl2 implements BaseService {
    @Autowired
    private BaseBean baseBean;

    @Override
    public void update() {
        System.out.println("BaseServiceImpl2  "+baseBean.getName());
    }
}

//測試類:
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(loader = AnnotationConfigContextLoader.class,classes = {ComponentConfig.class})
public class AppComponentTest {

    @Autowired
    private ApplicationContext applicationContext;

    //注入baseService(限定詞爲BaseService1)
    @Autowired
    @Qualifier("BaseService1")
    private BaseService baseService;

    @Test
    public void testPrimary(){
        baseService.update();
    }
}

測試結果:
BaseServiceImpl1  BaseBean

實際上,我們甚至可以自定義限定符註解(當在一個bean或方法中使用多個@Qualifier註解時會編譯報錯),而使用自定義限定符註解和@Qualifier註解效果一致,我們需要做的只是創建一個註解,並使用@Qualifier對該註解進行標識,如我們可以將上述的BaseServiceImpl1和BaseServiceImpl2的限定符註解替換成如下樣式:


//創建註解@BaseService1
@Target({ElementType.CONSTRUCTOR,ElementType.FIELD,ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface BaseService1 {
}

//在BaseServiceImpl1上使用@BaseService1
@Component
@BaseService1//實際上相當於@Qualifier("BaseService1")
public class BaseServiceImpl1 implements BaseService {
    @Autowired
    private BaseBean baseBean;
    @Override
    public void update() {
        System.out.println("BaseServiceImpl1  "+baseBean.getName());
    }
}

//創建註解@BaseService2
@Target({ElementType.CONSTRUCTOR,ElementType.FIELD,ElementType.METHOD,ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface BaseService2 {
}

//在BaseServiceImpl2上使用@BaseServiceImpl2
@Component
@BaseService2//實際上相當於@Qualifier("BaseService2")
public class BaseServiceImpl2 implements BaseService {
    @Autowired
    private BaseBean baseBean;
    @Override
    public void update() {
        System.out.println("BaseServiceImpl2  "+baseBean.getName());
    }
}

//測試類注入BaseServiceImpl1
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(loader = AnnotationConfigContextLoader.class,classes = {ComponentConfig.class})
public class AppComponentTest {

    @Autowired
    private ApplicationContext applicationContext;

    //注入baseService(限定詞爲BaseService1)
    @Autowired
    @BaseService1//實際上相當於@Qualifier("BaseService1")
    private BaseService baseService;

    @Test
    public void testPrimary(){
        baseService.update();
    }
}

測試結果:
BaseServiceImpl1  BaseBean

注:其中

  1. @Target限定註解可以使用的範圍:ElementType.CONSTRUCTOR(構造函數),ElementType.FIELD(字段),ElementType.METHOD(方法),ElementType.TYPE(類,接口等)
  2. @Retention限定了該Annotation被保留的時間長短:RetentionPolicy.SOURCE(在源文件中有效,即源文件保留),RetentionPolicy.CLASS(在class文件中有效,即class保留),RetentionPolicy.RUNTIME(在運行時有效,即運行時保留)
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章