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

如何在Spring Boot中自定义Starter_封装公司内部公共组件的标准步骤

风静君_3959

风静君_3959

发布时间:2026-03-21 16:15:00

|

1016人浏览过

|

来源于php中文网

原创

starter 的 artifactId 必须以 -spring-boot-starter 结尾,否则 Spring Boot 不会扫描其自动配置类;正确命名如 mycompany-spring-boot-starter,且需分离 autoconfigure 与 starter 模块,避免依赖污染。

如何在spring boot中自定义starter_封装公司内部公共组件的标准步骤

starter 的命名必须以 -spring-boot-starter 结尾,否则 autoconfigure 不生效

Spring Boot 的自动装配机制靠 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports(2.7+)或 META-INF/spring.factories(旧版)触发,但前提是 starter 的 artifactId 必须符合命名规范。如果起名 mycompany-common,哪怕包里写了 @EnableAutoConfiguration,Boot 启动时根本不会扫描它。

正确命名示例:mycompany-spring-boot-starter、mycompany-redis-spring-boot-starter。Maven 依赖引入后,Boot 才会把它纳入 auto-configuration 候选范围。

  • 别用下划线代替中划线:mycompany_starter ❌,mycompany-spring-boot-starter ✅
  • 不要省略 -spring-boot-starter 后缀,mycompany-starter 也不行
  • 若已有老项目用了非标准名,只能靠在主应用的 @SpringBootApplication 上手动加 scanBasePackages,但违背 starter 设计初衷

autoconfigure 模块不能直接依赖 spring-boot-starter

自定义 starter 通常拆成两部分:一个只含自动配置逻辑的 -autoconfigure 模块(无 web、无 actuator),另一个是对外暴露的 -spring-boot-starter 模块(只声明依赖)。如果把 spring-boot-starter-web 直接写进 autoconfigure 的 pom.xml,会导致所有引入该 starter 的项目被迫带上 web 依赖——哪怕它是个纯定时任务服务。

正确的依赖结构:

  • mycompany-spring-boot-starter:仅依赖 mycompany-spring-boot-autoconfigure + spring-boot-starter(空的 BOM)
  • mycompany-spring-boot-autoconfigure:只依赖 spring-boot-autoconfigure、spring-context 等底层 API,按需引入具体组件如 lettuce-core,但绝不拉 spring-boot-starter-xxx

否则你会看到启动时报错:ClassNotFoundException: org.springframework.web.servlet.DispatcherServlet,而你的模块根本不需要 MVC。

@ConditionalOnClass 和 @ConditionalOnMissingBean 的组合顺序很关键

自动配置类里常要控制“有某个类才生效”“没某个 Bean 才注入”。但这两个条件不是并列判断,而是短路执行:Spring 先检查 @ConditionalOnClass,失败就跳过整个配置类;只有通过了,才继续判断 @ConditionalOnMissingBean。

比如封装一个默认 MyService 实现:

@Configuration
@ConditionalOnClass(MyService.class)
@ConditionalOnMissingBean(MyService.class)
public class MyAutoConfiguration {
    @Bean
    public MyService myService() {
        return new DefaultMyService();
    }
}

如果用户自己写了 @Bean MyService,这个配置类仍会加载(因为 MyService.class 存在),但 @Bean 方法不执行(因 missing 条件不满足)。可一旦把两个注解顺序颠倒,Spring 会先查有没有 MyService Bean,此时上下文为空,条件成立,接着再检查 @ConditionalOnClass ——但如果用户没引入相关 jar,MyService.class 根本不存在,整个配置类直接被忽略,连 fallback 都没机会。

  • 优先用 @ConditionalOnClass 做“能力探测”,再用 @ConditionalOnMissingBean 做“兜底注入”
  • 避免在同一个 @Bean 上叠加多个 @ConditionalOnXxx,语义易混淆;拆到类级别更清晰
  • 测试时记得删掉用户自定义 Bean,验证 autoconfigure 是否真能 fallback

配置属性绑定必须用 @ConfigurationProperties,且 prefix 要唯一

用户通过 application.yml 配置你的组件行为,比如 mycompany.cache.ttl=60。这背后靠的是 @ConfigurationProperties(prefix = "mycompany.cache")。如果 prefix 写成 cache 或 redis,极易跟其他 starter 冲突——别人也用 redis.host,你的类一加载就报 BindingValidationException。

  • prefix 必须带公司/产品前缀,如 mycompany.redis、mycompany.metrics
  • 类上必须加 @ConfigurationProperties,且需在 autoconfigure 模块中显式声明为 @Bean 或用 @EnableConfigurationProperties
  • 不要用 @Value("${...}") 注入配置项,它不支持松散绑定(mycompany.cache-ttl ≠ mycompany.cache_ttl),也不校验
  • 加上 @Validated 和字段级 @NotBlank 等注解,能让配置错误在启动时报明确提示,而不是运行时 NPE

真正麻烦的是跨模块引用:如果 starter A 和 B 都用了 mycompany.common prefix,又都声明了同名属性,Spring 会合并还是覆盖?答案是不确定——取决于加载顺序,这种耦合必须靠命名隔离来根除。

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

热门AI工具

更多
Loomy
Loomy Hot

一款AI工具,主要用于科大讯飞发布的桌面级 AI 助理,比 OpenClaw 更易用、更安全!,适合需要提升相关任务效率的用户。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

二狗PPT
二狗PPT Hot

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

AionClaw
AionClaw Hot

AionClaw是一款面向办公、创作和编程任务的AI桌面智能体。

DeepSeek

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

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

WorkBuddy

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

豆包大模型

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

Laper
Laper Hot

Laper是专为编剧、导演和制片人推出的 AI 原生剧本创作工具。

相关专题

更多
java
java

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

10837

2023.06.15

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

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

7962

2023.07.05

java自学难吗
java自学难吗

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

6912

2023.07.31

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

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

1164

2023.08.01

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

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

948

2023.08.02

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

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

1416

2023.08.02

java有什么用
java有什么用

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

2849

2023.08.02

java在线网站
java在线网站

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

20151

2023.08.03

OpenJDK JVM参数怎么调优
OpenJDK JVM参数怎么调优

Java应用运行缓慢,如何调整JVM参数?本专题介绍OpenJDK JVM性能调优的基本流程,涵盖性能指标确认、运行数据采集、内存配置和垃圾回收分析,帮助你先定位瓶颈,再通过对照测试验证效果,避免直接套用参数而影响应用稳定性。

80

2026.10.16

热门下载

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

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn