当注入的Bean存在冲突时,到底有多少种解决方案?

当我们从 Spring 容器中“拉”取一个 Bean 回来的时候,可以按照名字去拉取,也可以按照类型去拉取,按照 BeanName 拉取的话,一般来说只要 BeanName 书写没有问题,都是没问题的。但是如果是按照类型去拉取,则可能会因为 Bean 存在多个实例从而导致失败。

在前面的文章中,松哥和小伙伴们分享了 @Primary、@Qualifier 注解在处理该问题时的一些具体的方案,但是都是零散的,今天咱们来把这些方案总结一下,顺便再来看看是否还存在其他方案?

1. 问题呈现

假设我有 A、B 两个类,在 A 中注入 B,如下:

@Component
public class A {
    @Autowired
    B b;
}

至于 B,则在配置类中存在多个实例:

@Configuration
@ComponentScan
public class JavaConfig {
    @Bean("b1")
    B b1() {
        return new B();
    }

    @Bean("b2")
    B b2() {
        return new B();
    }
}

这样的项目启动之后,必然会抛出如下异常:

图片

今天我们就来总结下这个问题的解决方案。

2. 解决方案分析

2.1 @Resource

使用 @Resource 注解,这个应该是大家最容易想到的方案之一,不过使用 @Resource 注解需要额外添加依赖:

<dependency>
    <groupId>jakarta.annotation</groupId>
    <artifactId>jakarta.annotation-api</artifactId>
    <version>2.1.1</version>
</dependency>

加了依赖之后,现在就可以直接使用 @Resource 注解了:

@Service
public class A {
    @Resource(name = "b1")
    B b;
}

2.2 @Qualifier 指定 name

另一种方案就是搭配 @Qualifier 注解,通过该注解指定 Bean 的名称:

@Service
public class A {
    @Autowired
    @Qualifier("b1")
    B b;
}

关于这种方案的源码分析松哥在之前的文章中和大家聊过了:Spring 中 @Qualifier 注解还能这么用?。

2.3 @Qualifier 不指定 name

这种方案也是搭配 @Qualifier,但是并不指定 BeanName,而是在 B 注册和 A 中注入 B 的时候,分别标记一个 @Qualifier 注解:

@Service
public class A {
    @Autowired
    @Qualifier
    B b;
}

@Configuration
@ComponentScan
public class JavaConfig {

    @Bean
    @Qualifier
    B b1() {
        return new B();
    }

    @Bean
    B b2() {
        return new B();
    }

}

关于这种方案的源码分析松哥在之前的文章中和大家聊过了:Spring 中 @Qualifier 注解还能这么用?。

2.4 不作为候选 Bean

另外还有一种方案,就是在注册 Bean 的时候,告诉 Spring 容器,这个 Bean 在通过 type 进行注入的时候,不作为候选 Bean。

小伙伴们知道,在第一小节中报的错,原因就是因为根据 type 去查找相应的 Bean 的时候,找到了多个候选 Bean,所以才会报错,所以我们注册一个 Bean 的时候,可以设置该 Bean 不是候选 Bean,这个设置并不影响通过 name 注入一个 Bean。

具体配置如下:

Java 代码配置:

@Configuration
@ComponentScan
public class JavaConfig {

    @Bean(autowireCandidate = false)
    B b1() {
        return new B();
    }

    @Bean
    B b2() {
        return new B();
    }

}

autowireCandidate 属性就表示这个 Bean 不是一个候选 Bean。

XML 配置:

<bean class="org.javaboy.bean.p2.B" autowire-candidate="false"/>

autowire-candidate 属性表示当前 Bean 是否作为一个候选 Bean。

2.5 @Primary

差点把我们最常用的方案忘了。@Primary 表示当通过 type 注入的时候,如果当前 Bean 存在多个实例,则优先使用带有 @Primary 注解的 Bean。

@Service
public class A {
    @Autowired
    B b;
}

@Configuration
@ComponentScan
public class JavaConfig {

    @Bean
    @Primary
    B b1() {
        return new B();
    }

    @Bean
    B b2() {
        return new B();
    }

}
赞赏

微信赞赏支付宝赞赏

发表回复

后才能评论