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

Java 中怎么在 Spring Boot 中编写自定义 Starter 封装通用业务组件

冬静酱_2455

冬静酱_2455

发布时间:2026-08-19 16:25:14

|

398人浏览过

|

来源于php中文网

原创

Spring Boot 自定义 Starter 的核心是遵循“约定优于配置”原则,通过 autoconfigure 模块(含自动配置类、属性绑定、条件注解)和 starter 模块(纯 pom,声明依赖)实现开箱即用;以短信组件为例,需定义 SmsProperties、SmsAutoConfiguration,并在 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 中注册配置类,最后通过集成测试验证并发布使用。

java 中怎么在 spring boot 中编写自定义 starter 封装通用业务组件

在 Spring Boot 中编写自定义 Starter,核心是把通用业务逻辑封装成可自动装配、开箱即用的模块,让其他项目只需引入依赖 + 简单配置就能使用。关键不在“写代码”,而在“约定优于配置”——遵循 Spring Boot 的自动装配机制。

理解 Starter 的组成结构

一个规范的 Starter 通常包含两个模块(也可合为一个):

  • xxx-spring-boot-autoconfigure:含自动配置类(@Configuration)、条件注解(@ConditionalOnClass、@ConditionalOnMissingBean等)、属性绑定类(@ConfigurationProperties)和核心 Bean 定义;
  • xxx-spring-boot-starter:纯 pom 工程,只负责引入 autoconfigure 模块 + 其他必要依赖(如 slf4j、commons-lang3),不写任何 Java 代码。

这样设计是为了分离“配置逻辑”和“依赖声明”,方便使用者按需选择是否启用某些功能。

编写自动配置模块(autoconfigure)

以封装一个通用的「短信发送组件」为例:

Alibabacloud Sdk Client Initialization For Java
Alibabacloud Sdk Client Initialization For Java

在 Java 中初始化和管理阿里云 SDK客户端。包括单例模式、线程安全、endpoint 与 region 配置、VPC 终端节点、同步与异步等。

下载

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

  • 定义配置属性类:SmsProperties,用 @ConfigurationProperties("sms") 绑定 application.yml 中的 sms.provider、sms.timeout 等字段;
  • 编写自动配置类:SmsAutoConfiguration,加上 @EnableConfigurationProperties(SmsProperties.class) 和 @ConditionalOnProperty(prefix = "sms", name = "enabled", havingValue = "true", matchIfMissing = true) 控制是否生效;
  • 在该配置类中定义 @Bean 方法,例如返回 SmsService 实例,并根据 sms.provider 值决定注入 AliyunSmsService 还是 TencentSmsService;
  • 确保类路径下有 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 文件(Spring Boot 2.7+ 推荐方式),内容为你的配置类全限定名,如:
    com.example.sms.autoconfigure.SmsAutoConfiguration

编写 Starter 模块(starter)

这是一个空的 Maven 模块,pom.xml 只做一件事:声明依赖。

  • 打包类型设为 pom;
  • 依赖中引入自己的 autoconfigure 模块(compile 范围);
  • 把真正运行时需要的第三方库(如 http client、json 处理器)也声明进来,避免使用者重复引;
  • 不要添加 spring-boot-starter 或 spring-boot-starter-web 等基础 starter——除非你明确要求宿主应用必须是 Web 环境。

测试与使用

本地测试建议用 spring-boot-starter-test 写集成测试:

  • 新建测试模块或在 autoconfigure 模块中加 @SpringBootTest 类;
  • 用 @ImportAutoConfiguration 导入你的配置类,或直接 @ContextConfiguration 加载;
  • 验证 SmsService 是否成功注入、属性是否正确绑定、条件注解是否按预期生效。

发布到私有 Maven 仓库后,其他项目只需在 pom.xml 中添加 starter 依赖,再在 application.yml 配置 sms.enabled=true 和相关参数,即可直接 @Autowired SmsService 使用。

热门AI工具

更多
超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

豆包大模型

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

DeepSeek

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

UP简历
UP简历 Hot

一款AI办公效率工具,主要用于基于AI技术的免费在线简历制作工具,适合需要提升相关任务效率的用户。

WorkBuddy

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

切问学术

切问学术是一款AI论文写作工具,复旦大学NLP团队推出的AI学术智能体。

LibLibAI
LibLibAI Hot

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

二狗PPT
二狗PPT Hot

一款AI演示文稿工具,主要用于专为中式职场打造的AI PPT生成工具,适合需要提升相关任务效率的用户。

相关专题

更多
java
java

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

9057

2023.06.15

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

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

6242

2023.07.05

java自学难吗
java自学难吗

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

5592

2023.07.31

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

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

1004

2023.08.01

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

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

828

2023.08.02

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

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

1176

2023.08.02

java有什么用
java有什么用

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

2389

2023.08.02

java在线网站
java在线网站

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

19731

2023.08.03

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

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

60

2026.09.23

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
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