Spring Boot 进阶-详解SpringBoot中条件注解使用
gudong366 2025-03-10 13:24 14 浏览
作为使用Spring Boot框架的开发者来讲,如果你连如下的这些注解你都没有听说过,没有用过,那我劝你还是放弃吧?
在Spring Boot中我们最常见到的注解应该是条件注解了吧!也就是@ConditionalXXX的注解。例如在我们自动配置类上经常会看到@ConditionalOnMissingBean,表示在容器中不存在这样一个Bean注入的时候才会生效。
在Spring Boot的框架中使用了大量的这样的条件注解来实现根据不同的应用场景加载不同的配置项的逻辑,那么接下来我们就来看看在Spring Boot中都有那些值得我们学习和了解的注解呢?
@Conditional
@Conditional注解是从Spring 4.0版本之后出现的注解,可以标注在任何的类型或者方法上面,通过这个注解来实现一些条件的判断,当满足了对应的条件之后标注了该注解的类或者方法才会被注入到容器中。
在Spring 或者是SpringBoot中@Conditional注解被大量的使用,例如在控制某个JavaBean对象是否要被注入到容器中的时候,需要采用不同的条件判断来实现。例如前面提到的@ConditionalOnMissingBean、@ConditionalOnBean等等。
而@Conditional源码相对来说比较简单,如下所示。
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface Conditional {
/**
* All {@link Condition} classes that must {@linkplain Condition#matches match}
* in order for the component to be registered.
*/
Class extends Condition>[] value();
}
在注解中有一个属性value,可以是一个也可以是多个,而对于这个注解的判断则是由Condition接口实现来进行判断,代码如下
@FunctionalInterface
public interface Condition {
boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata);
}
Condition接口
在@Conditional注解判断中,条件是否城里取决于在value中指定的类对象是否是Condition接口的实现,在Condition接口中有一个matches()的方法,如果这个方法返回值为ture的时候则表示判断的条件城里,否则就表示判断条件不成立,也就不能往容器中进行注入操作。其中matches()方法有两个参数分别表示如下的含义
- ConditionContext :表示要判断条件成立对应的上下文环境是什么,也就是说判断条件成立的时候需要从上下文环境中获取对应的判断条件。
- AnnotatedTypeMetadata:表示被标记了@Conditional注解的对象的所有元数据信息。用来判断是否满足注入到容器中的条件。
这其中AnnotatedTypeMetadata没有什么好说的,就是对象标注的信息,而ConditionContext则是条件判断的关键内容。下面我们就来详细分析一下。
ConditionContext接口
在上面我们提到了在Condition接口中matches()方法有两个参数一个其中一个参数就是ConditionContext。这个接口表示可以从Spring 的上下文中获取到信息。其源码如下
public interface ConditionContext {
/**
* Return the {@link BeanDefinitionRegistry} that will hold the bean definition
* should the condition match.
* @throws IllegalStateException if no registry is available (which is unusual:
* only the case with a plain {@link ClassPathScanningCandidateComponentProvider})
*/
BeanDefinitionRegistry getRegistry();
/**
* Return the {@link ConfigurableListableBeanFactory} that will hold the bean
* definition should the condition match, or {@code null} if the bean factory is
* not available (or not downcastable to {@code ConfigurableListableBeanFactory}).
*/
@Nullable
ConfigurableListableBeanFactory getBeanFactory();
/**
* Return the {@link Environment} for which the current application is running.
*/
Environment getEnvironment();
/**
* Return the {@link ResourceLoader} currently being used.
*/
ResourceLoader getResourceLoader();
/**
* Return the {@link ClassLoader} that should be used to load additional classes
* (only {@code null} if even the system ClassLoader isn't accessible).
* @see org.springframework.util.ClassUtils#forName(String, ClassLoader)
*/
@Nullable
ClassLoader getClassLoader();
}
会看到这个接口会获取到BeanDefinitionRegistry返回的Bean的定义注册器,可以通过这个注册器获取到Bean对象定义的各种信息;
ConfigurableListableBeanFactory返回的工厂类型,这个工厂就是IOC容器;Environment返回的Spring容器对象的环境配置相关信息;ResourceLoader 返回Spring容器资源加载器;ClassLoader返回容器的类加载器信息。
从这里可以看到ConditionContext对象几乎可以获取到容器相关的所有上下文信息,也是因为有了这些信息,所以条件注入才会那么得心应手。既然这样,我们为何不尝试自定义一个条件注入呢?
如何自定义注入的Condition呢?
有这样一个比较经典的例子,就是需要我们的应用程序根据运行环境的不同来载入不同的JavaBean配置,以便适应不同的运行环境。这里我们就拿Windows运行环境和Mac运行环境来做测试,这里先不考虑其他的运行环境。
第一步定义一个Mac Linux环境的条件类
public class LinuxCondition implements Condition {
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
// 首先需要获取到当前运行环境信息
Environment environment = context.getEnvironment();
String property = environment.getProperty("os.name");
if (property.contains("Mac")){
return true;
}
return false;
}
}
定一个Windows的条件类
public class WindowsCondition implements Condition {
@Override
public boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {
// 首先需要获取到当前运行环境信息
Environment environment = context.getEnvironment();
String property = environment.getProperty("os.name");
if (property.contains("Windows")){
return true;
}
return false;
}
}
配合一个测试的配置类,将两个环境中的数据都注入到容器中,看最终加载哪一个
@Configuration
public class SystemConfig {
@Bean("windows")
@Conditional(value = WindowsCondition.class)
public OSDesc windowsosDesc(){
OSDesc osDesc = new OSDesc();
osDesc.setOs("Windows");
osDesc.setCpu("4C");
osDesc.setMemory("8G");
return osDesc;
}
@Bean("linux")
@Conditional(value = LinuxCondition.class)
public OSDesc linuxosDesc(){
OSDesc osDesc = new OSDesc();
osDesc.setOs("Linux");
osDesc.setCpu("4C");
osDesc.setMemory("16G");
return osDesc;
}
}
还是采用接口触发的方式进行测试,这样更能模拟真实的环境,代码如下
@RestController
public class HelloWorldController {
@Autowired(required = false)
@Qualifier(value = "windows")
private OSDesc windows;
@Autowired(required = false)
@Qualifier(value = "linux")
private OSDesc linux;
@GetMapping("/hello")
public String hello() {
System.out.println(linux.getOs());
System.out.println(windows.getOs());
return "OK";
}
}
调用之后,会发现如果在Mac环境下,输出的结果是Linux,如果是在Windows的环境下,输出的结果是Windows。
总结
这篇文章我们主要讲解了关于条件注解相关的内容,在下篇文章中我们来深入了解一下这个条件注解到底是在什么时候被加载,采用什么样的顺序进行加载,还有哪些我们日常开发中的注解需要我们去了解。
相关推荐
- U盘文件被删怎么简单恢复(u盘里的文件被误删了怎么找回)
-
现在这个社会不是靠关系靠路子,主要还是靠实力。刘强在机关工作,人长得帅气,工作能力又强。唯独一样不好,脾气太大,动不动就发火,因为小事常和同事发生口角。一次他火大的差点把办公桌给掀翻了,领导见他野蛮的...
- 不小心删除了一些文件?9 个最佳免费硬盘恢复软件
-
恢复您曾经无意或意外删除的所有文件和数据。您是否曾经错误地删除了一个对您的工作至关重要并导致您丢失所有进度的文件?我们为您提供了一些最好的免费硬盘恢复软件,以帮助您恢复意外删除的文件,以解决您的文件删...
- Studio 中文版:数据救援神器,误删 / 分区损坏 / RAID 恢复一键找回
-
Studio中文版:数据救援神器,误删/分区损坏/RAID恢复一键找回当文件意外删除、分区损坏,或RAID阵列崩溃时,一款可靠的数据恢复工具往往能挽回关键损失。R-Studio中文版...
- 你值得拥有的11款Linux数据恢复工具
-
如果你使用的是Linux操作系统,那么你一定想知道一旦硬盘崩溃的话又该如何保存和恢复数据。其实,现在有很多Linux数据恢复工具可以让我们摆脱数据安全的困扰。小编已经为各位准备好了一些最好的Linux...
- 误删文件内容怎么恢复(误删文件内容怎么恢复回来)
-
在日常使用电脑的过程中,误删文件的情况时有发生。无论是由于操作失误还是病毒攻击,误删文件都会给我们带来不小的困扰。幸运的是,随着技术的发展,误删文件恢复已不再是难题。本文将介绍几款国内外知名的误删...
- u盘如何恢复删除的文件?推荐5款u盘数据恢复软件!
-
在日常生活与工作中,U盘作为便捷的数据存储载体,频繁用于传输和保存各类重要文件。然而,误删文件的情况却时有发生,无论是珍贵的照片、重要的工作文档,还是精心制作的视频,一旦删除,都可能带来不小的麻烦。...
- 怎么恢复删除的数据?5种有效的数据恢复方法汇总!
-
在数字化办公与生活的时代,电脑里的每一份数据都承载着重要信息。然而,一个误操作就可能导致数据被删除,无论是尚未保存的重要文档,还是珍藏多年的照片,都可能瞬间“消失”。但其实,数据删除并不意味着永久丢...
- u盘删除文件怎么找回?5个数据恢复工具汇总,助你巧妙恢复数据!
-
在日常使用U盘的过程中,误删文件的情况时有发生,重要的工作文档、珍贵的照片视频一旦消失,难免让人焦急万分。别担心,只要选对数据恢复工具,被删除的数据仍有找回的可能。下面就为你汇总5款实用的数据...
- Linux下恢复误删文件:思路+实践(linux删除如何恢复)
-
周五篮球群里有人问误删文件了怎么恢复,得知是ext4文件系统之后我推荐了ext4magic这个工具,然后又有人提到了xfs的话怎么办,正好前几天看到DaveChinner在邮件列表里提到了这个问题,...
- 苹果放大招!不用虚拟机了,Mac直接跑Linux容器,开发者效率翻倍
-
苹果这次真给开发者送福利了!今天凌晨(6月10日),苹果在官宣的Containerization框架直接炸了技术圈——Mac现在能原生运行Linux容器镜像了!这可不是虚拟机那种“套娃”方案,而是基...
- 7 款老牌经典软件,值得收藏(经典老歌软件)
-
Calibrehttps://calibre-ebook.com/Calibre是一个电脑电子书管理软件。肯定有人说了,电子书还要管理?那当然了。它的功能更强大的让你想象不到,首先它可以导入PDF,...
- 神仙级的免费开源电子书阅读器,还支持听书功能
-
神仙级的免费开源电子书阅读器,还支持听书功能,极空间部署『KoodoReader』哈喽小伙伴们好,我是Stark-C~前段时间不是给大家分享的电子书管理工具『TaleBook』嘛~,然后就有粉丝私信...
- 如何在Ubuntu系统中重置root密码(ubuntu忘记密码重置root密码命令)
-
很多人有个问题,就是喜欢把密码设置得很长很复杂,结果谁也没防住,却成功防住了自己ヽ(.ˇдˇ;)ノ对于现代人,特别是年轻人,都有过忘记密码的经历吧。在这篇文章中,我们来了解如何在Ubuntu1...
- 5款功能强大的PDF阅读器,让PDF阅读更轻松
-
分享5款功能强大的PDF阅读器,拥有丰富的PDF阅读工具,支持PDF文档划线、笔记、标记等操作,让PDF阅读更轻松!1.嗨动PDF编辑器一款实用的PDF处理软件,不仅可以阅读PDF文档,还能直接编辑、...
- 上班摸鱼利器! 免费好用的电子书阅读器,NAS轻松部署Koodo Reader
-
哈喽,大家好我是生活爱好者。笔者也是一名小说爱好者,平时用手机用某信读书,会员也开了,在家看体验也不错,但是上班的时候,在工作快速完成之后,想摸个鱼用手机就不太方便啦,作为爱折腾的人,必须要工作认真,...
- 一周热门
- 最近发表
- 标签列表
-
- linux一键安装 (31)
- linux运行java (33)
- ln linux (27)
- linux 磁盘管理 (31)
- linux 内核升级 (30)
- linux 运行python (28)
- linux 备份文件 (30)
- linux 网络测试 (30)
- linux 网关配置 (31)
- linux jre (32)
- linux 杀毒软件 (32)
- linux语法 (33)
- linux博客 (33)
- linux 压缩目录 (37)
- linux 查看任务 (32)
- 制作linux启动u盘 (35)
- linux 查看存储 (29)
- linux乌班图 (31)
- linux挂载镜像 (31)
- linux 软件源 (28)
- linux题目 (30)
- linux 定时脚本 (30)
- linux 网站搭建 (28)
- linux 远程控制 (34)
- linux bind (31)