springboot~ ConditionalOnMissingBean注解的作用


@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) 去掉之后,你的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


原文链接:https://www.cnblogs.com/lori/p/13490005.html