Spring注解@Qualifier這些用法，你都清楚嗎？

作者：Springboot實戰案例錦集 2023-08-04 08:25:03

開發前端

RibbonClientConfiguration.java ribbon客戶端相關配置，比如：負載均衡的算法，服務列表的更新，ping健康檢查等。如果想自定義實現負載均衡算法可以實現IRule類。

環境：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 ;

圖片

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集合：

圖片

集合中注入了2個Date Bean。

修改代碼：

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

在屬性上加入@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() ;

運行：

圖片

注入了一個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的自動配置類中：

圖片