Spring @Qualifier原理分析！

发表于 更新于 分类于 阅读次数： 本文字数： 2.9k 阅读时长 ≈ 3 分钟

你好，我是猿java。

这篇文章，我们将深度分析 Spring 的@Qualifier注解。

1. 功能概要

@Qualifier注解是 Spring中用于在依赖注入时明确指定要注入的 Bean 的工具，特别是在容器中存在多个相同类型的 Bean 时。它帮助开发者解决由于 Bean 名称冲突或多重实现导致的歧义问题，从而确保注入正确的 Bean 实例。

比如：当容器中存在多个同类型的 Bean 时，Spring 无法确定应该注入哪一个 Bean，这时 @Qualifier 就派上用场了。它通过指定 Bean 的名称或自定义限定符来告知 Spring 具体应该注入哪个 Bean。

2. 使用方法

2.1 按 Bean 名称指定

@Qualifier 通常与 @Autowired 一起使用，通过指定 Bean 的名称来选择具体的实现：

1
2
3
@Autowired
@Qualifier("ServiceImpl2")
private Service Service;

确保 @Qualifier 中的名称与目标 Bean 的名称（默认是类名首字母小写，或者通过 @Component("customName") 指定的名称）相匹配。

2.2 在构造函数中使用

对于构造函数注入，也可以使用 @Qualifier：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
@Component
public class Controller {

    private final Service Service;

    @Autowired
    public Controller(@Qualifier("ServiceImpl2") Service Service) {
        this.Service = Service;
    }

    public void execute() {
        Service.performService();
    }
}

2.3 结合自定义限定符

你还可以创建自定义的限定符注解，以提高代码的可读性和可维护性：

1
2
3
4
@Target({ ElementType.FIELD, ElementType.PARAMETER, ElementType.TYPE })
@Retention(RetentionPolicy.RUNTIME)
@Qualifier
public @interface ServiceType1 {}

然后在 Bean 和注入点使用这个自定义注解：

1
2
3
4
5
6
7
8
9
@Component
@ServiceType1
public class ServiceImpl1 implements Service {
    // 实现细节
}

@Autowired
@ServiceType1
private Service Service;

3. 示例分析

为了更好地理解 @Qualifier 的用法，这里以一个接口 Service 以及两个实现类 ServiceImpl1 和 ServiceImpl2的使用为例：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
public interface Service {
    void performService();
}

@Component
public class ServiceImpl1 implements Service {
    @Override
    public void performService() {
        System.out.println("Service Implementation 1");
    }
}

@Component
public class ServiceImpl2 implements Service {
    @Override
    public void performService() {
        System.out.println("Service Implementation 2");
    }
}

如果在另一个组件中尝试注入 Service：

1
2
3
4
5
6
7
8
9
10
@Component
public class Controller {

    @Autowired
    private Service Service;

    public void execute() {
        Service.performService();
    }
}

此时，Spring 会抛出以下异常，因为存在多个 Service 的实现：

1
NoUniqueBeanDefinitionException: No qualifying bean of type 'com.yuanjava.Service' available: expected single bean, but found 2

通过使用 @Qualifier，你可以明确指定要注入的 Bean：

1
2
3
4
5
6
7
8
9
10
11
@Component
public class Controller {

    @Autowired
    @Qualifier("ServiceImpl1")
    private Service Service;

    public void execute() {
        Service.performService();
    }
}

这样，Spring 就会注入 ServiceImpl1，避免了歧义。

4. 与 @Primary 的区别

@Primary 注解用于标记一个 Bean 为首选 Bean，当存在多个相同类型的 Bean 时，Spring 会默认注入标记了 @Primary 的 Bean，除非另有指定（如使用 @Qualifier）。

1
2
3
4
5
6
7
8
9
10
11
12
13
@Component
@Primary
public class PrimaryService implements Service {
    // 实现
}

@Component
public class SecondaryService implements Service {
    // 实现
}

@Autowired
private Service Service; // 注入 PrimaryService

如果你想注入 SecondaryService，可以使用 @Qualifier：

1
2
3
@Autowired
@Qualifier("secondaryService")
private Service Service; // 注入 SecondaryService

5. 总结

本文，我们分析了 @Qualifier的工作原理。@Qualifier 是 Spring 中用于解决 Bean 冲突的有力工具，尤其在多实现类的场景下。通过明确指定要注入的 Bean，@Qualifier 确保了依赖注入的准确性和可维护性。结合 @Primary、自定义限定符等，开发者可以灵活地管理和注入所需的 Bean 实例，从而构建更清晰、可管理的应用结构。

6. 学习交流

如果你觉得文章有帮助，请帮忙转发给更多的好友，或关注公众号：猿java，持续输出硬核文章。

drawing