Spring Boot 中的 @ConditionalOnBean 注解作用及基本用法

 更新时间:2025年04月15日 10:10:19   作者:weixin_98543211  
在 Spring Boot 中,@ConditionalOnBean 可以帮助我们根据 是否存在特定 Bean 来 动态注册 Bean,广泛用于 按需加载、自动配置 等场景,本文给大家介绍Spring Boot 中的 @ConditionalOnBean 注解,感兴趣的朋友一起看看吧

1. 前言

在 Spring Boot 中,条件注解(Conditional 注解) 是一种强大的功能,允许我们根据某些条件动态地注册或跳过特定的 Bean。其中,@ConditionalOnBean 是最常用的条件注解之一,它的作用是:当 Spring 容器中存在指定的 Bean 时,当前 Bean 才会被注册

本篇文章将详细介绍 @ConditionalOnBean 的使用场景、原理,并提供多个示例帮助理解。

2.@ConditionalOnBean 作用与基本用法

2.1 @ConditionalOnBean 的作用

@ConditionalOnBean 主要用于以下场景:

  • 按需加载 Bean:只有在某个 Bean 存在时,另一个 Bean 才会被创建。
  • 模块化设计:某些功能模块需要依赖特定 Bean 才能启用,例如 仅当某个组件存在时,自动配置才会生效
  • 避免 Bean 冲突:如果某个 Bean 依赖其他 Bean,则可使用 @ConditionalOnBean 确保它不会因缺少依赖而加载失败。

2.2 基本用法

示例:当 DataSource Bean 存在时,才创建 MyService Bean

import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import javax.sql.DataSource;
@Configuration
public class MyConfig {
    @Bean
    public DataSource dataSource() {
        // 这里模拟 DataSource 实例,实际可用 HikariDataSource、Druid 等
        return new FakeDataSource();
    }
    @Bean
    @ConditionalOnBean(DataSource.class)  // 仅当 DataSource 存在时,才创建 MyService
    public MyService myService() {
        return new MyService();
    }
}
class MyService {
    public MyService() {
        System.out.println("MyService 被创建");
    }
}
class FakeDataSource implements DataSource {
    // 这里可以模拟 DataSource 方法
}

执行结果

MyService 被创建

如果 dataSource() 方法被注释掉,则 MyService 不会被创建。

3. @ConditionalOnBean 详解

@ConditionalOnBean 提供了多个属性,可以更加灵活地控制 Bean 的创建。

3.1 value 和 type 属性(指定 Bean 类型)

用于指定某种类型的 Bean 存在时,当前 Bean 才会被注册。

@Bean
@ConditionalOnBean(value = DataSource.class)  // 仅当 DataSource 存在时生效
public MyRepository myRepository() {
    return new MyRepository();
}

等效于:

@Bean
@ConditionalOnBean(type = "javax.sql.DataSource")  // 使用全限定类名
public MyRepository myRepository() {
    return new MyRepository();
}

区别

  • value:直接使用 Class 类型,编译时检查更安全。
  • type:使用字符串,可用于避免某些类找不到(如可选依赖)。

3.2 name 属性(指定 Bean 名称)

用于 指定某个 Bean 名称是否存在 来决定当前 Bean 是否加载。

@Bean
@ConditionalOnBean(annotation = Repository.class)  // 仅当存在 @Repository 注解的 Bean 时生效
public MyService myService() {
    return new MyService();
}

3.3 annotation 属性(指定 Bean 需要标注的注解)

可以指定某些 Bean 是否包含特定注解,如果包含,则当前 Bean 才会被注册。

@Bean
@ConditionalOnBean(annotation = Repository.class)  // 仅当存在 @Repository 注解的 Bean 时生效
public MyService myService() {
    return new MyService();
}

3.4 search属性(搜索范围)

默认情况下,@ConditionalOnBean 只会在 当前应用上下文 中查找 Bean,而不会查找 父上下文(即 Spring Boot 的 ApplicationContext 层级)。

search 选项可以指定搜索范围:

  • ALL:在所有父子 ApplicationContext 中搜索。
  • CURRENT(默认):仅搜索当前 ApplicationContext
@Bean
@ConditionalOnBean(value = DataSource.class, search = SearchStrategy.ALL) // 在所有上下文中搜索
public MyService myService() {
    return new MyService();
}

4. @ConditionalOnBean 使用场景

场景 1:按需加载数据库相关 Bean

如果应用程序中 使用了数据库,则提供一个 DatabaseService,否则不创建:

@Bean
@ConditionalOnBean(DataSource.class)
public DatabaseService databaseService() {
    return new DatabaseService();
}

场景 2:启用某些自动配置

Spring Boot 的 spring-boot-autoconfigure 模块大量使用 @ConditionalOnBean 来控制自动配置。例如:

只有当 DispatcherServlet 存在时,Spring MVC 相关的自动配置才会生效

@Configuration
@ConditionalOnBean(DispatcherServlet.class)
public class MvcAutoConfiguration {
    // 仅当 DispatcherServlet 存在时,Spring MVC 配置生效
}

场景 3:可选依赖的组件

有时,某些功能是可选的,比如当 Redis 组件存在时,才创建缓存管理器:

@Bean
@ConditionalOnBean(name = "redisTemplate")  // 只有当 redisTemplate 存在时才加载
public CacheManager cacheManager() {
    return new RedisCacheManager();
}

5. @ConditionalOnBean vs @ConditionalOnMissingBean

注解作用
@ConditionalOnBean当指定 Bean 存在时,才注册当前 Bean
@ConditionalOnMissingBean当指定 Bean 不存在时,才注册当前 Bean

示例:

@Bean
@ConditionalOnMissingBean(DataSource.class)  // 仅当 DataSource 不存在时才创建
public DataSource defaultDataSource() {
    return new DefaultDataSource();
}

6. 结论

在 Spring Boot 中,@ConditionalOnBean 可以帮助我们根据 是否存在特定 Bean动态注册 Bean,广泛用于 按需加载、自动配置 等场景。

总结:

指定 Bean 类型@ConditionalOnBean(DataSource.class)
指定 Bean 名称@ConditionalOnBean(name = "customBean")
指定 Bean 注解@ConditionalOnBean(annotation = Repository.class)
搜索范围@ConditionalOnBean(search = SearchStrategy.ALL)

你在项目中用过 @ConditionalOnBean 吗?欢迎留言分享你的经验!🚀

到此这篇关于Spring Boot 中的 @ConditionalOnBean 注解详解的文章就介绍到这了,更多相关Spring Boot @ConditionalOnBean 注解内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 使用WebSocket实现即时通讯(一个群聊的聊天室)

    使用WebSocket实现即时通讯(一个群聊的聊天室)

    这篇文章主要为大家详细介绍了使用WebSocket实现即使通讯,实现一个群聊的聊天室,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2018-03-03
  • mybatis-plugin插件执行原理解析

    mybatis-plugin插件执行原理解析

    这篇文章主要介绍了mybatis-plugin插件执行原理,我们就需要来研究下Executor,ParameterHandler,ResultSetHandler,StatementHandler这4个对象的具体跟sql相关的方法,然后再进行修改,就可以直接起到aop的作用,需要的朋友可以参考下
    2022-10-10
  • java语言中封装类代码示例

    java语言中封装类代码示例

    这篇文章主要介绍了java语言中封装类,涉及相关代码示例及结果分析,以及封装的好处简单介绍,具有一定借鉴价值,需要的朋友可以参考下
    2018-01-01
  • struts2单个文件上传的两种实现方式

    struts2单个文件上传的两种实现方式

    这篇文章主要介绍了struts2单个文件上传的两种实现方式,有需要的朋友可以参考一下
    2014-01-01
  • Java中Lambda表达式的使用详解

    Java中Lambda表达式的使用详解

    Lambda 表达式,也可称为闭包,它是推动 Java 8 发布的最重要新特性。Lambda 允许把函数作为一个方法的参数(函数作为参数传递进方法中)。使用 Lambda 表达式可以使代码变的更加简洁紧凑
    2021-09-09
  • springboot-mysql-HikariCP集成过程

    springboot-mysql-HikariCP集成过程

    HiKariCP opens new window是数据库连接池的一个后起之秀,号称性能最好,可以完美地 PK 掉其他连接池,这篇文章主要介绍了springboot-mysql-HikariCP集成过程,需要的朋友可以参考下
    2023-07-07
  • SpringMVC + jquery.uploadify实现上传文件功能

    SpringMVC + jquery.uploadify实现上传文件功能

    文件上传是很多项目都会使用到的功能,SpringMVC当然也提供了这个功能。不过小编不建议在项目中通过form表单来提交文件上传,这样做的局限性很大。下面这篇文章主要介绍了利用SpringMVC + jquery.uploadify实现上传文件功能的相关资料,需要的朋友可以参考下。
    2017-06-06
  • 详解netty中常用的xml编码解码器

    详解netty中常用的xml编码解码器

    这篇文章主要介绍了netty中常用的xml编码解码器,进行frame拆分可以使用XmlFrameDecoder,进行xml文件内容的解析则可以使用XmlDecoder,接下来我们会详细讲解两个decoder实现和使用,感兴趣的朋友一起看看吧
    2022-05-05
  • java代码实现截图功能(屏幕截图)

    java代码实现截图功能(屏幕截图)

    java代码实现截图功能,该JavaBean可以直接在其他Java应用程序中调用,默认的文件前缀为GuiCamera,文件格式为PNG格式,直接使用下面的类吧
    2013-12-12
  • Springboot项目中定时任务的四种实现方式详解

    Springboot项目中定时任务的四种实现方式详解

    Spring的@Scheduled注解是一种非常简单和便捷的实现定时任务的方式,通过在方法上添加@Scheduled注解,我们可以指定方法在特定的时间间隔或固定的时间点执行,本文给大家介绍Springboot项目中定时任务的四种实现方式,感兴趣的的朋友一起看看b
    2024-02-02

最新评论