《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(在运行时有效,即运行时保留)
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 160,333评论 4 364
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,812评论 1 298
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 110,016评论 0 246
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,293评论 0 214
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,650评论 3 288
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,788评论 1 222
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,003评论 2 315
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,741评论 0 204
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,462评论 1 246
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,681评论 2 249
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,168评论 1 262
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,528评论 3 258
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,169评论 3 238
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,119评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,902评论 0 198
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,846评论 2 283
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,719评论 2 274

推荐阅读更多精彩内容