Spring Boot入门指南:Starter依赖管理与自定义组件封装【架构设计】

浅涛吖_7697

浅涛吖_7697

2026-08-05

659人浏览

原创

spring boot自定义starter必须遵循starter-autoconfigure模块分离结构,通过meta-inf/spring/org.springframework.boot.autoconfigure.autoconfiguration.imports注册条件化配置类,并绑定@configurationproperties实现外部可配,从而达成“引入即用”。

spring boot入门指南:starter依赖管理与自定义组件封装【架构设计】 - php中文网

要在Spring Boot项目中统一管理中间件依赖、避免手动配置重复出错,并让团队新成员三步接入Redis或自定义服务,必须掌握Starter的依赖聚合机制与自动装配原理。

创建符合规范的Starter模块结构

新建Maven模块,命名为mycompany-redis-spring-boot-starter——【命名必须以-spring-boot-starter结尾,否则Spring Boot不会识别为Starter】

在该模块的pom.xml中仅声明对autoconfigure模块的依赖,不引入任何业务代码或第三方库。

另建一个同名但后缀为-spring-boot-autoconfigure的模块(如mycompany-redis-spring-boot-autoconfigure),所有配置类、属性类、Bean定义都放在这里。

这种拆分不是可选建议,而是强制要求:starter模块只做依赖传递,autoconfigure模块承载全部自动装配逻辑,否则无法实现条件化加载与版本隔离。

编写可外部配置的属性绑定类

在autoconfigure模块中创建RedisClientProperties类:

添加@ConfigurationProperties(prefix = "mycompany.redis")注解,并声明host、port、timeout等字段;每个字段必须设默认值,比如private int port = 6379;

加上@Component@Validated,确保该类能被Spring容器扫描并校验。

这一步不做,后续yml里的mycompany.redis.host就无法注入到Bean中,整个配置体系会失效。

定义条件化自动配置类

方法一:使用@ConditionalOnClass控制生效时机

创建RedisClientAutoConfiguration类,标注@Configuration@EnableConfigurationProperties(RedisClientProperties.class)

在类中定义@Bean方法返回RedisClient实例,方法参数直接接收RedisClientProperties对象——Spring会自动注入已绑定的配置。

在该@Bean方法上添加@ConditionalOnClass(RedisClient.class),确保只有项目里真有这个类时才创建Bean。

Spring Boot 3.3.13
Spring Boot 3.3.13

Spring Boot下载页提供 3.3.13 官方源码 ZIP,并整理快速入门、项目创建、配置和自动配置说明。

下载

方法二:用@ConditionalOnProperty开关控制启用

在同一个@Bean方法上追加@ConditionalOnProperty(name = "mycompany.redis.enabled", havingValue = "true", matchIfMissing = true)

【matchIfMissing = true表示配置项未显式声明时,默认启用,避免因漏配导致功能静默失效】

注册自动配置类到Spring Boot扫描链

第一步:在autoconfigure模块的src/main/resources/META-INF/下创建spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports文件(注意路径和文件名完全匹配)。

第二步:在该文件中逐行写入自动配置类的全限定名,例如:

com.mycompany.starter.redis.autoconfigure.RedisClientAutoConfiguration

第三步:确认该文件编码为UTF-8且无BOM头,否则Spring Boot启动时读取失败,自动配置类不会被加载。

第四步:执行mvn clean install将autoconfigure模块安装到本地仓库,再让starter模块依赖它。

在业务项目中引入并验证Starter

在目标Spring Boot项目的pom.xml中添加starter依赖:

<dependency><groupid>com.mycompany</groupid><artifactid>mycompany-redis-spring-boot-starter</artifactid><version>1.0.0</version></dependency>

application.yml中写入:

mycompany:redis:host: 127.0.0.1

启动应用,观察控制台是否打印Redis连接初始化日志;若无报错且@Autowired RedisClient可成功注入,则Starter已生效。

相关文章

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

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

下载

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

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2025.08.06

2071

22

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

2026.01.26

377

25

AI视频生成软件推荐
AI视频生成软件推荐

本专题汇总了当前主流的AI视频生成软件推荐与排行榜单,涵盖seko、AniShort、剧云、Lovart、LiblibAI及立刻mv等热门工具。同时整理了各软件在文生视频、图生视频、时长限制、画质表现及免费额度等方面的差异对比,助您快速选对适合创作需求的AI视频生成工具。

2026.09.16

140

9

ai生成视频的工具免费版合集
ai生成视频的工具免费版合集

本专题汇总了当前免费AI生成视频工具的排行榜与推荐清单,涵盖seko、讯飞智作、AniShort及剧云、Lovart等多模型集成平台。同时整理了各工具的免费额度、输出时长、水印政策及适用场景差异,助您快速选择合适工具开启AI视频创作。

2026.09.16

60

10

Pandas时间序列分析与可视化报表
Pandas时间序列分析与可视化报表

本专题整理Pandas日期转换、时间索引、重采样、滚动窗口、时区处理、plot绘图、Styler表格样式和报表输出方法。

2026.09.16

60

23

Pandas数据筛选索引与清洗处理
Pandas数据筛选索引与清洗处理

本专题整理Pandas中的loc、iloc、条件筛选、query查询、缺失值处理、重复值删除、类型转换和字符串列清洗方法。

2026.09.16

40

25

Pandas数据读取导入与文件导出处理
Pandas数据读取导入与文件导出处理

本专题整理Pandas读取CSV、Excel、JSON、SQL、Parquet等文件的方法,以及to_csv、to_excel、to_sql和to_parquet等常用数据导出流程。

2026.09.16

40

27

GDB怎么设置断点
GDB怎么设置断点

本专题介绍GDB按照函数名、源代码行号和文件位置设置断点的方法,详细说明run、continue、next、step等命令的配合使用,帮助定位程序崩溃、逻辑异常及代码未按预期执行的问题。

2026.09.11

360

28

GDB怎么查看变量值
GDB怎么查看变量值

本专题介绍GDB调试过程中查看变量值的具体方法,涵盖局部变量、函数参数、数组、结构体和指针内容查询,同时整理变量持续显示、格式化输出及无法读取变量时的排查思路。

2026.09.11

120

22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Spring Boot 官方快速入门指南
Spring Boot 官方快速入门指南

共0课时 | 0人学习

Spring Boot 官方参考文档
Spring Boot 官方参考文档

共0课时 | 0人学习

尚硅谷新版SpringBoot3教程
尚硅谷新版SpringBoot3教程

共0课时 | 0人学习