Spring注解@Qualifier的详细用法你知道几种

环境：springboot2.3.10

一般使用在项目中使用@Qualifier来限定注入的Bean。

由于项目中我习惯用@Resource注解，所以这里先对@Autowired和@Resource进行个简单的说明。

@Autowired和@Resource区别

相同点：

@Autowired与@Resource都可以用来装配Bean。都可以写在字段上,或写在setter方法上。

区别：

1、@Autowired（Spring注解）

默认按类型装配，默认情况下必须要求依赖对象必须存在（不存在会报错），可以通过required=false属性设置非必须，如果我们想使用名称装配可以结合@Qualifier注解进行使用，示例如下：

@Autowired(required = false)
private Date date ;
@Autowired
@Qualifier("birth")
private Date birthday ;

当系统中存在多个相同类型的Bean时，如果不使用@Qualifier程序启动是会报错

@Bean
public Date d1() {
  return new Date() ;
}
@Bean
public Date d2() {
  return new Date() ;
}
@Autowired
private Date date ;

Spring注解@Qualifier的详细用法你知道几种

2、@Resoure（JavaEE注解）

默认按照名称进行装配，可以通过name属性指定名称，如果没有指定name属性，当注解写在字段上时，默认取字段名进行查找注入，如果写在setter方法上默认取属性名进行装配。当找不到与名称匹配的bean时才按照类型进行装配。但是需要注意的是，如果name属性一旦指定，就只会按照名称进行装配。示例：

还是上面的例子

@Resource
private Date date

启动后会报错：

Caused by: org.springframework.beans.factory.NoUniqueBeanDefinitionException: No qualifying bean of type "java.util.Date" available: expected single matching bean but found 2: d1,d2

因为我们没有以date为名称的bean，所以会按照类型进行注入，但是类型又有两个Date的Bean。将date改为d1或者d2或者指明name属性。

@Resource("d1")
private Date date

@Autowired和@Resource就介绍到这里了

常规用法限定注入类

通过上面的示例我们已经了解了@Qualifier的主用

@Autowired
@Qualifier("d1")
private Date date ;

用来限定注入的Bean的名称。这种用法也是很好的理解，接下来我们介绍通过@Qualifier来筛选限定注入对象。

@Qualifier筛选注入对象

直接使用@Qualifier限定

@Qualifier
@Bean
public Date d1() {
  return new Date() ;
}
@Bean
public Date d2() {
  return new Date() ;
}
@Resource
private List<Date> dates = Collections.emptyList() ;

打印dates集合：

Spring注解@Qualifier的详细用法你知道几种

集合中注入了2个Date Bean。

修改代码：

@Resource
@Qualifier
private List<Date> dates = Collections.emptyList() ;

在属性上加入@Qualifier注解

执行结果：

Spring注解@Qualifier的详细用法你知道几种

只注入了一个Date Bean。

@Qualifier起到了一个筛选的作用只有Bean上加有@Qualifier注解的Bean才会被收集注入。

自定义注解限定注入Bean

@Target({ ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Qualifier
public @interface FK {

}

注意：该自定义注解上添加有@Qualifier注解。

@FK
@Bean
public Date d1() {
  return new Date() ;
}
@Bean
public Date d2() {
  return new Date() ;
}
@Resource
@FK
private List<Date> dates = Collections.emptyList() ;

运行：

Spring注解@Qualifier的详细用法你知道几种

注入了一个Date Bean。

该使用示例在Spring Cloud中Ribbon是也有应用的。

在使用Ribbon做负载均衡时，在配置RestTemplate时会加入如下注解：

@LoadBalanced
@Bean
public RestTemplate restTemplate() {
  return new RestTemplate() ;
}
@Target({ ElementType.FIELD, ElementType.PARAMETER, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Inherited
@Qualifier
public @interface LoadBalanced {
}

在Ribbon的自动配置类中：

Spring注解@Qualifier的详细用法你知道几种