springboot~@ConditionalOnMissingBean注解的(de)作用(yong)
@ConditionalOnMissingBean,它是修飾bean的一個注解,主要實現的是,當你的bean被注冊之后,如果而注冊相同類型的bean,就不會成功,它會保證你的bean只有一個,即你的實例只有一個,當你注冊多個相同的bean時,會出現異常,以此來告訴開發人員。

代碼演示
@Component
public class AutoConfig {
@Bean
public AConfig aConfig() {
return new AConfig("lind");
}
@Bean
@ConditionalOnMissingBean(AMapper.class)
public AMapper aMapper1(AConfig aConfig) {
return new AMapperImpl1(aConfig);
}
@Bean
public AMapper aMapper2(AConfig aConfig) {
return new AMapperImpl2(aConfig);
}
}
因為在aMapper1上面標識了AMapper類型的bean只能有一個實現 @ConditionalOnMissingBean(AMapper.class),所以在進行aMapper2注冊時,系統會出現上面圖上的異常,這是正常的。
當我們把 @ConditionalOnMissingBean(AMapper.class) 去(qu)掉之后,你的(de)bean可(ke)以(yi)注冊多次,這(zhe)時(shi)需要用(yong)的(de)@Primary來確定(ding)你要哪個實(shi)現;一般(ban)來說,對于自定(ding)義的(de)配(pei)置類,我們應該加上@ConditionalOnMissingBean注解,以(yi)避免多個配(pei)置同時(shi)注入的(de)風險。
@Primary標識哪個是默認的bean
@Bean
public AMapper aMapper1(AConfig aConfig) {
return new AMapperImpl1(aConfig);
}
@Bean
@Primary
public AMapper aMapper2(AConfig aConfig) {
return new AMapperImpl2(aConfig);
}
上面代碼意義不大,@ConditionalOnMissingBean真正的意義是什么?
上面我的測試代碼,在一個配置類中,注冊了兩個類型一樣的bean,這種設計沒什么實際意義,而@ConditionalOnMissingBean真正意義在于它的擴展性,即當你封裝一個組件時,你的組件有個默認的實現類,這時為默認的實現類bean上,添加@ConditionalOnMissingBean;而在外部,開發人員根據業務定義自己的bean,這時它就有意義了,當在外部出現多個相同類型bean時,spring會為我們選擇不帶@ConditionalOnMissingBean注解的實現;也就是說@ConditionalOnMissingBean是當(dang)沒有個(ge)性化bean時,提供一(yi)個(ge)默認的bean,這才是它的意義!
注意你的(de)@ConditionalOnMissingBean是(shi)修(xiu)飾@Bean的(de),不能修(xiu)飾@Component這些注釋的(de),它會失去作(zuo)用。
@ConditionalOnProperty
通過其三(san)個屬性prefix,name以及havingValue來實現的,其中(zhong)prefix表示配(pei)置文(wen)件里(li)節點(dian)前綴,name用來從application.properties中(zhong)讀取某個屬性值,havingValue表示目標值。
- 如果該值為空,則返回false;
- 如果值不為空,則將該值與havingValue指定的值進行比較,如果一樣則返回true;否則返回false。
- 返回值為false,則該configuration不生效;為true則生效。
下(xia)面代碼演示為(wei)配置文件lind.redis.enable為(wei)true時才會注冊RedisFactory這個bean
@Configuration
@ConditionalOnProperty(prefix="lind.redis",name = "enable", havingValue = "true")
public class RedisConfig {
@Bean
public RedisMap redisMap(){
return new RedisMapImpl();
}
}
其它注釋及總結
- @ConditionalOnBean // 它是一種依賴,當@ConditionalOnBean(Fishing.class),表示當存在Fishing這個bean,才注冊當前這個bean。
- @ConditionalOnMissingBean // 它是一種默認值,當沒有自定義的bean時,就使用它產生的bean,@ConditionalOnMissingBean(FishFood.class)表示當沒有FishFood實現的bean,就使用當前方法產生的FishFood的bean.
- @ConditionalOnClass // 當給定的類名在類路徑上存在,就注冊當前修飾的bean
- @ConditionalOnMissingClass // 當給定的類名在類路徑上不存在,則實例化當前Bean,也是默認值的體現