2023-08-24

Spring

7 分钟读完 (大约 1050 个字)

当注入的 Bean 存在冲突时，到底有多少种解决方案？松哥总结了 5 种！

当我们从 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 配置：

1	<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();
    }

}

关于这种方案的源码分析松哥在之前的文章中和大家聊过了：Spring 中 @Primary 注解的原理是什么？。

好啦，这就是松哥总结出来的 5 种方案，实际上，基于这五种，还能衍生出来一些方案，这就需要小伙伴们自行探索啦～

最后大家思考这样一问题：对于第一小节提出来的问题，如果同时使用 2.2 和 2.5 小节的方案，那么哪一个会生效呢？

# Spring

喜欢这篇文章吗？扫码关注公众号【江南一点雨】，【江南一点雨】专注于 SPRING BOOT+微服务以及前后端分离技术，每天推送原创技术干货，关注后回复 JAVA，领取松哥为你精心准备的 JAVA 干货!

微信