Spring 及 Spring Boot 条件化注解(15个）完整列表及示例

Spring 及 Spring Boot 条件化注解完整列表及示例

1. 所有条件化注解列表

Spring 和 Spring Boot 提供了以下条件化注解（共 15 个），用于在配置类或方法上实现条件化注册 Bean 或配置：

注解名称作用来源框架
@Conditional自定义条件逻辑。Spring Core
@ConditionalOnClass类路径存在指定类时触发。Spring Core
@ConditionalOnMissingClass类路径不存在指定类时触发。Spring Core
@ConditionalOnBean指定 Bean 存在时触发。Spring Core
@ConditionalOnMissingBean指定 Bean 不存在时触发。Spring Core
@ConditionalOnExpressionSpEL 表达式为 true 时触发。Spring Core
@ConditionalOnJava当前 Java 版本满足条件时触发。Spring Core
@ConditionalOnProperty配置属性存在且符合指定值时触发。Spring Core
@ConditionalOnResource类路径存在指定资源文件时触发。Spring Boot
@ConditionalOnWebApplication当应用是 Web 应用时触发。Spring Boot
@ConditionalOnNotWebApplication当应用不是 Web 应用时触发。Spring Boot
@ConditionalOnSingleCandidate指定类型只有一个候选 Bean 或类型匹配时触发。Spring Boot
@ConditionalOnJndiJNDI 资源存在时触发。Spring Boot
@ConditionalOnMissingJndiJNDI 资源不存在时触发。Spring Boot
@ConditionalOnCloudPlatform当运行在指定云平台（如 AWS、Azure）时触发。Spring Cloud
2. 完整代码示例
(1) @Conditional（自定义条件）

作用：通过实现 Condition 接口自定义条件逻辑。

// 自定义条件类
public class CustomCondition implements Condition {@Overridepublic boolean matches(ConditionContext context, AnnotatedTypeMetadata metadata) {return context.getEnvironment().containsProperty("custom.key");}
}// 配置类
@Configuration
@Conditional(CustomCondition.class) // 自定义条件
public class CustomConditionConfig {@Beanpublic String customConditionBean() {return "Bean created by custom condition";}
}// 测试类
@SpringBootTest(properties = "custom.key=true")
class CustomConditionTest {@Autowired(required = false)private String customConditionBean;@Testvoid testWithCustomKey() {assertNotNull(customConditionBean);}
}
(2) @ConditionalOnClass

作用：类路径存在指定类时触发。

@Configuration
@ConditionalOnClass(DataSource.class) // 当存在 DataSource 类时触发
public class ClassConditionConfig {@Beanpublic String dataSourceBean() {return "DataSource exists";}
}
(3) @ConditionalOnMissingClass

作用：类路径不存在指定类时触发。

@Configuration
@ConditionalOnMissingClass("org.springframework.jdbc.datasource.DataSource") // 当无 DataSource 类时触发
public class MissingClassConditionConfig {@Beanpublic String noDataSourceBean() {return "DataSource does NOT exist";}
}
(4) @ConditionalOnBean

作用：指定 Bean 存在时触发。

@Configuration
@ConditionalOnBean(name = "dataSource") // 当存在 dataSource Bean 时触发
public class BeanConditionConfig {@Beanpublic String dataSourceDependentBean() {return "Bean created because dataSource exists";}
}
(5) @ConditionalOnMissingBean

作用：指定 Bean 不存在时触发。

@Configuration
public class MissingBeanConditionConfig {@Bean@ConditionalOnMissingBean(name = "myBean") // 当无 myBean 时触发public String missingBean() {return "Bean created because 'myBean' is missing";}
}
(6) @ConditionalOnExpression

作用：SpEL 表达式为 true 时触发。

@Configuration
@ConditionalOnExpression("${app.env} == 'prod'") // 当 env 为 prod 时触发
public class ExpressionConditionConfig {@Beanpublic String prodBean() {return "Bean for prod environment";}
}
(7) @ConditionalOnJava

作用：Java 版本满足条件时触发。

@Configuration
@ConditionalOnJava(baseline = JavaVersion.EIGHT, fallback = JavaVersion.TEN) // Java 8-10 时触发
public class JavaVersionConditionConfig {@Beanpublic String java8To10Bean() {return "Java 8-10 compatible";}
}
(8) @ConditionalOnProperty

作用：配置属性存在且符合指定值时触发。

@Configuration
@ConditionalOnProperty(name = "feature.enabled", havingValue = "true") // 当 feature.enabled 为 true 时触发
public class PropertyConditionConfig {@Beanpublic String enabledFeatureBean() {return "Feature enabled";}
}
(9) @ConditionalOnResource

作用：类路径存在指定资源文件时触发（Spring Boot）。

@Configuration
@ConditionalOnResource(resources = "classpath:config/application-prod.properties") // 当资源存在时触发
public class ResourceConditionConfig {@Beanpublic String prodResourceBean() {return "Resource exists";}
}
(10) @ConditionalOnWebApplication

作用：应用是 Web 应用时触发（Spring Boot）。

@Configuration
@ConditionalOnWebApplication // Web 应用时触发
public class WebConditionConfig {@Beanpublic String webBean() {return "Web application";}
}
(11) @ConditionalOnNotWebApplication

作用：应用不是 Web 应用时触发（Spring Boot）。

@Configuration
@ConditionalOnNotWebApplication // 非 Web 应用时触发
public class NonWebConditionConfig {@Beanpublic String nonWebBean() {return "Non-web application";}
}
(12) @ConditionalOnSingleCandidate

作用：指定类型只有一个候选 Bean 时触发（Spring Boot）。

@Configuration
@ConditionalOnSingleCandidate(DataSource.class) // 当唯一 DataSource 存在时触发
public class SingleCandidateConditionConfig {@Beanpublic String singleDataSourceBean() {return "Single DataSource candidate";}
}
(13) @ConditionalOnJndi

作用：JNDI 资源存在时触发（Spring Boot）。

@Configuration
@ConditionalOnJndi("java:comp/env/jdbc/MyDB") // 当 JNDI 资源存在时触发
public class JndiConditionConfig {@Beanpublic String jndiBean() {return "JNDI resource exists";}
}
(14) @ConditionalOnMissingJndi

作用：JNDI 资源不存在时触发（Spring Boot）。

@Configuration
@ConditionalOnMissingJndi("java:comp/env/jdbc/MyDB") // 当 JNDI 资源不存在时触发
public class MissingJndiConditionConfig {@Beanpublic String noJndiBean() {return "JNDI resource does NOT exist";}
}
(15) @ConditionalOnCloudPlatform

作用：运行在指定云平台时触发（Spring Cloud）。

@Configuration
@ConditionalOnCloudPlatform(Azure.class) // 当运行在 Azure 时触发
public class CloudConditionConfig {@Beanpublic String azureBean() {return "Bean for Azure environment";}
}
3. 条件注解对比表
注解触发条件典型场景参数示例来源框架
@Conditional自定义 Condition 接口实现的逻辑。灵活的自定义条件。@Conditional(CustomCondition.class)Spring Core
@ConditionalOnClass类路径存在指定类。检测依赖是否存在。@ConditionalOnClass(DataSource.class)Spring Core
@ConditionalOnMissingClass类路径不存在指定类。检测依赖缺失。@ConditionalOnMissingClass("DataSource")Spring Core
@ConditionalOnBean指定 Bean 存在。依赖其他 Bean 的存在。@ConditionalOnBean(name = "dataSource")Spring Core
@ConditionalOnMissingBean指定 Bean 不存在。避免重复注册 Bean。@ConditionalOnMissingBean(name = "myBean")Spring Core
@ConditionalOnExpressionSpEL 表达式为 true。复杂条件判断。@ConditionalOnExpression("${app.env} == 'prod'")Spring Core
@ConditionalOnJava当前 Java 版本满足条件。根据 Java 版本启用功能。@ConditionalOnJava(baseline = JavaVersion.EIGHT)Spring Core
@ConditionalOnProperty配置属性存在且符合指定值。根据配置启用功能。@ConditionalOnProperty(name = "feature.enabled", havingValue = "true")Spring Core
@ConditionalOnResource类路径存在指定资源文件。根据资源文件存在与否配置。@ConditionalOnResource("classpath:config/prod.properties")Spring Boot
@ConditionalOnWebApplication应用是 Web 应用。Web 相关配置。@ConditionalOnWebApplicationSpring Boot
@ConditionalOnNotWebApplication应用不是 Web 应用。非 Web 应用配置。@ConditionalOnNotWebApplicationSpring Boot
@ConditionalOnSingleCandidate指定类型只有一个候选 Bean 或类型匹配。确保唯一 Bean。@ConditionalOnSingleCandidate(DataSource.class)Spring Boot
@ConditionalOnJndiJNDI 资源存在。根据 JNDI 资源触发配置。@ConditionalOnJndi("java:comp/env/jdbc/MyDB")Spring Boot
@ConditionalOnMissingJndiJNDI 资源不存在。根据 JNDI 缺失触发配置。@ConditionalOnMissingJndi("java:comp/env/jdbc/MyDB")Spring Boot
@ConditionalOnCloudPlatform运行在指定云平台（如 AWS、Azure）。云平台相关配置。@ConditionalOnCloudPlatform(Azure.class)Spring Cloud
4. 总结

Spring 及 Spring Boot 的条件化注解通过 条件判断 实现配置的动态加载，核心是 Condition 接口和其衍生注解。关键点如下：

  • 依赖检测：@ConditionalOnClass、@ConditionalOnMissingClass、@ConditionalOnJndi。
  • Bean 状态：@ConditionalOnBean、@ConditionalOnMissingBean、@ConditionalOnSingleCandidate。
  • 属性/环境：@ConditionalOnProperty、@ConditionalOnExpression、@ConditionalOnJava。
  • 应用类型：@ConditionalOnWebApplication、@ConditionalOnNotWebApplication。
  • 云平台：@ConditionalOnCloudPlatform（Spring Cloud）。
  • 自定义条件：通过 @Conditional 实现灵活扩展。

这些注解帮助开发者根据运行时环境、依赖、配置等条件动态注册 Bean，减少硬编码，提升代码的灵活性和可维护性。例如：

  • Spring Boot 的 @ConditionalOnResource 可用于根据配置文件是否存在来启用功能。
  • @ConditionalOnCloudPlatform 可在不同云平台（如 AWS、Azure）间切换配置。
  • @ConditionalOnJndi 适用于需要 JNDI 资源的环境（如企业级应用服务器）。

根据具体需求选择合适的注解，可显著简化配置逻辑并增强代码的适应性。

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

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

相关文章

【Kafka】深入探讨 Kafka 如何保证一致性

【Kafka】深入探讨 Kafka 如何保证一致性

文章目录 Kafka 基本概念回顾​副本角色​ 数据写入一致性​同步副本（ISR）集合​数据读取一致性​故障处理与一致性恢复​总结​ 在分布式系统领域，数据一致性是至关重要的一环。作为一款高性能的分布式消息队列系统，Kafka 在设计…
阅读更多...
从入门到精通：SQL注入防御与攻防实战——红队如何突破，蓝队如何应对！

从入门到精通：SQL注入防御与攻防实战——红队如何突破，蓝队如何应对！

引言：为什么SQL注入攻击依然如此强大？ SQL注入（SQL Injection）是最古老且最常见的Web应用漏洞之一。尽管很多公司和组织都已经采取了WAF、防火墙、数据库隔离等防护措施，但SQL注入依然在许多情况下能够突破防线&#…
阅读更多...
【算法day27】有效的数独——请你判断一个 9 x 9 的数独是否有效。只需要 根据以下规则 ，验证已经填入的数字是否有效即可。

【算法day27】有效的数独——请你判断一个 9 x 9 的数独是否有效。只需要 根据以下规则 ，验证已经填入的数字是否有效即可。

36. 有效的数独 请你判断一个 9 x 9 的数独是否有效。只需要 根据以下规则 ，验证已经填入的数字是否有效即可。 数字 1-9 在每一行只能出现一次。 数字 1-9 在每一列只能出现一次。 数字 1-9 在每一个以粗实线分隔的 3x3 宫内只能出现一次。（请参考示例…
阅读更多...
leetcode 2360. 图中的最长环 困难

leetcode 2360. 图中的最长环 困难

给你一个 n 个节点的 有向图 ，节点编号为 0 到 n - 1 ，其中每个节点 至多 有一条出边。 图用一个大小为 n 下标从 0 开始的数组 edges 表示，节点 i 到节点 edges[i] 之间有一条有向边。如果节点 i 没有出边，那么 edges[i] -1 。…
阅读更多...
PySpur: AI 智能体可视化开发平台

PySpur: AI 智能体可视化开发平台

GitHub：https://github.com/PySpur-Dev/pyspur 更多AI开源软件：发现分享好用的AI工具、AI开源软件、AI模型、AI变现 - 小众AI PySpur是一个开源的轻量级可视化AI智能体工作流构建器，旨在简化AI系统的开发流程。通过拖拽式界面，用户…
阅读更多...
vcpkg安装及使用教程，以安装matio库解析mat文件为例

vcpkg安装及使用教程，以安装matio库解析mat文件为例

vcpkg安装及使用教程，以安装matio库解析mat文件为例 1. vcpkg安装2 安装matio三方库3 将三方库集成到VS中3.1 全局集成3.2 集成到特定工程4 结语Vcpkg 是微软开发的一款开源的 C/C++ 包管理工具，旨在简化 C/C++ 项目依赖库的安装和管理。它支持跨平台（Windows、Linux、macO…
阅读更多...
LLM架构解析：NLP基础（第一部分）—— 模型、核心技术与发展历程全解析

LLM架构解析：NLP基础（第一部分）—— 模型、核心技术与发展历程全解析

本专栏深入探究从循环神经网络（RNN）到Transformer等自然语言处理（NLP）模型的架构，以及基于这些模型构建的应用程序。 本系列文章内容： NLP自然语言处理基础（本文）词嵌入&#xff0…
阅读更多...
【Rtklib入门指南】2. 使用RTKLIB GUI进行观测数据分析

【Rtklib入门指南】2. 使用RTKLIB GUI进行观测数据分析

数据准备 下载2025年1月1日的香港CORS站数据和观测星历，详情参照如下博客： 使用GAMP_GOOD进行hk数据下载教程-CSDN博客 分析工具 RTKLIB 2.4.3 demo5（也可以选用RTKLIB2.4.2，但不建议使用RTKLIB2.4.3） 分析流程 …
阅读更多...
suse15 sp1使用华为云软件源yum源zypper源

suse15 sp1使用华为云软件源yum源zypper源

登录suse15终端， cd /etc/zypp/repos.d/进入目录后执行以下命令： zypper ar -fcg https://mirrors.huaweicloud.com/opensuse/distribution/leap/15.1/repo/oss HuaWeiCloud:15.1:OSS zypper ar -fcg https://mirrors.huaweicloud.com/opensuse/distribu…
阅读更多...
首屏加载时间优化解决

首屏加载时间优化解决

🤖 作者简介：水煮白菜王（juejin/csdn同名） ，一位前端劝退师 👻 👀 文章专栏： 高德AMap专栏 ，记录一下平时学习在博客写作中记录，总结出的一些开发技巧✍。 感…
阅读更多...
Sentinel[超详细讲解]-1

Sentinel[超详细讲解]-1

定义一系列 规则 &#x1f47a;&#xff0c;对资源进行 保护 &#x1f47a;&#xff0c; 如果违反的了规则&#xff0c;则抛出异常&#xff0c;看是否有fallback兜底处理&#xff0c;如果没有则直接返回异常信息&#x1f60e; 1. 快速入门 1.1 引入 Sentinel 依赖 <depend…
阅读更多...
02-Docker 使用

02-Docker 使用

docker：快速构建、运行、管理应用的工具，可以帮助我们下载应用镜像，创建并运行镜像的容器，从而快速部署应用 1、部署mysql 先停掉虚拟机中的MySQL，确保你的虚拟机已经安装Docker，且网络开通的情况下，执行下面命令即可安装MySQL（注意：若服务器上已经有mysql 占用了330…
阅读更多...
@DeclareParents 注解实现接口功能增强：Spring中通过接口引入实现功能增强的完整示例

@DeclareParents 注解实现接口功能增强：Spring中通过接口引入实现功能增强的完整示例

以下是Spring中通过接口引入实现功能增强的完整示例&#xff1a; // 1. 目标接口及实现类 package com.example;public interface Service {void doSomething(); }Component class ServiceImp implements Service {Overridepublic void doSomething() {System.out.println(&qu…
阅读更多...
HTML中数字和字母不换行显示

HTML中数字和字母不换行显示

HTML中数字和字母不换行显示的默认行为及如何通过CSS的word-wrap和word-break属性进行调整。 在HTML中标签中的数字和字母默认是不换行的&#xff0c;如果要将他们换行&#xff0c;在CSS中添加”word-wrap: break-word;” 即可解决 语法&#xff1a;word-wrap: normal|break-w…
阅读更多...
Git团队开发命令总结

Git团队开发命令总结

简易Git工作流 myname: 团队成员个人分支dev: 团队公共分支 个人独立分支开发 同步最新的【dev公共分支】到本地。【重要】基于最新的【dev公共分支】&#xff0c;创建【个人功能开发分支】。在此基础上开发。【个人功能开发分支】开发完成&#xff0c;推送到远程库。如果【…
阅读更多...
Python人工智能大模型入门教程：从零构建高性能预测模型

Python人工智能大模型入门教程：从零构建高性能预测模型

引言&#xff1a;AI大模型时代的技术革命 在AlphaGo战胜人类棋手的里程碑事件后&#xff0c;人工智能技术进入爆发式发展阶段。本教程将带您从零开始&#xff0c;使用Python构建一个工业级神经网络模型。通过本教程&#xff0c;您不仅能掌握GPU加速训练、混合精度计算等前沿技…
阅读更多...
python-leetcode 61.N皇后

python-leetcode 61.N皇后

题目&#xff1a; 按照国际象棋的规则&#xff0c;皇后可以攻击与之处在同一行或同一列或同一斜线上的棋子。 n 皇后问题 研究的是如何将 n 个皇后放置在 nn 的棋盘上&#xff0c;并且使皇后彼此之间不能相互攻击 给你一个整数 n &#xff0c;返回所有不同的 n 皇后问题 的解…
阅读更多...
Mybatis_Plus中的常用注解

Mybatis_Plus中的常用注解

目录 1、TableName TableId TableId的type属性 TableField 1、TableName 经过以上的测试&#xff0c;在使用MyBatis-Plus实现基本的CRUD时&#xff0c;我们并没有指定要操作的表&#xff0c;只是在 Mapper接口继承BaseMapper时&#xff0c;设置了泛型User&#xff0c;而操…
阅读更多...
JavaScript函数知识点总结

JavaScript函数知识点总结

JavaScript函数是一种可重复使用的代码块，它接受输入值（参数）、执行特定任务，并返回输出值。 1. 声明函数 function greet(name) {return "Hello, " + name + "!"; }console.log(greet("Alice")); // 输出: Hello, Alice! console.log( t…
阅读更多...
分布式计算Ray框架面试题及参考答案

分布式计算Ray框架面试题及参考答案

目录 简述 Ray 的架构设计核心组件及其协作流程 全局控制存储（GCS）在 Ray 中的作用是什么？如何实现高可用性？ 对比 Ray 的任务（Task）与 Actor 模型，说明各自适用场景 解释 Ray 的 Object Store 如何实现跨节点数据共享与零拷贝传输 Ray 的分布式调度器如何实现毫秒级…
阅读更多...
最新文章

Copyright @ 2022~2023