Java 中 Spring Boot 怎么编写自定义 Starter 组件

冬明同学_4836

冬明同学_4836

2026-09-30

826人浏览

原创

spring boot 自定义 starter 的核心是自动配置+条件装配+配置属性绑定,需通过 autoconfiguration.imports 声明配置类,用 @conditionalonclass/@conditionalonmissingbean 控制加载,并以 @configurationproperties 绑定 aliyun.sms. 前缀配置实现开箱即用。

java 中 spring boot 怎么编写自定义 starter 组件

Spring Boot 自定义 Starter 的核心是“自动配置 + 条件装配 + 配置属性绑定”,不是写个 jar 就叫 Starter,关键在于让使用者 零配置就能开箱即用,同时支持按需定制。

1. 明确 Starter 的职责边界

一个规范的 Starter 应只做一件事:封装某类功能(如 Redis 客户端、短信发送、Excel 导出),并隐藏底层复杂性。它不包含业务逻辑,也不依赖具体项目结构。

  • 命名建议:以 xxx-spring-boot-starter 结尾(如 aliyun-sms-spring-boot-starter)
  • 不要在 Starter 中直接读取 application.yml 全局配置,而是通过 @ConfigurationProperties 绑定专属前缀(如 aliyun.sms.)
  • 避免引入非必要依赖——Starter 的 pom.xml 中,非核心依赖应设为 optional = true

2. 搭建 Starter 工程结构

新建 Maven 模块(非 Spring Boot Web 项目),目录结构精简:

  • src/main/java/com.example.starter:放自动配置类、属性类、工具类
  • src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports(Spring Boot 2.7+ 推荐方式,替代旧版 spring.factories)
  • 无需 application.properties,不启动任何服务

在 AutoConfiguration.imports 文件中,逐行写入自动配置类的全限定名,例如:

com.example.starter.AliyunSmsAutoConfiguration

3. 编写自动配置类(核心)

这是一个普通 @Configuration 类,但需配合条件注解控制加载时机:

javascript-pro
javascript-pro

专注现代 ECMAScript、异步编程、性能优化和全栈的 JavaScript 专家,适用于现代开发

下载
  • 用 @ConditionalOnClass 确保类路径存在关键依赖(如 com.aliyuncs.CommonRequest)
  • 用 @ConditionalOnMissingBean 避免与用户自定义 Bean 冲突
  • 用 @EnableConfigurationProperties 绑定配置属性
  • 方法上加 @Bean 声明要注入的组件(如 SmsService)

示例片段:

@Configuration
@ConditionalOnClass(CommonRequest.class)
@EnableConfigurationProperties(AliyunSmsProperties.class)
public class AliyunSmsAutoConfiguration {
  @Bean
  @ConditionalOnMissingBean
  public SmsService smsService(AliyunSmsProperties props) {
    return new DefaultSmsService(props);
  }
}

4. 提供可配置属性和默认行为

定义属性类时继承 @ConfigurationProperties,并指定前缀:

@ConfigurationProperties(prefix = "aliyun.sms")
public class AliyunSmsProperties {
  private String accessKeyId;
  private String accessKeySecret;
  private String regionId = "cn-hangzhou";
  // getter/setter...
}

使用者只需在 application.yml 中写:

aliyun:
  sms:
    access-key-id: xxx
    access-key-secret: xxx

Starter 就会自动创建并注入 SmsService,业务代码直接 @Autowired 即可使用。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

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

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

下载

相关标签:

java spring boot

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

相关专题

更多
java
java

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

2023.06.15

9357

6

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

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

2023.07.05

6522

9

java自学难吗
java自学难吗

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

2023.07.31

5812

8

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

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

2023.08.01

1024

3

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

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

2023.08.02

848

3

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

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

2023.08.02

1216

5

java有什么用
java有什么用

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

2023.08.02

2469

5

java在线网站
java在线网站

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

2023.08.03

19811

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1115

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习