跳至主要內容

20. Spring Boot中的`starter`是什么？如何自定义一个`starter`？

PangHu大约 3 分钟

在 Spring Boot 中，starter 是一组 Maven 或 Gradle 依赖项的集合，旨在简化项目的依赖管理和配置。这些 starter 为特定的功能或技术栈提供了一站式的依赖和默认配置，因此开发者只需要添加一个 starter 依赖，即可获得所需的所有功能，而无需手动配置大量的依赖项和设置。

1.1 starter 的作用

  • 简化依赖管理：通过引入 starter，开发者可以避免手动引入多个依赖项并配置它们。这种方式不仅减少了配置的复杂性，还降低了版本冲突的风险。
  • 开箱即用：starter 通常包含了所需功能的所有依赖，并且提供了默认配置，使得开发者可以快速上手，无需进行大量的初始配置。

1.2 常见的 Spring Boot starter

  • spring-boot-starter-web：用于构建 Web 应用，包括 Spring MVC 和嵌入式 Tomcat 服务器。
  • spring-boot-starter-data-jpa：用于 JPA 持久化，包括 Hibernate 和 Spring Data JPA。
  • spring-boot-starter-security：用于集成 Spring Security，提供安全性功能。
  • spring-boot-starter-test：用于测试，包含 JUnit、Mockito 和 Spring Test 等常用测试库。

2. 如何自定义一个 starter

自定义 starter 是指为特定的功能或模块创建一个类似于 Spring Boot starter 的依赖项集合，这样你可以在多个项目中复用这些依赖和配置。

2.1 创建自定义 starter 的基本步骤

步骤 1：创建一个新的 Maven 或 Gradle 项目

创建一个新的 Maven 或 Gradle 项目，用于存放你的 starter 依赖和配置。

示例：

mvn archetype:generate -DgroupId=com.example -DartifactId=my-starter -DarchetypeArtifactId=maven-archetype-quickstart -DinteractiveMode=false

步骤 2：添加依赖项

在 pom.xml 或 build.gradle 文件中添加你的 starter 所需要的依赖项。

pom.xml 示例：

<dependencies>
    <!-- 例如，添加Spring Web和Thymeleaf作为依赖 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-thymeleaf</artifactId>
    </dependency>
</dependencies>

步骤 3：添加自动配置类（可选）

如果你的 starter 需要自动配置功能，可以创建一个 @Configuration 类，并使用 @ConditionalOnClass 等注解来控制配置的条件。然后将这个配置类注册到 META-INF/spring.factories 文件中。

示例配置类：

package com.example.mystarter;

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

@Configuration
public class MyStarterConfiguration {

    @Bean
    public MyService myService() {
        return new MyService();
    }
}

spring.factories 文件：

在 src/main/resources/META-INF/spring.factories 中注册自动配置类：

org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.mystarter.MyStarterConfiguration

步骤 4：打包发布

通过 Maven 或 Gradle 打包你的 starter 项目。可以发布到公司内部的私有仓库，或是公开的 Maven 中央仓库，供其他项目使用。

示例 Maven 打包命令：

mvn clean install

步骤 5：使用自定义 starter

在另一个 Spring Boot 项目中，添加你的 starter 依赖。

pom.xml 示例：

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

通过添加这个依赖，其他项目就可以自动获得你在 starter 中配置的所有功能和默认配置。

3. 总结

  • Spring Boot starter 是一种依赖管理的简化工具，通过将常用的依赖集合在一起，简化了配置过程，并提供开箱即用的功能。
  • 自定义 starter 可以将你常用的依赖和配置封装成一个模块，供多个项目复用，减少重复配置和依赖管理的工作。
  • 自定义 starter 的关键步骤包括：创建项目、添加依赖、配置自动配置类（如需要）、打包发布、以及在其他项目中引入使用。

通过这种方式，开发者可以更好地组织和管理项目的依赖和配置，提升开发效率。