Spring Boot @Condition 注解,组合条件你知道吗
Posted gossip
tags:
篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了Spring Boot @Condition 注解,组合条件你知道吗相关的知识,希望对你有一定的参考价值。
原文:https://www.cnblogs.com/FraserYu/p/11280420.html
上一篇文章 你应该知道的 @ConfigurationProperties 注解的使用姿势,这一篇就够了 介绍了如何通过 @ConfigurationProperties
注解灵活读取配置属性,这篇文章将介绍如何灵活配置 Spring Bean
写在前面
当我们构建一个 Spring 应用的时候,有时我们想在满足指定条件的时候才将某个 bean 加载到应用上下文中, 在Spring 4.0 时代,我们可以通过 @Conditional
注解来实现这类操作
我们看到 @Conditional
注解接收的参数是 extends Condition 接口的泛型类,也就是说,我们要使用 @Conditional
注解,只需要实现 Condition 接口并重写其方法即可:
看到接口的 matches 方法返回的是 boolean 类型,是不是和我们自定义 validation annotation 有些类似,都是用来判断是否满足指定条件。另外注意看,以上注解和接口都在 org.springframework.context.annotation
package 中
终于到了 Spring Boot 时代,在这个全新的时代,Spring Boot 在 @Conditional
注解的基础上进行了细化,无需出示复杂的介绍信 (实现 Condition 接口),只需要手持预定义好的 @ConditionalOnXxxx
注解印章的门票,如果验证通过,就会走进 Application Context 大厅
注解详解
Spring Boot 对 @Conditional
注解为我们做了细化,这些注解都定义在 org.springframework.boot.autoconfigure.condition
package 下
逐个打开这 13 个注解,我们发现这些注解上有相同的元注解:
从这些标记上我们可以了解如下内容:
-
都可以应用在 TYPE 上,也就是说,Spring 自动扫描的一切类 (@Configuration, @Component, @Service, @Repository, or @Controller) 都可以通过添加相应的
@ConditionalOnXxxx
来判断是否加载 -
都可以应用在 METHOD 上,所以有 @Bean 标记的方法也可以应用这些注解
-
都是用了
@Conditional
注解来标记,OnBeanCondition 等自定义 Condition 还是实现了 Condition 接口的,换汤不换药,没什么神秘的,只不过做了更具象的封装罢了,来看类依赖图:
其实看这些注解字面意思已经能理解这些注解的含义,但是我们还是要说明具体的使用以及一些注意事项,我按照个人使用频次由高到低讲解:
@ConditionalOnProperty
毫无疑问这个注解是榜首
这个条件解释是: application.properties 或 application.yml 文件中 mybean.enable 为 true 才会加载 MyCondition 这个 Bean,如果没有匹配上也会加载,因为 matchIfMissing = true,默认值是 false。
@ConditionalOnBean 和 ConditionalOnMissingBean
有时候我们需要某个 Bean 已经存在应用上下文时才会加载,那么我们会用到 @ConditionalOnBean
注解:
与之相反,有时候我们需要某个 Bean 不存在于应用上下文时才会加载,那么我们会用到 @ConditionalOnMissingBean
注解
@ConditionalOnClass 和 @ConditionalOnMissingClass
不要嫌我废话,和上面的一样,只不过判断某个类是否存在于 classpath 中,这就不做过多说明了
@ConditionalOnExpression
如果我们有更复杂的多个配置属性一起判断,那么我们就可以用这个表达式了:
只有当两个属性都为 true 的时候才加载 MyModule,到这里要顺便揭晓上一篇文章 你应该知道的 @ConfigurationProperties 注解的使用姿势,这一篇就够了 灵魂追问 3,其中 :true
就是: 如果没有为该属性设置值,则为该属性设置默认值true, 其实这就是@Vaue
注解的规范,一切 SpEL 都可以应用在这里.
写到这,我常用的已经用完了,还要硬着头皮介绍其他几个内容
以上是关于Spring Boot @Condition 注解,组合条件你知道吗的主要内容,如果未能解决你的问题,请参考以下文章
Spring Boot @Condition 注解,组合条件你知道吗
(007)Spring Boot之自动装配接口Condition对应注解Conditional及其一些默认实现
Spring Boot @Conditional相关注解解析