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);
}
上面代码意义不大,@ConditionalOnMissingBean真正的意义是什么?
上面我的测试代码,在一个配置类中,注册了两个类型一样的bean,这种设计没什么实际意义,而@ConditionalOnMissingBean
真正意义在于它的扩展性,即当你封装一个组件时,你的组件有个默认的实现类,这时为默认的实现类bean上,添加@ConditionalOnMissingBean
;而在外部,开发人员根据业务定义自己的bean,这时它就有意义了,当在外部出现多个相同类型bean时,spring会为我们选择不带@ConditionalOnMissingBean注解的实现
;也就是说@ConditionalOnMissingBean
是当没有个性化bean时,提供一个默认的bean,这才是它的意义!
注意你的@ConditionalOnMissingBean是修饰@Bean的,不能修饰@Component这些注释的,它会失去作用。
@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 // 它是一种依赖,当@ConditionalOnBean(Fishing.class),表示当存在Fishing这个bean,才注册当前这个bean。
- @ConditionalOnMissingBean // 它是一种默认值,当没有自定义的bean时,就使用它产生的bean,@ConditionalOnMissingBean(FishFood.class)表示当没有FishFood实现的bean,就使用当前方法产生的FishFood的bean.
- @ConditionalOnClass // 当给定的类名在类路径上存在,就注册当前修饰的bean
- @ConditionalOnMissingClass // 当给定的类名在类路径上不存在,则实例化当前Bean,也是默认值的体现