Java 中 Spring Boot 怎么编写一个符合官方规范的自定义自动配置 Starter 组件以供跨项目复用

星丽大大_4179

星丽大大_4179

2026-07-26

315人浏览

原创

spring boot starter 必须命名为 xxx-spring-boot-starter,是纯 maven 模块,仅负责依赖传递与自动配置;需依赖 spring-boot-autoconfigure,通过 @conditionalonclass、@conditionalonproperty 等控制配置加载,并在 meta-inf/spring/org.springframework.boot.autoconfigure.autoconfiguration.imports 中注册自动配置类。

java 中 spring boot 怎么编写一个符合官方规范的自定义自动配置 starter 组件以供跨项目复用

理解 Starter 的核心结构与命名规范

Spring Boot 官方要求 Starter 必须遵循 xxx-spring-boot-starter 的命名格式(如 mybatis-spring-boot-starter),且不能包含 spring-boot-starter- 前缀(那是 Spring 官方维护的)。Starter 本身应是一个纯 Maven 模块,不写业务逻辑,只负责依赖传递 + 自动配置加载。

创建 starter 模块并声明正确依赖

新建一个 Maven 模块(如 demo-feature-spring-boot-starter),在 pom.xml 中:

  • 依赖 spring-boot-autoconfigure 和 spring-boot-starter(提供基础自动装配能力)
  • 使用 <scope>provided</scope> 引入你封装的「核心功能模块」(如 demo-feature-core),避免重复打包
  • 不要直接依赖 Spring Boot Web、Data 等 starter —— 由使用者按需引入

编写自动配置类并启用条件化加载

在 src/main/java 下新建配置类(如 DemoFeatureAutoConfiguration),用 @Configuration 和 @ConditionalOnClass / @ConditionalOnMissingBean 控制生效时机:

Java Maven Common
Java Maven Common

Java Maven 项目审查工作流的通用输入处理。当 Java Maven 项目以 ZIP压缩包或 GitLab 仓库 URL 形式提供且需要...时使用。

下载
  • 用 @ConditionalOnClass(SomeService.class) 确保仅当用户项目含相关类时才加载
  • 用 @ConditionalOnProperty(prefix = "demo.feature", name = "enabled", havingValue = "true", matchIfMissing = true) 支持开关控制
  • 配置类中通过 @Bean 注册组件,并标注 @ConditionalOnMissingBean 避免与用户自定义 Bean 冲突

注册自动配置并确保资源可见

在 src/main/resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports(Spring Boot 2.7+ 推荐路径)中,逐行写入你的自动配置类全限定名:

com.example.demo.feature.DemoFeatureAutoConfiguration

⚠️ 注意:不要用旧版 spring.factories(已废弃),除非兼容 Spring Boot 2.6 及更早版本;若需多版本支持,可同时保留两者,但优先走 AutoConfiguration.imports。

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

相关专题

更多
java
java

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

2023.06.15

10657

6

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

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

2023.07.05

7782

9

java自学难吗
java自学难吗

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

2023.07.31

6772

8

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

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

2023.08.01

1144

3

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

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

2023.08.02

948

3

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

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

2023.08.02

1396

5

java有什么用
java有什么用

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

2023.08.02

2809

5

java在线网站
java在线网站

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

2023.08.03

20111

3

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

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

2023.08.03

1235

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习