Spring-Boot autoconfigure之Condition

本文主要介绍spring和springboot提供的几个annotation和interface实现符合几种既定条件或自定义条件下的autoconfigure


一、spring实现自定义条件下的autoconfigure

spring为我们提供了@ConditionalCondition.class搭配使用的方式实现自定义条件下的autoconfigure,源码如下:

Condition.png

@Conditional.png

编写一个class,继承Condition这个接口,重写matches()方法,当该方法返回true时auto-configure生效,反之不生效,代码如下

public class MyCondition implements Condition {

    @Override
    public boolean matches(ConditionContext conditionContext, AnnotatedTypeMetadata annotatedTypeMetadata) {

        //what.is.you.name的value写在application.properties中
        String name = conditionContext.getEnvironment().getProperty("what.is.you.name");
        return "bamu".equals(name);
    }
}

matches方法提供了ConditionContextAnnotatedTypeMetadata两个参数,我们可以通过ConditionContext获取到编写在application-xxx.properties中的配置信息。

application.properties配置文件内容如下:注意我们现在定义的value和Mycondition中定义的不同

what.is.you.name=heiheihei

编写一个Config类,其中runnableBean1、runnableBean3需要满足我们以上自定义的条件才允许被自动注入。

@SpringBootConfiguration
public class ConditionBeanConfig {

    @Bean
    @Conditional(MyCondition.class)
    public Runnable runnableBean1() {
        return () ->{};
    }

    @Bean
    public Runnable runnableBean2() {
        return () ->{};
    }

    @Bean
    @Conditional(MyCondition.class)
    public Runnable runnableBean3() {
        return () ->{};
    }
}

执行main方法结果如下:

@SpringBootApplication
public class BlogApplication {

    public static void main(String[] args) {

        ConfigurableApplicationContext context = SpringApplication.run(BlogApplication.class, args);
        String[] beans = context.getBeanNamesForType(Runnable.class);
        System.out.println(Arrays.toString(beans));

        context.close();
    }
}

heiheihei.png

修改application.properties,将value改为MyCondition.class中定义的值后执行结果如下:

bamu.png

我们发现,自定义的MyCondition已经生效。细心的读者可能发现,@Conditional注解源码中传入的value是一个数组Class<? extends Condition>[] value();,所以我们可以传入多个自定义Condition,例如@Condition({MyCondition.class, YourCondition.class})

另外,@Conditianal不仅可以写在方法上,还可以写在configuration.class上,这样该类中的所有bean都需要满足自定义的Condition才能被自动加载。

二、spring-boot提供的几个autoconfigure annotation

springboot为我们提供了一批实用的XxxCondition,查看了他们的源码后发现,他们都实现了spring提供的Condition接口,然后编写对应的annotation。我们在使用他们的时候,只需要在需要的地方写上这些annotation就好了。这些注解都在springboot提供的jar包中
package org.springframework.boot.autoconfigure.condition

springboot提供的Condition注解.png

通过这几个annotation的命名,我们已经能够大概的猜测到他们能够实现哪些功能。以下举出其中几个比较常用的注解用法,读者可以查看源码,知晓具体的使用方式。

1)@ConditionalOnBean/@ConditionalOnMissingBean当容器中存在/不存在某个bean时,加上此注解的bean被自动注入

@ConditionalOnBean
    @Bean
    @ConditionalOnBean(name="com.springboot.condition.User")
    public Runnable runnableBean2() {
        return () ->{};
    }

    @Bean
    @ConditionalOnBean(value=User.class)
    public Runnable runnableBean2() {
        return () ->{};
    }

2)@ConditionalOnJava根据当前使用的JDK版本,判断是否自动注入

    //使用jdk8才注入此bean
    @Bean
    @ConditionalOnJava(ConditionalOnJava.JavaVersion.EIGHT)
    public Runnable runnableBean2() {
        return () ->{};
    }

3)@ConditionalOnWebApplication/@ConditionalOnWebApplicationweb环境下加载/不加载此bean

    @Bean
    @ConditionalOnWebApplication
    public Runnable runnableBean2() {
        return () ->{};
    }

好了,Spring-Boot autoconfigure之Condition就到这里,有兴趣的读者可以自己去试验一下。接下来会持续推出一系列Java干货,敬请期待。如果有不正确或是不完整的地方,还望读者不吝赐教,直接评论!

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,847评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,208评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,587评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,942评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,332评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,587评论 1 218
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,853评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,568评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,273评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,373评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,031评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2 269

推荐阅读更多精彩内容