【SpringBoot】Java高频面试题-SpringBoot如何自定义Starter

Java高频面试题-SpringBoot如何自定义Starter

一、核心答案

自定义Starter的本质是将一组相关的依赖、配置和自动装配逻辑打包成一个可重用的模块，让其他项目通过引入一个依赖就能获得开箱即用的功能，是SpringBoot「约定优于配置」思想的核心体现。

自定义Starter核心步骤可概括为5步：

1. 创建独立的Maven/Gradle模块

2. 定义配置属性类（@ConfigurationProperties）

3. 编写核心业务功能类

4. 编写自动配置类（@Configuration + @ConditionalOnXxx条件注解）

5. 注册自动配置类（新版AutoConfiguration.imports / 旧版spring.factories）

二、详细步骤与原理（以自定义短信Starter为例）

第一步：创建项目 & 引入依赖

创建普通Maven项目，严格遵循社区命名规范：xxx-spring-boot-starter，本次示例项目名：my-sms-spring-boot-starter。

pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project ...>
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.example</groupId>
    <artifactId>my-sms-spring-boot-starter</artifactId>
    <version>1.0.0</version>

    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.1.0</version> 
        <relativePath/>
    </parent>

    <dependencies>
        <!-- 核心依赖：自动配置的基石 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!-- 用于处理 @ConfigurationProperties 配置绑定 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional> 
        </dependency>
    </dependencies>
</project>

第二步：定义配置属性类

核心作用：绑定application.yml/application.properties自定义配置，实现Starter可配置化，必须提供getter/setter方法，否则配置无法绑定。

package com.example.sms.config;

import org.springframework.boot.context.properties.ConfigurationProperties;

/**
 * 绑定配置文件中 `sms` 前缀的所有属性
 */
@ConfigurationProperties(prefix = "sms")
public class SmsProperties {

    /**
     * 访问密钥 ID
     */
    private String accessKeyId;

    /**
     * 访问密钥 Secret
     */
    private String accessKeySecret;

    /**
     * 短信签名
     */
    private String signName;

    // 必须提供 Getter、Setter 方法
    public String getAccessKeyId() {
        return accessKeyId;
    }

    public void setAccessKeyId(String accessKeyId) {
        this.accessKeyId = accessKeyId;
    }

    public String getAccessKeySecret() {
        return accessKeySecret;
    }

    public void setAccessKeySecret(String accessKeySecret) {
        this.accessKeySecret = accessKeySecret;
    }

    public String getSignName() {
        return signName;
    }

    public void setSignName(String signName) {
        this.signName = signName;
    }
}

第三步：编写业务服务类

Starter核心功能实现类，封装具体业务逻辑，通过构造器注入配置参数。

package com.example.sms.service;

public class SmsService {

    private final String accessKeyId;
    private final String accessKeySecret;
    private final String signName;

    // 构造器注入配置属性
    public SmsService(String accessKeyId, String accessKeySecret, String signName) {
        this.accessKeyId = accessKeyId;
        this.accessKeySecret = accessKeySecret;
        this.signName = signName;
        // 可初始化第三方短信SDK客户端
    }

    /**
     * 发送短信核心方法
     * @param phoneNumber 手机号
     * @param templateCode 模板CODE
     * @param data 模板参数
     * @return 是否发送成功
     */
    public boolean send(String phoneNumber, String templateCode, String data) {
        // 对接阿里云、腾讯云等短信SDK的核心逻辑
        System.out.println("发送短信至: " + phoneNumber + ", 使用模板: " + templateCode);
        // 模拟发送成功
        return true;
    }
}

第四步：编写自动配置类（核心）

整个Starter的核心中枢，通过各类条件注解实现按需自动装配Bean，保证灵活性和可扩展性。

package com.example.sms.autoconfigure;

import com.example.sms.config.SmsProperties;
import com.example.sms.service.SmsService;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * 短信服务自动配置类
 */
@Configuration // 标识为配置类
@EnableConfigurationProperties(SmsProperties.class) // 开启配置属性绑定，注入配置类
@ConditionalOnClass(SmsService.class) // 类路径存在 SmsService 时，配置才生效
@ConditionalOnProperty(prefix = "sms", value = "enabled", havingValue = "true", matchIfMissing = true) 
// 配置文件sms.enabled=true生效，默认开启
public class SmsAutoConfiguration {

    /**
     * 自动注册SmsService Bean
     * @param smsProperties 自动注入配置参数
     * @return 业务实例
     */
    @Bean
    @ConditionalOnMissingBean // 用户未自定义SmsService Bean时，才自动创建（支持用户覆盖）
    public SmsService smsService(SmsProperties smsProperties) {
        return new SmsService(
                smsProperties.getAccessKeyId(),
                smsProperties.getAccessKeySecret(),
                smsProperties.getSignName()
        );
    }
}

第五步：注册自动配置类（关键步骤）

让SpringBoot启动时扫描并加载自定义自动配置类，分新旧两个版本，SpringBoot2.7+推荐新版写法。

方式一：新版注册方式（SpringBoot2.7+ 主流）

在 src/main/resources 下创建路径及文件：META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports

文件内容（自动配置类全限定类名）：

com.example.sms.autoconfigure.SmsAutoConfiguration

方式二：旧版注册方式（SpringBoot2.7之前）

在 src/main/resources 下创建文件：META-INF/spring.factories

文件内容：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\com.example.sms.autoconfigure.SmsAutoConfiguration

第六步：打包安装

执行Maven命令，将自定义Starter安装到本地仓库，供其他项目引用：

mvn clean install

三、自定义Starter使用方式

1. 引入依赖

在需要使用该功能的SpringBoot项目pom.xml中引入自定义依赖：

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

2. 配置参数

在application.yml中自定义业务配置，无需配置则使用默认规则：

sms:
  enabled: true # 默认true，可省略
  access-key-id: "your-access-key-id"
  access-key-secret: "your-secret"
  sign-name: "我的公司"

3. 直接注入使用

无需手动创建Bean，直接@Autowired注入，开箱即用：

@RestController
public class TestController {

    @Autowired
    private SmsService smsService;

    @GetMapping("/send-sms")
    public String sendSms() {
        boolean success = smsService.send("13800138000", "SMS_123456", "{\"code\":\"1234\"}");
        return success ? "发送成功" : "发送失败";
    }
}

四、满分面试答题技巧（结构化背诵版）

1. 核心思想

自定义Starter是SpringBoot「约定优于配置」思想的典型实现，核心是将通用功能的依赖、配置、装配逻辑封装为独立模块，实现一次封装、处处引用、开箱即用，大幅提升项目复用性和开发效率。

2. 核心实现步骤

首先创建独立Maven模块，遵循xxx-spring-boot-starter命名规范；然后通过@ConfigurationProperties定义配置类，实现外部配置绑定；接着编写核心业务功能类；再通过@Configuration配合@ConditionalOnXxx系列注解编写自动配置类，实现条件化装配；最后在指定配置文件中注册自动配置类，让SpringBoot启动时自动加载。

3. 关键亮点（面试加分）

自定义Starter核心精髓是条件装配：通过@ConditionalOnClass、@ConditionalOnProperty、@ConditionalOnMissingBean等注解，保证框架默认自动配置生效的同时，支持用户自定义Bean覆盖，兼顾自动化和灵活性。

4. 版本差异

SpringBoot2.7之后废弃了spring.factories，改用AutoConfiguration.imports文件注册自动配置类，是目前主流规范。