0
点赞
收藏
分享

微信扫一扫

Springboot Condition 实用讲解,只看一遍包学会


前言

该篇文章,还是一贯的风格,源码+示例+自言自语的分析,目的只有一个 :

就是想让大家都会玩 Condition、Conditional。

正文

先看看 Condition 是被放在包spring context(上下文/容器) 里面了:

Springboot Condition 实用讲解,只看一遍包学会_Conditional

spring context(上下文/容器)

接着我们看看作者写的 Condition 源码: 

ps: 学东西,一定要看看源码,往往作者留下的注释比你自己千方百计找的解释都好,当然你找到我这边的文章,另当别论(别当真)。

Springboot Condition 实用讲解,只看一遍包学会_OnProperty_02

 大致意思我给各位看官简述一下:

 利用 Condition ,在一个bean快被注册前, 我们可以根据任何的自由标准,立即触发条件的检查 ,使用 matches方法去 决定 是否注册。

看完注释,继续看下代码:

Springboot Condition 实用讲解,只看一遍包学会_OnProperty_03

1.   这是一个 interface,意味着可以实现,然后重写里面的方法函数。

2.   可以看到里面只有一个mathes(匹对)方法 ,boolean类型返回值 ,

      意思比较明确易懂,就是匹对 成功了,就是 符合条件;  反之,则反之。  


Springboot Condition 实用讲解,只看一遍包学会_OnProperty_04


然后看到还有@Conditional注解,这就是配套使用的,我们立刻进入示例实战,看看怎么用。

模拟一个场景:
 

一个实体类Dragon 神龙 ,我们需要创建这个bean,但是有条件。
  
这个bean被创建的条件是,
通过配置项可以得知当前项目7颗龙珠是否收集完了,只有收集到7颗才能召唤神龙。

我们先建实体类 Dragon.java :
 

/**
* @Author JCccc
* @Description
* @Date 2021/08/11 9:55
*/
public class Dragon {

private String name;
private Integer age;
private String master = "JCccc";



public Dragon(String name, Integer age) {
this.name = name;
this.age = age;
}

@Override
public String toString() {
return "Dragon{" +
"name='" + name + '\'' +
", age=" + age +
", master='" + master + '\'' +
'}';
}
}

然后在MyBeanConfig.java 里面把这个bean创建丢到容器里:
 

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Conditional;
import org.springframework.context.annotation.Configuration;

/**
* @Author JCccc
* @Description
* @Date 2021/10/19 10:01
*/
@Configuration
public class MyBeanConfig {

@Bean
@Conditional(DragonCondition.class)
public Dragon createDragon() {
return new Dragon("波伦加",18);
}


}

可以看到,我这创建bean,使用了 @Conditional :

@Conditional(DragonCondition.class)

没错,这就是我给 这个Dragon实体类 自定义的创建前置条件 ,DragonCondition :
 

ps: DragonCondition 实现了 Condition接口, 然后重写了匹对方法mathces,写了一些判断逻辑,从配置文件中取值,看看龙珠颗数是否为7。

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;

import java.util.Objects;

/**
* @Author JCccc
* @Description 召唤神龙的条件
* @Date 2021/10/19 10:03
*/
public class DragonCondition implements Condition {
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {

if (7 == Integer.parseInt(Objects.requireNonNull(context.getEnvironment().getProperty("summon.dragon-ball")))){
return true;
}

return false;
}
}

接下来,我们来测试一下,

我们在yml文件添加配置项:
 

summon: dragon-ball: 7

然后到测试类里面简单写个测试方法,看看Dragon 这个bean是否能成功被创建 :

import com.elegant.testdemo.happy.Dragon;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;



@SpringBootTest
class TestdemoApplicationTests {

@Autowired(required = false)
//Autowired 设置为false,允许注入的时候找不到的情况,不会报错
private Dragon dragon;

@Test
void contextLoads() {

System.out.println(dragon);

}

}

执行,可以看到,因为我们条件匹对符合,神龙bean能成功创建:


Springboot Condition 实用讲解,只看一遍包学会_Conditional_05

 那么我们把配置里面的龙珠颗树参数改一下,改成 5 :

Springboot Condition 实用讲解,只看一遍包学会_实例化_06

到这里,其实 基本的Condition 配合 @Conditional 注解的使用已经掌握了。

那么接下来,继续,我们开始玩一下这个派生注解:

Springboot Condition 实用讲解,只看一遍包学会_OnProperty_07

@ConditionalOnBean:当容器中有指定Bean的条件下进行实例化。
@ConditionalOnMissingBean:当容器里没有指定Bean的条件下进行实例化。
@ConditionalOnClass:当classpath类路径下有指定类的条件下进行实例化。
@ConditionalOnMissingClass:当类路径下没有指定类的条件下进行实例化。
@ConditionalOnWebApplication:当项目是一个Web项目时进行实例化。
@ConditionalOnNotWebApplication:当项目不是一个Web项目时进行实例化。
@ConditionalOnProperty:当指定的属性有指定的值时进行实例化。
@ConditionalOnExpression:基于SpEL表达式的条件判断。
@ConditionalOnJava:当JVM版本为指定的版本范围时触发实例化。
@ConditionalOnResource:当类路径下有指定的资源时触发实例化。
@ConditionalOnJndi:在JNDI存在的条件下触发实例化。
@ConditionalOnSingleCandidate:当指定的Bean在容器中只有一个,或者有多个但是指定了首选的Bean时触发实例化。

接下来我挑选几个常用的细细说说,

@ConditionalOnProperty

也就是说,我们可以让某个bean创建时,进行 配置值的匹对,符合条件了才能正常创建。

实践环节

单值匹对

示例:

RoleInitializer 这个bean,如果想让它正常实例化,我们需要检测yml配置文件里面,app.public的值是否为 true :

Springboot Condition 实用讲解,只看一遍包学会_Condition_08

 yml配置文件我们添加配置值:

Springboot Condition 实用讲解,只看一遍包学会_OnExpression_09

 启动项目,可以看到这个bean是符合条件的成功实例化:

Springboot Condition 实用讲解,只看一遍包学会_Condition_10

 我们把yml的值改一下:

Springboot Condition 实用讲解,只看一遍包学会_Condition_11

再启动项目,可以看到这个bean没有被实例化,因为不符合条件:

 

Springboot Condition 实用讲解,只看一遍包学会_实例化_12

 ps:到这,也许会有一些看官会有想法:

这样的使用注解去检测yml里面的值,跟我们直接拉去配置文件的值,写个if判断 不是一样吗?

答案: 看似一样,实则并不。 硬编码的概念。 实例化和没实例化的区别。 不多说。

还没完, 上面是 @ConditionalOnProperty比较简单的使用例子,单纯一个配置值的匹对。

接下来是多值匹对场景

示例 :

RoleInitializer 这个bean,如果想让它正常实例化,我们需要检测yml配置文件里面,app.public的值是否为 true 且 app.vip 的值 也为 true:

Springboot Condition 实用讲解,只看一遍包学会_实例化_13

关系是 且 ,也就是AND ,同时符合的概念,我们可以这么写:

@ConditionalOnProperty(name={"app.public","app.vip"}, havingValue="true")

Springboot Condition 实用讲解,只看一遍包学会_Condition_14

@ConditionalOnProperty的注解能够支撑的、常用的方式也就差不多这些,更多元化的匹对效果是无法支持的,例如我们想要 匹对条件值A 为 1 同时 B 为  2 ,这种情形就已经无法支撑了。
不过我们可以换个概念表达,变成 匹对条件值AB 为 12 .

而且再补充一点,目前@ConditionalOnProperty的使用都是 且 (AND) 关系,如果你要用OR的方式的条件,那么也是很 sorry,@ConditionalOnProperty 支撑不了。


除非我们使用文章一开始介绍的自定义condition,完全是ok的。

那么就只能用自定义condition去实现这些多条件的匹对场景了吗? 

答案是 : 并不 ,接下来看@ConditionalOnExpression 注解。

@ConditionalOnExpression :基于SpEL表达式的条件判断。

也是可以用于对配置文件的属性做一些匹对条件,但是功能强大很多。

就基于上面说到的例子,我们如果需要匹对的条件是多值:

app.public 值为 true  且 app.vip 值为 high 时 ,才能正常实例化RoleInitializer这个bean。

那么使用@ConditionalOnExpression ,我们可以这么写:

@ConditionalOnExpression("'${app.vip}'.equals('high')&&${app.public:true}")

从这,引申出一些 用法 的介绍:

如果我们想匹配的配置项的值 是字符串类型 ,我们写法是:
 

@ConditionalOnExpression("'${app.public}'.equals('JC')")

如果是 数字类型 ,我们写法是:
 

@ConditionalOnExpression("${app.public}==18")

如果是 布尔类型

@ConditionalOnExpression("${app.public:true}")

那么还有 与 关系 写法,使用  && :

@ConditionalOnExpression("'${app.vip}'.equals('high')&&${app.public:true}")

或 关系 写法,使用  || :

@ConditionalOnExpression("${app.public:true} || ${app.vip:true}")

继续下一个 ,

@ConditionalOnMissingBean:当容器里没有指定Bean的条件下进行实例化。

基于文章一开始的 Dargon示例我们继续 使用一下这个注解,

模拟场景:

 如果  Dargon 神龙没有符合条件实例化成功,那么我们自动召唤 阿拉丁神灯 作为备用。

Springboot Condition 实用讲解,只看一遍包学会_Conditional_15

 

Springboot Condition 实用讲解,只看一遍包学会_OnExpression_16

 DragonCondition 自定义的实例化条件,回顾一下:

Springboot Condition 实用讲解,只看一遍包学会_Condition_17

 现在故意把yml的神龙召唤配置值改成 不符合条件的数值:

Springboot Condition 实用讲解,只看一遍包学会_实例化_18

写个测试方法,执行一下:

Springboot Condition 实用讲解,只看一遍包学会_Condition_19

结果跟我们要的是一样的:

Springboot Condition 实用讲解,只看一遍包学会_Condition_20

我们反之再把相关的配置改成,符合 Dragon bean创建的的条件,这么一来,MagicLamp肯定就是不用创建出来了: 

Springboot Condition 实用讲解,只看一遍包学会_实例化_21

@ConditionalOnBean:当容器中有指定Bean的条件下进行实例化。

这个在我们刚才尝试过 OnMissingBean的使用后,我认为我们应该不需要看示例了。

也就是指定某个bean在实例化的前提 必须是 指定的bean先实例化之后才能实例化。

好了,该篇就暂时这么样吧。有问题,随时留言交流 。   点赞+1 ,收藏+1,关注+1

举报

相关推荐

0 条评论