Java 中 Spring Boot 怎么使用 @ConditionalOnClass 和 @ConditionalOnMissingBean 实现防御性组件配置

夜杰酱_2732

夜杰酱_2732

2026-07-26

543人浏览

原创

@conditionalonclass 和 @conditionalonmissingbean 是 spring boot 防御性自动配置的核心注解:前者确保类存在才加载配置,后者仅在 bean 缺失时注册,二者常组合使用并配合 @conditionalonproperty 提升鲁棒性。

java 中 spring boot 怎么使用 @conditionalonclass 和 @conditionalonmissingbean 实现防御性组件配置

Spring Boot 中的 @ConditionalOnClass 和 @ConditionalOnMissingBean 是实现防御性组件配置的核心注解,它们分别从“依赖存在性”和“Bean 冗余风险”两个维度保护自动配置不被破坏——前者避免因类缺失导致启动失败,后者防止用户自定义 Bean 与框架默认 Bean 冲突引发异常。

用 @ConditionalOnClass 控制配置加载边界

这个注解确保只有当指定类出现在 classpath 时,相关配置才生效。它不是用来“兜底”,而是主动规避无依赖环境下的无效初始化。

  • 典型场景:项目未引入 spring-webmvc,但你的自动配置类里写了 @Bean public WebMvcConfigurer xxx() {...} —— 若不加 @ConditionalOnClass(WebMvcConfigurer.class),应用直接启动失败
  • 推荐写法:在 @Configuration 类上标注,覆盖整个类中所有 @Bean 方法
    (避免单个方法加注解后其他方法仍执行,造成资源浪费或副作用)
  • 注意:value 属性支持真实类型引用(即使该类当前不在 classpath,ASM 解析也允许),name 属性则用于字符串类名(比如组合注解中必须用 name)

用 @ConditionalOnMissingBean 防止 Bean 注册冲突

它不是“选一个”,而是“只在没人提供时我才出手”。这是 Spring Boot 自动配置可安全复用的关键机制。

Java Maven Common
Java Maven Common

Java Maven 项目审查工作流的通用输入处理。当 Java Maven 项目以 ZIP压缩包或 GitLab 仓库 URL 形式提供且需要...时使用。

下载
  • 核心逻辑:检查容器中是否已存在指定类型(或名称)的 Bean;若不存在,才注册当前 @Bean 方法返回的实例
  • 常见误用:把 @ConditionalOnMissingBean 加在用户自定义配置类上 —— 此时它无法保证执行顺序,可能因用户 Bean 尚未注册而误判为“缺失”
  • 正确姿势:仅用于自动配置类(@AutoConfigureBefore/@AutoConfigureAfter 等配合使用),因为 Spring Boot 保证自动配置类在所有用户配置之后处理
  • 示例:
    @Bean
    @ConditionalOnMissingBean(DataSource.class)
    public DataSource hikariDataSource() { ... }
    用户若已声明自己的 DataSource,此默认数据源就不会注册,完全静默

组合使用提升配置鲁棒性

单一条件往往不够,真实场景需要叠加判断。例如一个缓存客户端自动配置:

  • 先确认 Redis 相关类存在:@ConditionalOnClass(RedisTemplate.class)
  • 再确认用户没自己提供 RedisTemplate:@ConditionalOnMissingBean(RedisTemplate.class)
  • 最后检查配置开关开启:@ConditionalOnProperty(name = "spring.redis.enabled", havingValue = "true")
  • 三者同时满足,才注入默认 RedisTemplate 实例 —— 任一条件不成立,都不执行,不报错、不干扰

避坑要点

这两个注解看似简单,但实际踩坑多集中在执行时机和作用范围上:

  • @ConditionalOnMissingBean 对 @Configuration 类整体生效时,会跳过整个类注册;对单个 @Bean 方法生效时,只跳过该方法 —— 根据设计意图选择粒度
  • 不要在同一个类里混用 @ConditionalOnBean 和 @ConditionalOnMissingBean 判断同一类型,容易因注册顺序导致不可预测行为
  • 若需根据多个类共同存在来启用配置,@ConditionalOnClass 支持传入数组:@ConditionalOnClass({A.class, B.class})
  • 调试技巧:启动时加 --debug 参数,Spring Boot 会输出所有被跳过的自动配置及原因,快速定位条件未满足的具体环节

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

2023.06.15

10637

6

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

2023.07.05

7762

9

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

2023.07.31

6772

8

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.01

1144

3

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.08.02

948

3

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

1396

5

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.02

2809

5

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

2023.08.03

20111

3

配置java环境变量
配置java环境变量

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1235

8

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习