springboot~@ConditionalOnMissingBean注解的作用


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

代碼演示

@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) 去掉之后,你的bean可以注冊多次,這時需要用的@Primary來確定你要哪個實現;一般來說,對於自定義的配置類,我們應該加上@ConditionalOnMissingBean注解,以避免多個配置同時注入的風險。

@Primary標識哪個是默認的bean


    @Bean
    public AMapper aMapper1(AConfig aConfig) {
        return new AMapperImpl1(aConfig);
    }

    @Bean
    @Primary
    public AMapper aMapper2(AConfig aConfig) {
        return new AMapperImpl2(aConfig);
    }

@ConditionalOnProperty

通過其三個屬性prefix,name以及havingValue來實現的,其中prefix表示配置文件里節點前綴,name用來從application.properties中讀取某個屬性值,havingValue表示目標值。

  • 如果該值為空,則返回false;
  • 如果值不為空,則將該值與havingValue指定的值進行比較,如果一樣則返回true;否則返回false。
  • 返回值為false,則該configuration不生效;為true則生效。

下面代碼演示為配置文件lind.redis.enable為true時才會注冊RedisFactory這個bean

@Configuration
@ConditionalOnProperty(prefix="lind.redis",name = "enable", havingValue = "true")
public class RedisConfig {
    @Bean
    public RedisMap redisMap(){
       return new RedisMapImpl();
    }
}

其它注釋及總結

  • @ConditionalOnBean // 當給定的在bean存在時,則實例化當前Bean,這個bean可能由於某種原因而沒有注冊到ioc里,這時@ConditionalOnBean可以讓當前bean也不進行注冊
  • @ConditionalOnMissingBean // 當給定的在bean不存在時,則實例化當前Bean,感覺這個是在多態環境下使用,當一個接口有多個實現類時,如果只希望它有一個實現類,那就在各個實現類上加上這個注解
  • @ConditionalOnClass // 當給定的類名在類路徑上存在,則實例化當前Bean
  • @ConditionalOnMissingClass // 當給定的類名在類路徑上不存在,則實例化當前Bean


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM