讲师中心 微信公众号
AI工具推荐 视频效率加速

Java中 类上的 @ConditionalOnClass 注解怎么根据类路径依赖动态装配 Bean

胖明吖_3265

胖明吖_3265

发布时间:2026-07-20 12:59:21

|

254人浏览过

|

来源于php中文网

原创

@ConditionalOnClass 是 Spring Boot 启动时检查类路径是否存在指定类以决定是否装配 Bean 的静态条件注解,支持 Class 类型和字符串两种写法,常用于自动配置按需加载。

java中 类上的 @conditionalonclass 注解怎么根据类路径依赖动态装配 bean

@ConditionalOnClass 是 Spring Boot 提供的条件注解,用于在类路径中存在指定类时才装配某个 Bean。它不是“根据依赖动态装配”,而是在应用启动时检查类路径是否包含目标类,从而决定是否创建对应 Bean —— 这个判断发生在 Spring 容器初始化阶段,属于静态条件评估,而非运行时动态切换。

作用时机:启动期类路径扫描

Spring Boot 启动时,会扫描所有 @Configuration 类和自动配置类(如 spring.factories 中声明的)。当遇到标注了 @ConditionalOnClass 的配置类或方法时,Spring 会:

  • 尝试加载注解中指定的类(例如 RedisTemplate.class 或字符串形式 "redis.clients.jedis.Jedis")
  • 若类能成功加载(即该类存在于 classpath 中),则满足条件,继续执行装配逻辑
  • 若类不存在(NoClassDefFoundError 或 ClassNotFoundException),则跳过该 Bean 创建

常用写法与注意事项

支持两种指定方式,推荐使用 Class 类型(编译期校验更安全):

  • @ConditionalOnClass(DataSource.class) —— 直接引用已知类,IDE 可提示、编译报错可提前发现拼写问题
  • @ConditionalOnClass(name = "org.springframework.boot.autoconfigure.jdbc.DataSourceAutoConfiguration") —— 字符串形式,适用于无法直接 import 的第三方类(如某些未引入的 SDK)
  • 可同时指定多个类:@ConditionalOnClass({JdbcTemplate.class, DataSource.class}),要求全部存在才生效
  • 注意:它只管“类是否存在”,不管该类是否被实例化或是否可用(比如 JDBC 驱动没配 URL,不影响条件判断)

典型应用场景:自动配置的按需加载

这是 Spring Boot 自动配置的核心机制之一。例如:

Spring Boot Actuator Analyzer
Spring Boot Actuator Analyzer

分析Spring Boot Actuator端点的安全性、健康检查、指标暴露及生产配置——审计信息、健康状态和自定义端点。

下载

立即学习“Java免费学习笔记(深入)”;

  • 只有项目引入了 spring-boot-starter-data-redis(含 RedisTemplate 类),RedisAutoConfiguration 才生效
  • 只有存在 HikariDataSource 类(HikariCP 在 classpath),才会启用 Hikari 数据源相关配置
  • 你自己的 Starter 里可以这样写:
```java
@Configuration
@ConditionalOnClass(RedisTemplate.class)
public class MyRedisExtensionConfig {
  @Bean
  @ConditionalOnMissingBean
  public RedisOperationHelper redisHelper(RedisTemplate<?, ?> template) {
    return new RedisOperationHelper(template);
  }
}

和 @ConditionalOnMissingClass 的配合使用

有时需要“有 A 就用 A,没 A 就退回到 B”。比如兼容不同客户端:

  • 优先装配基于 Lettuce 的 Redis 客户端(@ConditionalOnClass(LettuceClientConfiguration.class))
  • 再定义一个备用配置,加上 @ConditionalOnMissingClass("io.lettuce.core.RedisClient"),当 Lettuce 不在 classpath 时才生效
  • 两个配置互斥,确保最终只有一个生效

不复杂但容易忽略:这个注解只对 Spring 管理的 Bean 生效,且必须配合 @Configuration 或 @Bean 方法使用;单独加在普通类或 Service 上无效。

热门AI工具

更多
UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

LibLibAI
LibLibAI Hot

一款AI视频创作工具,主要用于国内领先的AI创意平台,以海量模型、低门槛操作与“创作-分享-商业化”生态,让小白与专业创作者都能高效实现图文乃至视频创意表达,适合需要提升相关任务效率的用户。

音述AI
音述AI Hot

一款AI音频处理工具,主要用于音述AI是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

相关专题

更多
java
java

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

9857

2023.06.15

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

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

7002

2023.07.05

java自学难吗
java自学难吗

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

6172

2023.07.31

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

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

1064

2023.08.01

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

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

888

2023.08.02

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

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

1296

2023.08.02

java有什么用
java有什么用

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

2589

2023.08.02

java在线网站
java在线网站

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

19911

2023.08.03

LLVM自定义Pass怎么写
LLVM自定义Pass怎么写

本专题聚焦LLVM自定义Pass开发,整理Pass类结构、run()方法、PreservedAnalyses、CMake构建、插件注册、-load-pass-plugin加载和测试用例编写流程。

100

2026.09.30

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn