SpringBoot如何实现一个自定义Starter?

面试简说

面试时可简洁概括：自定义 Starter 是把通用功能（如日志、工具类）封装成可复用模块，让其他项目引依赖即自动配置 。核心是利用 Spring Boot 自动配置原理，通过 spring.factories（或 3.x+ 的 AutoConfiguration.imports）指定自动配置类，结合条件注解（@Conditional）按需加载 Bean，还可通过 @ConfigurationProperties 绑定配置 。

详细实现步骤 + 示例（以“自定义一个工具类 Starter，实现字符串加前缀功能”为例 ）

一、创建 Maven 模块（2 个模块结构，也可合并为 1 个，规范推荐拆分 ）

• xxx-spring-boot-autoconfigure：负责自动配置逻辑（核心）
• xxx-spring-boot-starter：负责依赖管理（引入 autoconfigure 及相关依赖，让使用者只需引 starter 即可 ）

二、编写 autoconfigure 模块（以 Maven 项目为例 ）

1. 添加依赖（pom.xml）：引入 Spring Boot 自动配置基础依赖

<dependencies><!-- Spring Boot 自动配置核心 --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-autoconfigure</artifactId></dependency><!-- 配置属性提示（可选，让 application.yml 有配置提示） --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-configuration-processor</artifactId><optional>true</optional></dependency>
</dependencies>

2. 定义配置属性类（PrefixProperties.java）：绑定 application.yml 配置

import org.springframework.boot.context.properties.ConfigurationProperties;
// 前缀，配置时用 "custom.prefix" 开头
@ConfigurationProperties(prefix = "custom.prefix") 
public class PrefixProperties {// 默认前缀，可通过配置覆盖private String value = "DEFAULT_"; public String getValue() { return value; }public void setValue(String value) { this.value = value; }
}

3. 定义功能类（PrefixService.java）：实现业务逻辑

public class PrefixService {private final String prefix;public PrefixService(String prefix) { this.prefix = prefix; }// 核心功能：给字符串加前缀public String addPrefix(String content) {return prefix + content;}
}

4. 编写自动配置类（PrefixAutoConfiguration.java）：控制 Bean 加载条件 + 注册 Bean

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration // 标记为配置类
// 确保 PrefixService 类在类路径中（引入 starter 就会包含，所以可触发）
@ConditionalOnClass(PrefixService.class) 
// 启用配置属性绑定，关联 PrefixProperties
@EnableConfigurationProperties(PrefixProperties.class) 
public class PrefixAutoConfiguration {@Autowiredprivate PrefixProperties properties;// 当容器中没有 PrefixService Bean 时，才创建（支持用户自定义覆盖）@ConditionalOnMissingBean(PrefixService.class) @Beanpublic PrefixService prefixService() {// 使用配置属性的值初始化功能类return new PrefixService(properties.getValue()); }
}

5. 配置自动配置入口（Spring Boot 2.x 用 spring.factories；3.x+ 推荐 AutoConfiguration.imports ）

• 方式 1（兼容旧版）：在 src/main/resources/META-INF/spring.factories 中添加

# 关联自动配置类，让 Spring Boot 启动时扫描
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.custom.PrefixAutoConfiguration

• 方式 2（Spring Boot 3.x+ 推荐）：在 src/main/resources/META-INF/spring/AutoConfiguration.imports 中直接写类名

com.example.custom.PrefixAutoConfiguration

三、编写 starter 模块（依赖管理 ）

1. 添加依赖（pom.xml）：引入 autoconfigure 模块 + 必要依赖

<dependencies><!-- 引入自动配置模块 --><dependency><groupId>com.example</groupId><artifactId>custom-spring-boot-autoconfigure</artifactId><version>1.0.0</version></dependency><!-- 继承 Spring Boot 基础依赖（可选，让 starter 更完整） --><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter</artifactId></dependency>
</dependencies>

四、打包发布

• 分别对 autoconfigure 和 starter 模块执行 mvn clean install，发布到本地 Maven 仓库（或私服 ）

五、测试自定义 Starter

1. 新建 Spring Boot 项目，引入自定义 Starter 依赖：

<dependency><groupId>com.example</groupId><artifactId>custom-spring-boot-starter</artifactId><version>1.0.0</version>
</dependency>

2. 配置 application.yml（可选，覆盖默认前缀 ）：

custom:prefix:value: "CUSTOM_" # 自定义前缀，不配置则用默认 "DEFAULT_"

3. 编写测试类（注入 PrefixService 并使用 ）：

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;@RestController
public class TestController {@Autowiredprivate PrefixService prefixService;@GetMapping("/test")public String test() {// 输出：CUSTOM_Hello（若配置了 prefix.value=CUSTOM_ ）return prefixService.addPrefix("Hello"); }
}

4. 启动项目，访问 /test，验证功能是否生效

核心要点总结

• 自动配置触发：通过 spring.factories 或 AutoConfiguration.imports 让 Spring Boot 发现配置类
• 条件控制：@ConditionalOnXxx 系列注解（如 @ConditionalOnClass、@ConditionalOnMissingBean ）决定配置是否生效，避免冲突
• 配置绑定：@ConfigurationProperties + @EnableConfigurationProperties 实现配置动态注入
• 依赖解耦：拆分 autoconfigure 和 starter，让依赖管理更清晰，符合 Spring Boot 生态规范

这样就完成了一个自定义 Starter 的开发，既体现了“约定优于配置”，又支持灵活扩展，面试中按此思路讲清 “封装通用功能→自动配置→条件加载→配置绑定” 逻辑，就能清晰展示对 Starter 的理解~