【Spring】@ConditionalOnProperty 注解的简单使用与介绍
简单介绍
@ConditionalOnProperty
注解是Spring Boot
的条件注解,主要用法是根据配置文件中的属性来控制某个配置类是否生效,或者控制某个Bean是否被创建。
就比如我们常用的在yml
中配置
server:port: 8080
能够起到启动服务以8080端口启动,而@ConditionalOnProperty
注解则是符合条件注入到Bean中,下面结合一些案例代码做出介绍。
@ConditionalOnProperty 注解中的属性介绍
属性名称 | 介绍 |
---|---|
prefix | 指定属性前缀 |
name | 指定属性名称 |
havingValue | 用来指定期望的属性值,如果配置的值等于期望值则执行 |
matchIfMissing | 当配置文件中不存在指定属性时的处理方式,处理方式有两个 true 和 false, true 是不存在指定属性时执行,false 是不执行 |
简单配置案例代码
控制配置类
yml
中配置以下信息:
biz:access: true
下面是配置类的代码实现:
@Configuration
@ConditionalOnProperty(prefix = "biz", name = "access", havingValue = "true")
public class AccessConfiguration implements HandlerInterceptor {
}
这里需要注意的是,@ConditionalOnProperty
注解只代表符合条件就执行注入,不代表它有@Configuration
注解的作用,所以想控制一个配置类是就需要有@ConditionalOnProperty
和@Configuration
注解。
控制Bean创建
那么当我想想控制配置类中的某个Bean是否注入时该怎么做呢,看下面代码示例:
yml
中配置以下信息:
biz:access: true
@Configuration
public class AccessConfiguration implements HandlerInterceptor {@Bean@ConditionalOnProperty(prefix = "biz", name = "access", havingValue = "true")public YourBeanFile preHandle() {return new YourBeanFile();}}
这样就能控制某个Bean的创建了。
简单配置案例代码
控制配置类
yml
中配置以下信息:
biz:access:token: true
下面是代码实现:
@Configuration
@ConditionalOnProperty(prefix = "biz.access", name = "token", havingValue = "true")
public class AccessConfiguration implements HandlerInterceptor {
}
可以看到复杂的配置与简单的配置有些不太一样,最后一个属性才是在@ConditionalOnProperty
注解的name
属性上。
控制Bean创建
yml
中配置以下信息:
biz:access:token: true
代码实现:
@Configuration
public class AccessConfiguration implements HandlerInterceptor {@Bean@ConditionalOnProperty(prefix = "biz.access", name = "token", havingValue = "true")public YourBeanFile preHandle() {return new YourBeanFile();}}
End