Spring Boot @Conditional注解

       在Spring Boot中,@Conditional 注解用于条件性地注册bean。这意味着它可以根据某些条件来决定是否应该创建一个特定的bean。这个注解可以放在配置类或方法上,并且它会根据提供的一组条件来判断是否应该实例化对应的组件。

       要使用 @Conditional注解时,需要实现 Condition 接口并重写 matches 方法。此方法将返回一个布尔值以指示条件是否匹配。如果条件为真,则创建bean;否则跳过该bean的创建。

以下是一个简单的例子,展示了如何使用自定义条件:

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;public class MyCustomCondition implements Condition {@Overridepublic boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {// 在这里添加你的条件逻辑// 例如,检查系统属性、环境变量、已经存在的beans等return false; // 根据条件逻辑返回true或false}
}
  • ConditionContext:提供了对当前解析上下文的访问,包括:
    • Environment:可以用来获取环境变量、系统属性等。
    • BeanFactory:如果可用的话,可以通过它访问已经注册的bean。
    • ClassLoader:可以用来检查类路径上的类是否存在。
    • EvaluationContext:可以用来评估SpEL表达式。
  • AnnotatedTypeMetadata 提供了对带有注解的方法或类元数据的访问,例如注解属性值。

自定义条件类

假设我们有一个应用程序,它应该根据操作系统的不同来决定是否加载特定的bean。我们可以创建一个名为 OnWindowsCondition 的条件类:

import org.springframework.context.annotation.Condition;
import org.springframework.context.annotation.ConditionContext;
import org.springframework.core.type.AnnotatedTypeMetadata;public class OnWindowsCondition implements Condition {@Overridepublic boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {return "win".equals(context.getEnvironment().getProperty("os.name").toLowerCase().substring(0, 3));}
}

然后在配置类中使用:

@Configuration
public class MyConfig {@Bean@Conditional(OnWindowsCondition.class)public WindowsSpecificService windowsSpecificService() {return new WindowsSpecificServiceImpl();}
}

Spring Boot提供内置条件注解

@ConditionalOnProperty

当你希望基于配置文件中的属性是否存在或者具有特定值来创建bean时,可以使用 @ConditionalOnProperty 注解。例如:

@Configuration
public class MyConfig {@Bean@ConditionalOnProperty(name = "my.feature.enabled", havingValue = "true")public MyFeature myFeature() {return new MyFeature();}
}

在这个例子中,只有当配置文件中存在名为 my.feature.enabled 的属性且其值为 true 时,才会创建 MyFeature bean。

更多用法
  • prefix:指定属性名前缀。
  • name:指定属性名(可以是数组,表示多个属性)。
  • havingValue:指定属性必须具有的值,默认为空字符串。
  • matchIfMissing:如果未找到属性,则默认匹配与否,默认为 false

例如,你可以这样配置:

@Bean
@ConditionalOnProperty(prefix = "app", name = "feature.enabled", havingValue = "true", matchIfMissing = false)
public FeatureService featureService() {return new FeatureServiceImpl();
}

这将确保只有在 app.feature.enabled=true 时才会创建 FeatureService bean;如果没有设置该属性且 matchIfMissing=false,则不会创建。

@ConditionalOnClass 和 @ConditionalOnMissingClass

这两个注解用于检查类路径下是否存在或不存在某些类。这在集成第三方库时非常有用,因为你可以有条件地注册与这些库相关的bean。例如:

@Configuration
@ConditionalOnClass(name = "com.example.ExternalLibraryClass")
public class ExternalLibraryConfig {// ...
}

如果类路径中存在 ExternalLibraryClass 类,则会应用此配置。

@ConditionalOnBean 和 @ConditionalOnMissingBean

这些注解用于根据上下文中是否存在指定类型的bean来决定是否创建新的bean。这对于确保不会重复注册相同功能的bean非常有用。

@Bean
@ConditionalOnMissingBean(MyService.class)
public MyService myService() {return new MyServiceImpl();
}

这里的意思是:如果上下文中还没有类型为 MyService 的bean,则创建一个新的 MyServiceImpl 实例并注册为bean。

使用 SpEL 表达式的 @ConditionalOnExpression

可以通过 @ConditionalOnExpression 来编写复杂的条件表达式。例如,基于多个属性组合或者环境变量来决定是否创建bean。

@Bean
@ConditionalOnExpression("${spring.application.name:'default'} == 'myapp' && ${env:dev} == 'prod'")
public ProdSpecificBean prodSpecificBean() {return new ProdSpecificBean();
}

这段代码意味着只有当应用程序名称为 'myapp' 并且环境变量 env 设置为 'prod' 时,才会创建 ProdSpecificBean

使用场景

动态条件评估

有时你可能需要在应用启动后根据某些变化(如用户输入或外部服务的状态)来动态调整bean的行为。虽然 @Conditional 主要用于启动时的静态条件判断,但你可以通过结合其他机制(如事件监听器、定时任务等)来实现类似的效果。

@Configuration
public class DynamicConditionConfig {private final AtomicBoolean shouldCreateBean = new AtomicBoolean(false);@Bean@ConditionalOnProperty(name = "dynamic.bean.enabled", havingValue = "true")public MyDynamicBean myDynamicBean() {return () -> shouldCreateBean.get();}// 模拟外部触发更新条件状态的方法public void updateCondition(boolean value) {shouldCreateBean.set(value);}
}

在这个例子中,MyDynamicBean 的行为依赖于一个原子布尔变量 shouldCreateBean,该变量可以在运行时被更改,从而影响bean的行为。

条件化的AOP切面

你还可以将条件应用于AOP切面,以实现更加灵活的横切关注点管理。例如:

@Aspect
@ConditionalOnProperty(name = "app.logging.enabled", havingValue = "true")
public class LoggingAspect {@Around("execution(* com.example.service.*.*(..))")public Object logExecutionTime(ProceedingJoinPoint joinPoint) throws Throwable {long start = System.currentTimeMillis();Object proceed = joinPoint.proceed();long executionTime = System.currentTimeMillis() - start;System.out.println(joinPoint.getTarget().getClass().getName() + "." + joinPoint.getSignature().getName() + " executed in " + executionTime + "ms");return proceed;}
}

这段代码表示只有当 app.logging.enabled=true 时才会激活日志记录切面。

使用 @Profile 和 @Conditional 结合

有时候,你可能想要结合 @Profile@Conditional 来创建更精细的条件逻辑。例如:

@Configuration
@Profile("dev")
public class DevConfig {@Bean@ConditionalOnProperty(name = "feature.x.enabled", havingValue = "true")public FeatureX featureX() {return new FeatureXImpl();}
}

这里的意思是:仅在开发环境(dev profile)并且 feature.x.enabled=true 时才创建 FeatureX bean。

条件化代理

对于那些需要延迟初始化或者懒加载的bean,可以考虑使用 @Scope("proxy")@Lazy 注解,结合 @Conditional 来实现条件化代理。

@Bean
@Scope(proxyMode = ScopedProxyMode.TARGET_CLASS)
@Lazy
@ConditionalOnProperty(name = "lazy.init.feature", havingValue = "true")
public LazyInitFeature lazyInitFeature() {return new LazyInitFeatureImpl();
}

这确保了只有在满足条件且首次访问 lazyInitFeature bean时才会实例化它。

调试技巧

使用 @PostConstruct 和 @PreDestroy 监控bean生命周期

为了更好地理解哪些bean被创建或销毁,可以在bean类中添加 @PostConstruct@PreDestroy 方法,并输出日志信息。

@Component
@ConditionalOnProperty(name = "feature.y.enabled", havingValue = "true")
public class FeatureY {@PostConstructpublic void init() {System.out.println("FeatureY initialized.");}@PreDestroypublic void destroy() {System.out.println("FeatureY destroyed.");}
}

这种方法有助于跟踪bean的生命周期,并确认条件是否按预期工作。

使用 spring.main.banner-mode=off 减少干扰

当你专注于调试条件逻辑时,关闭Spring Boot启动横幅可以帮助减少不必要的输出,使日志更加清晰。

spring.main.banner-mode=off

常见问题

环境属性未正确加载

如果发现条件注解没有按照预期工作,请检查是否正确加载了环境属性文件(如 application.propertiesapplication.yml)。确保这些文件位于正确的路径下,并且包含所需的属性定义。

类路径冲突

当遇到条件注解不起作用的问题时,类路径冲突是一个常见的原因。特别是当你使用 @ConditionalOnClass@ConditionalOnMissingClass 时,确保项目中不存在重复的依赖项。你可以使用Maven或Gradle命令来分析依赖树:

  • Maven:
    mvn dependency:tree
  • Gradle:
    gradle dependencies

条件逻辑错误

仔细审查你的条件逻辑,确保它们符合预期。可以通过单元测试验证每个条件的行为。例如:

@Test
void testFeatureYEnabled() {ApplicationContextRunner runner = new ApplicationContextRunner().withPropertyValues("feature.y.enabled=true");runner.run(context -> assertThat(context).hasSingleBean(FeatureY.class));
}@Test
void testFeatureYDisabled() {ApplicationContextRunner runner = new ApplicationContextRunner().withPropertyValues("feature.y.enabled=false");runner.run(context -> assertThat(context).doesNotHaveBean(FeatureY.class));
}

注意事项

  • 条件注解只适用于Spring的配置阶段,因此它们不能用于运行时决策。
  • 当使用 @Conditional 或其他条件注解时,请确保你的条件逻辑不会导致循环依赖或意外的行为。
  • 在编写条件逻辑时,考虑到性能影响,尽量使条件判断轻量级。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/web/64261.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

项目上传到gitcode

首先需要在个人设置里面找到令牌 记住自己的账号和访问令牌(一长串),后面git要输入这个, 账号是下面这个 来到自己的仓库 #查看远程仓库,是不是自己的云仓库 git remote -v # 创建新分支 git checkout -b llf # 三步…

【Rust自学】6.4. 简单的控制流-if let

喜欢的话别忘了点赞、收藏加关注哦,对接下来的教程有兴趣的可以关注专栏。谢谢喵!(・ω・) 6.4.1. 什么是if let if let语法允许将if和let组合成一种不太冗长的方式来处理与一种模式匹配的值,同时忽略其余模式。 可以…

【Git学习】windows系统下git init后没有看到生成的.git文件夹

[问题] git init 命令后看不到.git文件夹 [原因] 文件夹设置隐藏 [解决办法] Win11 win10

vscode添加全局宏定义

利用vscode编辑代码时,设置了禁用非活动区域着色后,在一些编译脚本中配置的宏又识别不了 遇到#ifdef包住的代码就会变暗色,想查看代码不是很方便。如下图: 一 解决: 在vscode中添加全局宏定义。 二 步骤&#xff1a…

【服务器主板】定制化:基于Intel至强平台的全新解决方案

随着数据处理需求不断增长,服务器硬件的发展也在持续推进。在这一背景下,为用户定制了一款全新的基于Intel至强平台的服务器主板,旨在提供强大的计算能力、优异的内存支持以及高速存储扩展能力。适用于需要高性能计算、大规模数据处理和高可用…

php怎么去除数点后面的0

在PHP中,我们可以使用几种方法来去除数字小数点后的0。 方法一:使用intval函数 intval函数可以将一个数字转化为整数,另外,它也可以去除小数点后面的0。 “php $number 123.4500; $number intval($number); echo $number; // 输…

数字后端培训项目Floorplan常见问题系列专题续集1

今天继续给大家分享下数字IC后端设计实现floorplan阶段常见问题系列专题。这些问题都是来自于咱们社区IC后端训练营学员提问的问题库。目前这部分问题库已经积累了4年了,后面会陆续分享这方面的问题。 希望对大家的数字后端学习和工作有所帮助。 数字后端项目Floor…

【递归,搜索与回溯算法 综合练习】深入理解暴搜决策树:递归,搜索与回溯算法综合小专题(二)

优美的排列 题目解析 算法原理 解法 :暴搜 决策树 红色剪枝:用于剪去该节点的值在对应分支中,已经被使用的情况,可以定义一个 check[ ] 紫色剪枝:perm[i] 不能够被 i 整除,i 不能够被 per…

Java中各种数组复制方式的效率对比

在 Java 中,数组复制是一个常见的操作,尤其是在处理动态数组(如 ArrayList)时。Java 提供了多种数组复制的方式,每种方式在性能和使用场景上都有所不同。以下是对几种主要数组复制方式的比较,包括 System.a…

视频会议是如何实现屏幕标注功能的?

现在主流的视频会议软件都有屏幕标注功能,屏幕标注功能给屏幕分享者讲解分享内容时提供了极大的方便。那我们以傲瑞视频会议(OrayMeeting)为例,来讲解屏幕标注是如何实现的。 傲瑞会议的PC端(Windows、信创Linux、银河…

Framework开发入门(一)之源码下载

一、使用Linux操作系统的小伙伴可以跳转到官网链接按提示操作 官网源码地址:下载源代码 | Android Open Source Project 1.创建一个空目录来存放您的工作文件。为其指定一个您喜欢的任意名称: mkdir WORKING_DIRECTORYcdWORKING_DIRECTORY …

改进爬山算法之四:概率爬山法(Probabilistic Hill Climbing,PHC)

概率爬山法(Probabilistic Hill Climbing,PHC)是一种局部搜索算法,它结合了随机性和贪婪搜索的特点,是对爬山算法(Hill Climbing Algorithm)的一种变体或扩展。与传统的爬山法不同,PHC不是总是选择最优的邻居作为下一步的移动,而是以一定的概率选择最优邻居,同时以一…

Unity中实现人物残影效果

今天火柴人联盟3公测了,看到一个残影的效果,很有意思,上网查询了一下实现方式, 实现思路: 将角色的网格复制出来,然后放置到新建的物体的MeshFilter组件上,每隔几十毫秒在玩家的位置生成一个&a…

C#实现调用DLL 套壳读卡程序(桌面程序开发)

背景 正常业务已经支持 读三代卡了,前端调用医保封装好的服务就可以了,但是长护要读卡,就需要去访问万达,他们又搞了一套读卡的动态库,为了能够掉万达的接口,就需要去想办法调用它们提供的动态库方法&…

自动挡有什么优势

自动挡汽车相比手动挡汽车具有多方面的优势,以下是对这些优势的详细阐述: 一、操作简便性 无需手动换挡:自动挡汽车不需要驾驶员手动操作离合器和换挡杆,只需通过油门和刹车踏板来控制车速,大大降低了驾驶难度。这使…

菜鸟带新鸟——基于EPlan2022的部件库制作(3D)

设备逻辑的概念: 可在布局空间 中和其它对象上放置对象。可将其它对象放置在 3D 对象上。已放置的对象分到组件的逻辑结构中。 将此属性的整体标识为设备逻辑。可使用不同的功能创建和编辑设备逻辑。 设备的逻辑定义 定义 / 旋转 / 移动 / 翻转:组…

小程序基础 —— 07 创建小程序项目

创建小程序项目 打开微信开发者工具,左侧选择小程序,点击 号即可新建项目: 在弹出的新页面,填写项目信息(后端服务选择不使用云服务,开发模式为小程序,模板选择为不使用模板)&…

Android Java 版本的 MSAA OpenGL ES 多重采样

最近多次被小伙伴问到 OpenGL 多重采样,其实前面文章里多次讲过了,就是构建2个缓冲区,多重采样缓冲区和目标解析缓冲区。 代码流程 // Framebuffer IDs private int msaaFBO; private int msaaColorBuffer; private int msaaDepthBuffer;pr…

Markdown语法字体字号讲解

学习目录 语法详解改变字体样式[电脑要自带该样式字体]改变局部字号全局字体字号的设置使用场景及应用实例 > 快来试试吧😃 👇 👇 👈点击该图片即可跳转至Markdown学习网站进行 Markdown语法字体字号讲解👈点击这里…

Spring boot处理跨域问题

Spring boot处理跨域问题 方案一方案二推荐解决方案注意 方案一 实现WebMvcConfigurer的addCorsMappings方法 Configuration public class InterceptorConfig implements WebMvcConfigurer {Overridepublic void addCorsMappings(CorsRegistry registry) {registry.addMappin…