Spring Boot 进阶-详解SpringBoot中条件注解使用
liuian 2025-06-15 17:36 61 浏览
作为使用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。
总结
这篇文章我们主要讲解了关于条件注解相关的内容,在下篇文章中我们来深入了解一下这个条件注解到底是在什么时候被加载,采用什么样的顺序进行加载,还有哪些我们日常开发中的注解需要我们去了解。
相关推荐
-
- 驱动网卡(怎么从新驱动网卡)
-
网卡一般是指为电脑主机提供有线无线网络功能的适配器。而网卡驱动指的就是电脑连接识别这些网卡型号的桥梁。网卡只有打上了网卡驱动才能正常使用。并不是说所有的网卡一插到电脑上面就能进行数据传输了,他都需要里面芯片组的驱动文件才能支持他进行数据传输...
-
2026-01-30 00:37 liuian
- win10更新助手装系统(微软win10更新助手)
-
1、点击首页“系统升级”的按钮,给出弹框,告诉用户需要上传IMEI码才能使用升级服务。同时给出同意和取消按钮。华为手机助手2、点击同意,则进入到“系统升级”功能华为手机助手华为手机助手3、在检测界面,...
- windows11专业版密钥最新(windows11专业版激活码永久)
-
Windows11专业版的正版密钥,我们是对windows的激活所必备的工具。该密钥我们可以通过微软商城或者通过计算机的硬件供应商去购买获得。获得了windows11专业版的正版密钥后,我...
-
- 手机删过的软件恢复(手机删除过的软件怎么恢复)
-
操作步骤:1、首先,我们需要先打开手机。然后在许多图标中找到带有[文件管理]文本的图标,然后单击“文件管理”进入页面。2、进入页面后,我们将在顶部看到一行文本:手机,最新信息,文档,视频,图片,音乐,收藏,最后是我们正在寻找的[更多],单击...
-
2026-01-29 23:55 liuian
- 一键ghost手动备份系统步骤(一键ghost 备份)
-
步骤1、首先把装有一键GHOST装系统的U盘插在电脑上,然后打开电脑马上按F2或DEL键入BIOS界面,然后就选择BOOT打USDHDD模式选择好,然后按F10键保存,电脑就会马上重启。 步骤...
- 怎么创建局域网(怎么创建局域网打游戏)
-
1、购买路由器一台。进入路由器把dhcp功能打开 2、购买一台交换机。从路由器lan端口拉出一条网线查到交换机的任意一个端口上。 3、两台以上电脑。从交换机任意端口拉出网线插到电脑上(电脑设置...
- 精灵驱动器官方下载(精灵驱动手机版下载)
-
是的。驱动精灵是一款集驱动管理和硬件检测于一体的、专业级的驱动管理和维护工具。驱动精灵为用户提供驱动备份、恢复、安装、删除、在线更新等实用功能。1、全新驱动精灵2012引擎,大幅提升硬件和驱动辨识能力...
- 一键还原系统步骤(一键还原系统有哪些)
-
1、首先需要下载安装一下Windows一键还原程序,在安装程序窗口中,点击“下一步”,弹出“用户许可协议”窗口,选择“我同意该许可协议的条款”,并点击“下一步”。 2、在弹出的“准备安装”窗口中,可...
- 电脑加速器哪个好(电脑加速器哪款好)
-
我认为pp加速器最好用,飞速土豆太懒,急速酷六根本不工作。pp加速器什么网页都加速,太任劳任怨了!以上是个人观点,具体性能请自己试。ps:我家电脑性能很好。迅游加速盒子是可以加速电脑的。因为有过之...
- 任何u盘都可以做启动盘吗(u盘必须做成启动盘才能装系统吗)
-
是的,需要注意,U盘的大小要在4G以上,最好是8G以上,因为启动盘里面需要装系统,内存小的话,不能用来安装系统。内存卡或者U盘或者移动硬盘都可以用来做启动盘安装系统。普通的U盘就可以,不过最好U盘...
- u盘怎么恢复文件(u盘文件恢复的方法)
-
开360安全卫士,点击上面的“功能大全”。点击文件恢复然后点击“数据”下的“文件恢复”功能。选择驱动接着选择需要恢复的驱动,选择接入的U盘。点击开始扫描选好就点击中间的“开始扫描”,开始扫描U盘数据。...
- 系统虚拟内存太低怎么办(系统虚拟内存占用过高什么原因)
-
1.检查系统虚拟内存使用情况,如果发现有大量的空闲内存,可以尝试释放一些不必要的进程,以释放内存空间。2.如果系统虚拟内存使用率较高,可以尝试增加系统虚拟内存的大小,以便更多的应用程序可以使用更多...
-
- 剪贴板权限设置方法(剪贴板访问权限)
-
1、首先打开iphone手机,触碰并按住单词或图像直到显示选择选项。2、其次,然后选取“拷贝”或“剪贴板”。3、勾选需要的“权限”,最后选择开启,即可完成苹果剪贴板权限设置。仅参考1.打开苹果手机设置按钮,点击【通用】。2.点击【键盘】,再...
-
2026-01-29 21:37 liuian
- 平板系统重装大师(平板重装win系统)
-
如果你的平板开不了机,但可以连接上电脑,那就能好办,楼主下载安装个平板刷机王到你的个人电脑上,然后连接你的平板,平板刷机王会自动识别你的平板,平板刷机王上有你平板的我刷机包,楼主点击下载一个,下载完成...
- 联想官网售后服务网点(联想官网售后服务热线)
-
联想3c服务中心是联想旗下的官方售后,是基于互联网O2O模式开发的全新服务平台。可以为终端用户提供多品牌手机、电脑以及其他3C类产品的维修、保养和保险服务。根据客户需求层次,联想服务针对个人及家庭客户...
- 一周热门
-
-
用什么工具在Win中查看8G大的log文件?
-
如何在 Windows 10 或 11 上通过命令行安装 Node.js 和 NPM
-
Trae IDE 如何与 GitHub 无缝对接?
-
如何修改图片拍摄日期?快速修改图片拍摄日期的6种方法
-
5步搞定动态考勤表!标记节假日、调休日?Excel自动变色!
-
RK3588-HDMIRX(瑞芯微rk3588芯片手册)
-
用纯Python轻松构建Web UI:Remi 动态更新,实时刷新界面内容
-
tplink无线路由器桥接教程(tplink路由器如何进行无线桥接)
-
R语言 | CNS绘图第1款——linkET万物皆可连
-
都说Feign是RPC,没有侵入性,为什么我的代码越来越像 C++
-
- 最近发表
- 标签列表
-
- python判断字典是否为空 (50)
- crontab每周一执行 (48)
- aes和des区别 (43)
- bash脚本和shell脚本的区别 (35)
- canvas库 (33)
- dataframe筛选满足条件的行 (35)
- gitlab日志 (33)
- lua xpcall (36)
- blob转json (33)
- python判断是否在列表中 (34)
- python html转pdf (36)
- 安装指定版本npm (37)
- idea搜索jar包内容 (33)
- css鼠标悬停出现隐藏的文字 (34)
- linux nacos启动命令 (33)
- gitlab 日志 (36)
- adb pull (37)
- python判断元素在不在列表里 (34)
- python 字典删除元素 (34)
- vscode切换git分支 (35)
- python bytes转16进制 (35)
- grep前后几行 (34)
- hashmap转list (35)
- c++ 字符串查找 (35)
- mysql刷新权限 (34)
