SpringBoot @ConditionalOnProperty 注解
简介
@ConditionalOnProperty:根据属性值来控制类或某个方法是否需要加载。它既可以放在类上也可以放在方法上。
@ConditionalOnProperty属性
@Retention(RetentionPolicy.RUNTIME)
@Target({ ElementType.TYPE, ElementType.METHOD })
@Documented
@Conditional(OnPropertyCondition.class)
public @interface ConditionalOnProperty {/*** name别名,数组类型,获取对应property名称的值,与name不能同时使用*/String[] value() default {};/*** 属性前缀,未指定时,自动以点"."结束,有效前缀由一个或多个词用点"."连接。比如spring.http.encoding* 如:spring.datasource*/String prefix() default "";/*** 属性名称,配置属性完整名称或部分名称,可与prefix组合使用,不能与value同时使用*/String[] name() default {};/*** 可与name组合使用,比较获取到的属性值与havingValue的值是否相同,相同才加载配置*/String havingValue() default "";/*** 缺少该配置属性时是否加载,默认为false。如果为true,没有该配置属性时也会正常加载;反之则不会生效*/boolean matchIfMissing() default false;
}
使用方法
@ConditionalOnProperty的核心功能是通过属性name以及havingValue来实现的。
matchIfMissing 属性
如果配置文件中未进行对应属性配置时的默认处理:默认情况下matchIfMissing为false,也就是说如果未进行属性配置,则自动配置不生效。
如果matchIfMissing为true,则表示如果没有对应的属性配置,则自动配置默认生效。
name 属性
从配置文件 application.properties / application.yml中读取某个属性值.
注意:matchIfMissing为false时, name 如果为空,则返回false,如果name 不为空,那就会去与havingValue判断。如果一样则返回true,反之返回false,返回false 的话,就不会去加载了哦
havingValue
匹配属性里的值
非常简单的示例
配置文件
# 是否加载
is_load_bean: true
@Slf4j
@Configuration
public class LoadConditionalProperty {@Value("${is_load_bean}")private String isLoadBean;@Bean@ConditionalOnProperty(value = "is_load_bean",havingValue = "true",matchIfMissing = true)public void loadBean(){log.info("是否加载当前类");}@Beanpublic void compareLoadBean(){log.info("加载bean属性:" + isLoadBean);}
}
我们可以通过修改配置文件中is_load_bean的值,观察BEAN是否加载。
补充个例子
假如我们需要把User加载到 容器里面。
public class User {
}
@Slf4j
@Configuration
public class UserConfig {@Bean@ConditionalOnProperty(value = "is_load_bean",havingValue = "true",matchIfMissing = true)public User user(){return new User();}
}
最后的最后
像此类的注解还是有很多,比如:
注解名称 | 说明 |
---|---|
@ConditionalOnClass | 当Spring加载的Bean被@ConditionOnClass注解标记时,类加载器会先去先找到指定的Class, 如果没有找到目标Class,那么被ConditionOnClass注解标记的类不会被Spring装载 |
@ConditionalOnMissingClass | 跟上面相反,ConditionalOnMissingBean是指如果没有找到目标Class, 那么就装载该类 |
@ConditionalOnBean | 当Spring加载的Bean被@ConditionalOnBean注解标记时,接下来会先找到指定的Bean,如果没有找到目标Bean,那么被@ConditionalOnBean标记的类不会被Spring装载 |
@ConditionalOnMissingBean | 跟上面相反,ConditionalOnMissingBean是指如果没有Class, 那么就装载该Bean。 |