专栏首页Java系列文章@ConditionalOn...注解,条件组合你知道吗?

@ConditionalOn...注解,条件组合你知道吗?

上一篇文章 你应该知道的 @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 都可以应用在这里.

写到这,我常用的已经用完了,还要硬着头皮介绍其他几个内容 ?,开个玩笑,咱们继续:

@ConditionalOnSingleCandidate

这个注解和 @ConditionalOnBean 类似,为了更好的说明该注解的使用 (其实是 才疏学浅 ) ,我只能翻译一下类的注释了

只有指定类已存在于 BeanFactory 中,并且可以确定单个候选项才会匹配成功 BeanFactory 存在多个 bean 实例,但是有一个 primary 候选项被指定(通常在类上使用 @Primary 注解),也会匹配成功。实质上,如果自动连接具有定义类型的 bean 匹配就会成功 目前,条件只是匹配已经被应用上下文处理的 bean 定义,本身来讲,强烈建议仅仅在 auto-configuration 类中使用这个条件,如果候选 bean 被另外一个 auto-configuration 创建,确保使用该条件的要在其后面运行

@ConditionalOnResource

如果我们要加载的 bean 依赖指定资源是否存在于 classpath 中,那么我们就可以使用这个注解

看到这个 logback.xml 是不是很亲切,在我们引入第三方工具类如 Dozer 等都可以添加类似的开关

接下来的是真冷门,大家有个印象,如果有需要,至少能想到用这些注解实现灵活配置就好了

@ConditionalOnJndi

只有指定的资源通过 JNDI 加载后才加载 bean

@ConditionalOnJava

只有运行指定版本的 Java 才会加载 Bean

@ConditionalOnWebApplication 和 @ConditionalOnNotWebApplication

只有运行在 web 应用里才会加载这个 bean

与之相反,在非 web 环境才加载 bean

@ConditionalOnCloudPlatform

这个注解冷的我呼吸都要停止了,只有运行在指定的云平台上才加载指定的 bean,CloudPlatform 是 org.springframework.boot.cloud 下一个 enum 类型的类,大家可以打开自行看看:

到此,Spring Boot 为我们提供的这 13 个注解就介绍完了,但是没有结束,下面的一些冷门知识,你需要知道:

组合条件

好多时候,一个条件不能满足我们的要求,我们想多个条件一起使用,这就要求我们将他们组合起来去

组合条件 AND

如果我们想多个条件一起应用,并且条件的关系是 and,我们只需要在类上使用多个@ConditionalOnXxxx 就可以了 (你这也叫冷门?) ,当然也可以继承 AllNestedConditions类封装我们多个条件

这样就有了组合 and 条件,只有内部所有条件都满足,才加载指定 bean

组合条件 OR

如果我们希望组合的条件是 or 的关系,我们该怎么办呢?我们可以通过继承 AnyNestedCondition 来完成这一要求,示例代码和上面一样,大家自行打开 AnyNestedCondition类,查看类说明即可

条件组合 NONE

有 and 和 or 就肯定有 non(非),我们可以通过继承 NoneNestedConditions 完成这一要求,大家自行查看即可

## 自定义注解通过组合方式实现了多条件逻辑应用,我们需要应用这些组合条件也就要自定义注解,其实文章开头已经讲过了,模仿内置的 13 个注解写就好了:

只需要通过@Conditional注解指定我们自定义的 condition 类就好了,然后应用到你想用的地方就好了

还是推荐大家看 RabbitMq 的 RabbitAutoConfiguration类,这个类里面主流的注解都是用了 (只看这一个类就好了),大家看框架理解学习这些注解是更好的方式:

https://github.com/spring-projects/spring-boot/blob/master/spring-boot-project/spring-boot-autoconfigure/src/main/java/org/springframework/boot/autoconfigure/amqp/RabbitAutoConfiguration.java

总结

其实这些注解做的就是 if-then-else 的事,到这里,你已经了解了如何灵活配置 bean,结合之前的文章,相信的定义会更加灵活,希望大家打开 IDE,自行查看这些注解,了解更多具体内容

本文分享自微信公众号 - 乱敲代码(gh_baf1250e9b02)

原文出处及转载信息见文内详细说明,如有侵权,请联系 yunjia_community@tencent.com 删除。

原始发表时间:2019-10-30

本文参与腾讯云自媒体分享计划,欢迎正在阅读的你也加入,一起分享。

我来说两句

0 条评论
登录 后参与评论

相关文章

  • SpringBoot如何优雅的校验参数

    做web开发有一点很烦人就是要校验参数,基本上每个接口都要对参数进行校验,比如一些格式校验 非空校验都是必不可少的。如果参数比较少的话还是容易 处理的一但参数比...

    乱敲代码
  • SpringBoot整合Shiro(二)

    filterChainDefinitionMap中设置的anon有什么作用?是直接放开权限吗。。

    乱敲代码
  • 一张图讲解对象锁和关键字synchronized修饰方法(代码块)

    每个对象在出生的时候就有一把钥匙(监视器Monitor),那么被synchronized 修饰的方法相当于给方法加了一个锁,这个方法就可以进行同步,在多线程的时...

    乱敲代码
  • @ConditionalOn...注解,条件组合你知道吗?

    上一篇文章 你应该知道的 @ConfigurationProperties 注解的使用姿势,这一篇就够了 介绍了如何通过 @ConfigurationPrope...

    码农小胖哥
  • @ConditionalOn...注解,条件组合你知道吗?

    上一篇文章 你应该知道的 @ConfigurationProperties 注解的使用姿势,这一篇就够了 介绍了如何通过 @ConfigurationPrope...

    用户4172423
  • Java 进阶巩固:什么是注解以及运行时注解的使用

    这篇文章 2016年12月13日星期二 就写完了,当时想着等写完另外一篇关于自定义注解的一起发。结果没想到这一等就是半年多 - -。 有时候的确是这样啊,总想着...

    张拭心 shixinzhang
  • Java 进阶巩固:什么是注解以及运行时注解的使用

    这篇文章 2016年12月13日星期二 就写完了,当时想着等写完另外一篇关于自定义注解的一起发。结果没想到这一等就是半年多 - -。 有时候的确是这样啊,总想着...

    张拭心 shixinzhang
  • Java编程之反射中的注解详解

    “注解”这个词,可谓是在Java编程中出镜率比较高,而且也是一个老生常谈的话题。我们之前在聊Spring相关的东西时,注解是无处不在,之前我们简单的聊过一些“注...

    lizelu
  • java注解及在butternife中的实践和原理

    1. 背景 之前去一个公司,说到了java的注解,问java的注解有几种方式,然后我提到了android中的butternife和afinal注解工具,我们知道...

    xiangzhihong
  • Java注解

     自Java5.0版本引入注解之后,它就成为了Java平台中非常重要的一部分。Annotion(注解)是一个接口,程序可以通过反射来获取指定程序元素的Annot...

    xiangzhihong

扫码关注云+社区

领取腾讯云代金券