当前位置: 首页 > news >正文

Spring Boot 注解 @ConditionalOnMissingBean是什么

一句话总结:

@ConditionalOnMissingBean 是 Spring Boot 提供的一个 条件注解(Conditional Annotation),意思是:

只有当 Spring 容器中 不存在 某个 Bean 时,当前的 Bean 或配置才会被加载。

这是一种典型的“按需装配”策略,常用于自动配置类(Auto Configuration)中。

如果大家有看源码的习惯,会发现到处都有这个注解:

RestTemplate:

Jackson - ObjectMapper:

  • Spring Boot 默认提供的 JSON 解析工具 ObjectMapper

  • 如果你没自己定义一个,它就帮你创建一个默认的

  • 你可以完全覆盖它,比如配置命名策略、日期格式等

框架或者组件库想要提供一个默认实现,但又允许使用者自定义自己的实现。这个时候就可以使用 @ConditionalOnMissingBean。这就达到了 可扩展+默认兜底 的目的。

同理,还有个相对应的是:@ConditionalOnBean 

对比:@ConditionalOnBean vs @ConditionalOnMissingBean

注解含义
@ConditionalOnBean(SomeClass.class)只有当容器中存在 SomeClass 类型的 Bean 时才执行
@ConditionalOnMissingBean(SomeClass.class)只有当容器中不存在 SomeClass 类型的 Bean 时才执行

这两个注解是互补的,分别用于不同的场景。

支持的用法形式

@ConditionalOnMissingBean(SomeClass.class)                 // 类型判断
@ConditionalOnMissingBean(name = "someBeanName")           // 名称判断
@ConditionalOnMissingBean(value = SomeClass.class)         // 等价于上面的类型判断
@ConditionalOnMissingBean(type = "com.example.SomeClass")  // 用字符串形式避免类加载

你也可以组合使用,如:

@ConditionalOnMissingBean(value = SomeInterface.class,name = "customBean"
)

特别注意:

不能直接加在 @Component、@Service、@Controller 等用于直接注册 Bean 的注解上,因为 Spring 在解析这些注解时并不会走自动配置的判断逻辑,因此不会触发 @ConditionalOnMissingBean 的条件判断,最终会导致Bean 被强制注册或 注册失败报错!

代码示例

自定义一个接口:


public interface MyService {void hello();
}

错误示例

先来一个错误示例(直接在@Component下加上了):


@Slf4j
@Component
@ConditionalOnMissingBean(MyService.class)
public class MyServiceDefault implements MyService {@Overridepublic void hello() {log.info("use default bean...");}
}

 项目不会报错,直接启动后查找Bean:

会发现根本没注册上。所以,虽然加在@Component等注解的类上语法允许,但 Spring 不会进行条件判断和直接注册,可能导致意料之外的报错。所以不要这么用。

正确用法:

@Configuration + @Bean 的方式(大家回头看看我最上面截的源码截图中,也都是这种方式)


@Configuration
public class MyServiceAutoConfiguration {@Bean@ConditionalOnMissingBean(MyService.class)public MyService myService() {return new MyServiceDefault();}
}

默认实现类:


@Slf4j
public class MyServiceDefault implements MyService {@Overridepublic void hello() {log.info("use default bean...");}
}

找个地方调用一下:

public class StarApplication {@Autowiredprivate MyService myService;public static void main(String[] args) {SpringApplication.run(StarApplication.class, args);}@PostConstructpublic void test() {myService.hello();}
}

现在模拟用户实现了这个接口:


@Slf4j
@Component
public class MyServiceUser implements MyService {@Overridepublic void hello() {log.info("use self bean...");}
}

可以看到就一个Bean:

当然,你也可以去掉这个注解试试:

再次运行:

可以看到两个地方都注册上了。

相关文章:

  • 【Bluedroid】蓝牙 HID Host connect全流程源码解析
  • 通过云服务器实现异地组网 部署WireGuard
  • LeetCode Hot100 (双指针)
  • F5《2025年应用战略现状》报告:AI 落地加速,企业战略从讨论迈向行动
  • 【风控】模型算法区分度指标KS
  • 【C++进阶篇】红黑树的实现(赋源码)
  • 【软件使用】RSS(Really Simple Syndication)
  • 养生指南:五维提升健康品质
  • 重拾童年,用 CodeBuddy 做自己的快乐创作者
  • S7-1500PLC通过工艺对象实现V90总线伺服定位控制(105报文)
  • JavaWeb Web基础
  • Git命令汇总(自用,持续更新update 5/23)
  • Gartner《如果有效评估Generative AI项目的投资回报》学习心得
  • 账号冻结风险升级!亚马逊视频验证新增3大审核标准
  • Linux进程信号(五)之捕捉信号
  • c++11特性——lambda对象、包装器
  • 市面上有好用的拓客系统吗?
  • 计算机发展史
  • Java中static关键字深度解析:从入门到高阶实战
  • Vaptcha 手势、轨迹验证码
  • 网站建设有哪些平台/友情链接交换标准
  • 做一个网站的建设过程/长沙做网站推广
  • dede wap网站模板下载/专业黑帽seo
  • 合肥餐饮网站建设/seo是什么意思为什么要做seo
  • dedecms做网站视频/百度搜索关键词数据
  • 外贸单页网站案例/新闻危机公关