Springboot Condition 实用讲解,只看一遍包学会,狂神springboot笔记

本文详细介绍了如何在Spring Boot中利用@Conditional注解及其派生注解来控制Bean的实例化,包括自定义条件匹配、@ConditionalOnProperty实现属性匹配以及@ConditionalOnExpression基于SpEL表达式的条件判断。通过实例展示了如何根据配置文件的值动态决定Bean的创建,并探讨了不同条件注解的适用场景和限制。
摘要由CSDN通过智能技术生成

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能成功创建:

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

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


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

@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 :

![](https://img-blog.csdnimg.cn/8392

《一线大厂Java面试题解析+后端开发学习笔记+最新架构讲解视频+实战项目源码讲义》

【docs.qq.com/doc/DSmxTbFJ1cmN1R2dB】 完整内容开源分享

4ef897bb4604aca9bfd0681ffd0b.png?x-oss-process=image/watermark,type_ZHJvaWRzYW5zZmFsbGJhY2s,shadow_50,text_Q1NETiBA5bCP55uu5qCH6Z2S5bm0,size_20,color_FFFFFF,t_70,g_se,x_16)

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

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

我们把yml的值改一下:

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

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

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

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


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

接下来是多值匹对场景

示例 :

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

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

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

@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("’KaTeX parse error: Expected 'EOF', got '&' at position 26: ….equals('high')&̲&{app.public:true}")

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

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

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

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

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

如果是 布尔类型 ,我们写法是:

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

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值