Spring Boot Starter 详解与实战：手把手自定义 Starter

Spring Boot Starter 是 Spring Boot 提供的一种模块化机制，它通过自动装配让开发者能够更轻松地集成特定功能。例如，spring-boot-starter-web 让我们可以快速构建 Web 应用，而 spring-boot-starter-data-jpa 让 JPA 的集成变得简单。

本篇文章将深入剖析 Spring Boot Starter 的原理，并 手把手教你自定义一个 Starter，让你的 Spring Boot 项目更具扩展性！

1. 什么是 Spring Boot Starter？

1.1 Starter 的作用

在传统 Spring 项目中，如果我们想使用 Spring + MyBatis + Druid 连接池，通常需要手动添加多个依赖，并编写相关配置：

<dependency>
    <groupId>org.mybatis</groupId>
    <artifactId>mybatis</artifactId>
    <version>3.5.9</version>
</dependency>

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>druid</artifactId>
    <version>1.2.8</version>
</dependency>

然后还要写 DataSource 配置类、MyBatis 配置等。

而 Spring Boot Starter 的作用就是把这些繁琐的配置封装起来，让开发者只需要引入一个 Starter 依赖，即可自动装配所有组件。例如，使用 spring-boot-starter-data-jpa 只需这样：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>

无需手动配置 DataSource，Spring Boot 会自动装配数据库相关的 Bean，大大减少了开发成本。

2. Starter 的底层原理

2.1 Starter 由哪些部分组成？

一个完整的 Spring Boot Starter 通常包含以下几个部分：

1. Starter 依赖（pom.xml）：定义需要引入的依赖项。
2. 自动配置类（Auto Configuration）：封装自动装配的逻辑。
3. Spring Boot 自动装配机制（spring.factories）：在 Spring Boot 启动时，加载自动配置类。

2.2 Spring Boot 如何加载 Starter？

Spring Boot Starter 的自动装配依赖 spring.factories 机制，它的底层原理是：

1. 通过 SpringFactoriesLoader 读取 META-INF/spring.factories 文件。
2. 获取 EnableAutoConfiguration 相关的配置类，并加载。
3. @ConditionalOnMissingBean 等条件注解确保按需装配。

3. 代码实战：自定义一个 Spring Boot Starter

假设我们要封装一个 HelloService，只要引入 hello-spring-boot-starter，Spring Boot 就会自动装配 HelloService，并提供一个 /hello 接口返回 “Hello, Spring Boot Starter!”.

3.1 创建 Starter 项目

创建一个 Maven 项目，命名为 hello-spring-boot-starter，目录结构如下：

hello-spring-boot-starter
│── src/main/java/com/example/hello
│   ├── HelloService.java
│   ├── HelloAutoConfiguration.java
│── src/main/resources/META-INF/spring.factories
│── pom.xml

3.2 编写 HelloService

首先，创建 HelloService 类，提供一个简单的 sayHello() 方法：

package com.example.hello;

public class HelloService {
    public String sayHello() {
        return "Hello, Spring Boot Starter!";
    }
}

3.3 创建自动装配类 HelloAutoConfiguration

自动装配类的作用是 在 Spring Boot 启动时自动创建 HelloService 的 Bean。

package com.example.hello;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class HelloAutoConfiguration {

    @Bean
    public HelloService helloService() {
        return new HelloService();
    }
}

3.4 配置 spring.factories

在 resources/META-INF/spring.factories 文件中，声明 HelloAutoConfiguration 为自动配置类：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.hello.HelloAutoConfiguration

3.5 打包发布 Starter

修改 pom.xml，让这个 Starter 作为一个独立的库供其他项目使用：

<groupId>com.example</groupId>
<artifactId>hello-spring-boot-starter</artifactId>
<version>1.0.0</version>
<packaging>jar</packaging>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-autoconfigure</artifactId>
        <scope>provided</scope>
    </dependency>
</dependencies>

然后运行：

mvn clean install

这样 hello-spring-boot-starter 就可以被其他 Spring Boot 项目使用了！

4. 在 Spring Boot 项目中使用自定义 Starter

创建一个新的 Spring Boot 项目，并在 pom.xml 中引入 hello-spring-boot-starter：

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

然后，在 Controller 中使用 HelloService：

@RestController
public class HelloController {

    @Autowired
    private HelloService helloService;

    @GetMapping("/hello")
    public String hello() {
        return helloService.sayHello();
    }
}

启动项目，访问 http://localhost:8080/hello，返回：

Hello, Spring Boot Starter!

至此，我们已经成功自定义了一个 Spring Boot Starter，并在实际项目中使用它！🎉

5. 进阶优化：添加 Starter 配置

我们可以增加 application.properties 配置支持，让用户自定义 HelloService 的返回值。

5.1 创建 HelloProperties

@ConfigurationProperties(prefix = "hello")
public class HelloProperties {
    private String message = "Hello, Spring Boot Starter!";

    public String getMessage() { return message; }
    public void setMessage(String message) { this.message = message; }
}

5.2 修改 HelloAutoConfiguration

@Configuration
@EnableConfigurationProperties(HelloProperties.class)
public class HelloAutoConfiguration {

    @Bean
    public HelloService helloService(HelloProperties properties) {
        return new HelloService(properties.getMessage());
    }
}

5.3 用户自定义配置

在 application.properties 中添加：

hello.message=Hello, Custom Starter!

这样，HelloService 就会根据配置文件动态调整返回值。

6. 总结

1. Spring Boot Starter 是一个模块化封装机制，让开发者能快速引入特定功能。
2. Starter 的核心包括：Starter 依赖（pom.xml）、自动配置类（@Configuration）、Spring Boot 自动装配机制（spring.factories）。
3. 我们可以通过 @EnableAutoConfiguration 和 spring.factories 机制，打造自己的 Starter，并让 Spring Boot 自动装配它。
4. Starter 还可以结合 @ConfigurationProperties，让用户自定义配置，提高灵活性。

你学会了吗？ 欢迎在评论区留言交流！🔥🚀