3.2版本Starter自定义条件注解开发【扩展能力】

夏杰大大_5300

夏杰大大_5300

2026-08-08

408人浏览

原创

要在spring boot 3.2中开发可扩展的自定义starter,必须使用meta-inf/spring/org.springframework.boot.autoconfigure.autoconfiguration.imports声明自动配置类,并精准运用@conditionalonclass(需字符串类名)、@conditionalonproperty(matchifmissing=false控制开关)、@conditionalonmissingbean(指定类型参数)和@conditionalonwebapplication(加在类上)等新版条件注解。

3.2版本starter自定义条件注解开发【扩展能力】

要在Spring Boot 3.2中开发具备扩展能力的自定义Starter,必须精准使用新版条件注解体系——Spring Boot 3.2废弃了spring.factories机制,全面转向META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件声明自动配置类,且部分Condition注解行为发生语义变更。

创建AutoConfiguration.imports声明入口

在src/main/resources/META-INF/spring/目录下新建org.springframework.boot.autoconfigure.AutoConfiguration.imports文件(注意路径和文件名完全一致,大小写敏感)。

逐行写入自动配置类全限定名,每行一个,不可有空格或注释:

【com.example.sms.autoconfigure.SmsAutoConfiguration】

这一步不可跳过或写错路径,否则Spring Boot 3.2启动时完全不会扫描该配置类,后续所有条件逻辑均失效。

用@ConditionalOnClass检测依赖存在性

方法一:检测核心客户端类是否存在

在自动配置类上添加@ConditionalOnClass,指定你封装功能所依赖的第三方类:

@ConditionalOnClass(name = "com.aliyuncs.DefaultAcsClient")

注意:Spring Boot 3.2要求显式使用name属性传入字符串类名,不能直接写DefaultAcsClient.class——否则编译通过但运行时因类未加载而判定失败。

方法二:同时检测多个类

用数组形式传入多个类名字符串:

@ConditionalOnClass(name = {"com.tencentcloud.common.Credential", "com.tencentcloud.sms.v20190711.SmsClient"})

只要数组中任意一个类在classpath中存在,条件即满足。适合多厂商短信SDK兼容场景。

用@ConditionalOnProperty控制功能开关

第一步:定义配置属性前缀

在自动配置类上添加@EnableConfigurationProperties(SmsProperties.class),确保属性绑定生效。

第二步:声明启用开关

在@Bean方法上加注解:

@ConditionalOnProperty(prefix = "custom.sms", name = "enabled", havingValue = "true", matchIfMissing = false)

Flova
Flova

Flova是一款AI文本写作工具,全球首个一体化 AI 视频创作平台。

下载

【matchIfMissing = false是关键】 表示如果用户application.yml里根本没配custom.sms.enabled,则默认不启用该Bean——避免误触发生产环境短信发送。

第三步:支持多级开关嵌套

例如只在测试环境启用模拟模式:

@ConditionalOnProperty(prefix = "custom.sms.mock", name = "enabled", havingValue = "true")

此时需同时满足custom.sms.enabled=true与custom.sms.mock.enabled=true才加载MockSmsService。

用@ConditionalOnMissingBean实现安全覆盖

① 声明Bean时必须指定类型参数

错误写法:@ConditionalOnMissingBean

正确写法:@ConditionalOnMissingBean(SmsService.class)

② 若用户已在主应用中定义同类型Bean,你的Starter不会覆盖它,而是静默跳过注册。

③ 支持按名称排除:

@ConditionalOnMissingBean(value = SmsService.class, ignored = DefaultSmsService.class)

表示即使容器中已存在DefaultSmsService实例,只要没有其他SmsService实现,仍会注入当前Bean。

④ 注意:Spring Boot 3.2中@ConditionalOnMissingBean不再支持search = SearchStrategy.ALL参数,如需跨层级查找,请改用@Primary配合手动注入。

用@ConditionalOnWebApplication限定运行环境

仅当项目是Web应用时才加载短信配置:

@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)

若项目为Reactive Web(如WebFlux),需改为Type.REACTIVE;若两者都支持,去掉type参数即可。

这个注解必须加在配置类上,不能加在单个@Bean方法上——加在方法上会导致Spring Boot 3.2忽略该条件。

相关文章

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

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

下载

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

相关专题

更多
Buffalo框架数据库开发全教程
Buffalo框架数据库开发全教程

本专题围绕Buffalo框架数据库开发,讲解database.yml多环境配置、soda与fizz迁移生成回滚、模型结构体标签、增删改查与条件查询、一对多与多对多关联、数据校验、回调钩子、事务处理及原生SQL执行能力。

2026.09.23

60

15

Buffalo框架路由与请求处理实操指南
Buffalo框架路由与请求处理实操指南

本专题讲解Buffalo框架路由与请求处理机制,涵盖路由注册与分组、资源路由、Handler编写规范、Context上下文方法、参数绑定、中间件编写挂载、Session与Cookie读写、Flash消息及错误页面定制方法。

2026.09.23

20

15

Buffalo框架零基础入门教程
Buffalo框架零基础入门教程

本专题整理Buffalo框架入门内容,涵盖Go环境准备、buffalo CLI安装、新项目生成、目录结构说明、dev热加载启动、数据库连接配置与常见报错排查,帮助新手按约定优于配置的思路跑通第一个Buffalo框架应用。

2026.09.23

20

15

Conan创建软件包配方指南
Conan创建软件包配方指南

本专题介绍通过conanfile.py创建软件包的方法,讲解包名、版本、依赖和构建设置等基础信息,以及source、build、package、package_info等常用方法的作用及编写思路。

2026.09.22

20

12

Conan二进制包配置指南
Conan二进制包配置指南

本专题介绍Conan根据操作系统、编译器、架构和构建类型生成二进制包的方法,讲解Profile、Settings、Options及Package ID的作用,帮助管理不同平台和编译环境下的包版本。

2026.09.22

20

13

Conan私有仓库搭建教程
Conan私有仓库搭建教程

本专题系统的讲解Conan私有仓库的搭建流程,涵盖仓库服务部署、存储目录配置、用户认证、权限划分和远程地址添加,并介绍内部C++依赖包的上传、下载及版本维护方法。

2026.09.22

20

19

loomy官网入口地址合集
loomy官网入口地址合集

本专题汇总了 Loomy 桌面 AI 助理的官方入口地址合集及使用指南。提供 macOS 与 Windows 客户端下载 。Loomy 是讯飞推出的桌面级 AI 工作搭子,支持文件整理、数据分析、网页操作及通过飞书/钉钉远程操控电脑,助你高效完成本地办公任务 。

2026.09.22

20

19

NumPy常见函数使用方法
NumPy常见函数使用方法

本专题整理 NumPy 常见函数使用方法相关教程,覆盖函数大全、参数用法、数组运算、统计聚合、排序处理、where 条件筛选、linspace 创建数列等常用场景,帮助读者快速掌握 NumPy 函数调用思路和实际数据处理技巧。

2026.09.22

40

21

NumPy性能优化版本更新与常见报错排查
NumPy性能优化版本更新与常见报错排查

本专题整理 NumPy 性能优化、版本更新与常见报错排查相关教程,覆盖向量化计算、广播性能、内存布局、NumPy 2.0 升级、版本兼容冲突、安装导入报错、dtype 溢出、矩阵运算异常和 broadcasting 报错修复,帮助读者系统掌握 NumPy 性能调优与问题定位方法。

2026.09.22

60

25

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.6万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 133.2万人学习