在开发spring boot框架的项目时,需要控制配置类是否生效,这个时候就要用到@ConditionalOnProperty注解;
@ConditionalOnProperty注解可以通过配置文件中的属性值,来判定configuration是否被注入;
源码
ConditionalOnProperty的源码
package org.springframework.boot.autoconfigure.condition;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import org.springframework.context.annotation.Conditional;
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
@Documented
@Conditional({OnPropertyCondition.class})
public @interface ConditionalOnProperty {
String[] value() default {};
String prefix() default "";
String[] name() default {};
String havingValue() default "";
boolean matchIfMissing() default false;
}
属性说明
value: 获取对应property名称的值,与name不可同时使用
prefix: 配置项的前缀,可有可无
name: property完整名称或部分名称(可与prefix组合使用,组成完整的property名称),与value不可同时使用
havingValue: 可与name组合使用,比较获取到的属性值与havingValue给定的值是否相同,当两个值相同返回true相同才加载配置
matchIfMissing: 如果配置文件中, 没有该配置项, 判断是否加载BEAN, 默认为false。
用法
通过其两个属性name
以及havingValue
来实现的,其中name
用来从application.properties
中读取某个属性值。
如果该值为空,则返回false
; 如果值不为空,则将该值与havingValue
指定的值进行比较,
如果一样则返回true
;否则返回false
。 如果返回值为false
,则该configuration
不生效;为true
则生效。
示例
以数据源配置为例:
配置文件信息:
spring:
datasource:
type: com.alibaba.druid.pool.DruidDataSource
driverClassName: com.mysql.cj.jdbc.Driver
druid:
# 主库数据源
master:
url: jdbc:mysql://127.0.0.1/test1?useUnicode=true&characterEncoding=utf8&zeroDateTimeBehavior=convertToNull&useSSL=true&serverTimezone=GMT%2B8
username: root
password: 123456
# 从库数据源
slave:
# 从数据源开关/默认关闭
enabled: true
url: jdbc:mysql://127.0.0.1:3306/test2?useUnicode=true&characterEncoding=utf-8&useSSL=false
username: root
password: 123456
注解使用:
@Configuration
public class DynamicDataSourceConfig
{
@Bean
@ConfigurationProperties("spring.datasource.druid.master")
public DataSource masterDataSource(DruidProperties druidProperties)
{
}
@Bean
@ConfigurationProperties("spring.datasource.druid.slave")
@ConditionalOnProperty(prefix = "spring.datasource.druid.slave", name = "enabled", havingValue = "true")
public DataSource slaveDataSource(DruidProperties druidProperties)
{
}
.
.
.
}
- 指定了
prefix,name,havingValue
,因配置项为true
,所以会加载slave
库。
拓展
Spring Boot
对 @Conditional
注解为我们做了细化,类似的注解共有14个,这些注解都定义在 org.springframework.boot.autoconfigure.condition
包下。
以上圈起來的注解:
- 都可以应用在
TYPE
上;(可以理解为:Spring 自动扫描的一切类 (@Configuration
,@Componen
t,@Service
,@Repository
,@Controller
) 都可以通过添加相应的@ConditionalOnXxxx
来判断是否加载;) - 都可以应用在
METHOD
上,所以有@Bean
标记的方法也可以应用这些注解; - 都使用了 @Conditional 注解来标记,OnBeanCondition 等自定义 Condition 也是实现了 Condition 接口