Spring Boot Starter 是什么
基于 Spring Boot Starters 总结
推荐阅读：
@Configuration 和 @AutoConfiguration 的区别
@ConfigurationProperties 和 @EnableConfigurationProperties 的作用
Spring Boot Starter 是在 Spring Boot 组件中被提出来的一种概念，StackOverflow 上面已经有人概括了这个 Starter 是什么东西，想看完整的回答戳这里。
Starter POMs are a set of convenient dependency descriptors that you can include in your application. You get a one-stop-shop for all the Spring and related technology that you need, without having to hunt through sample code and copy paste loads of dependency descriptors. For example, if you want to get started using Spring and JPA for database access, just include the spring-boot-starter-data-jpa dependency in your project, and you are good to go.
大概意思就是说 Starter 是一种对依赖的 synthesize（合成），这是什么意思呢？举个例子。
传统的做法
在没有 Starter 之前，假如我想要在 Spring 中使用 JPA，那我可能需要做以下操作：
- 在 Maven 中引入使用的数据库的依赖（即 JDBC 的 jar）
- 引入 JPA 的依赖
- 在 xxx.xml 中配置一些属性信息
- 反复的调试直到可以正常运行
需要注意的是，这里操作在我们每次新建一个需要用到 JPA 的项目的时候都需要重复的做一次。也许你在第一次自己建立项目的时候是在 Google 上自己搜索了一番，花了半天时间解决掉了各种奇怪的问题之后，JPA 终于能正常运行了。有些有经验的人会在 OneNote 上面把这次建立项目的过程给记录下来，包括操作的步骤以及需要用到的配置文件的内容，在下一次再创建 JPA 项目的时候，就不需要再次去 Google 了，只需要照着笔记来，之后再把所有的配置文件 copy&paste 就可以了。
像上面这样的操作也不算不行，事实上我们在没有 Starter 之前都是这么干的，但是这样做有几个问题：
- 如果过程比较繁琐，这样一步步操作会增加出错的可能性
- 不停地 copy&paste 不符合 Don't repeat yourself 精神
- 在第一次配置的时候（尤其如果开发者比较小白），需要花费掉大量的时间
使用 Spring Boot Starter 提升效率
Starter 的主要目的就是为了解决上面的这些问题。
Starter 的理念：Starter 会把所有用到的依赖都给包含进来，避免了开发者自己去引入依赖所带来的麻烦。需要注意的是不同的 Starter 是为了解决不同的依赖，所以它们内部的实现可能会有很大的差异。
Starter 的实现：虽然不同的 Starter 实现起来各有差异，但是他们基本上都会使用到两个相同的内容：ConfigurationProperties 和 AutoConfiguration。因为 Spring Boot 坚信“约定大于配置”这一理念，所以我们使用 ConfigurationProperties 来保存我们的配置，并且这些配置都可以有一个默认值，在我们没有主动覆写原始配置的情况下，默认值就会生效，这在很多情况下是非常有用的。除此之外，Starter 的 ConfigurationProperties 还使得所有的配置属性被聚集到一个文件中（一般在 resources 目录下的 application.properties），这样我们就告别了 Spring 项目中 XML 地狱。
Starter 的整体逻辑：
 |
上面的 Starter 依赖的 jar 和我们自己手动配置的时候依赖的 jar 并没有什么不同，所以我们可以认为 Starter 其实是把这一些繁琐的配置操作交给了自己，而把简单交给了用户。除了帮助用户去除了繁琐的配置操作，在“约定大于配置”的理念下，ConfigurationProperties 还帮助用户减少了无谓的配置操作。并且因为application.properties文件的存在，即使需要自定义配置，所有的配置也只需要在一个文件中进行，使用起来非常方便。
所以 Starter 帮助用户简化了配置，即我们可以给一个组件创建一个 Starter 来让最终用户在使用这个组件的时候更加的简单方便。基于这种理念，我们可以给任意一个现有的组件创建一个 Starter 来让别人在使用这个组件的时候更加的简单方便，事实上 Spring Boot 团队已经帮助现有大部分的流行的组件创建好了它们的 Starter，你可以在这里查看这些 Starter 的列表。
autoconfigure 和 Starter
如果打开 Spring Boot 官方提供的 Starter，会发现它是一个空的 jar 包，而且查看其 pom.xml 文件，会发现它里面通常包含有对应的 autoconfigure 的依赖。
Spring 官方建议，类库的配置、封装等工作，交给 autoconfigure 模块，最后 Starter 模块引入 autoconfigure 模块及其他所需的依赖，提供给使用者。也就是说 Starter 只用来做依赖管理，autoconfigure 模块才用来完成配置定义及初始化工作。
autoconfigure 模块通常包含一些 @Conditional 类型的注解，用以根据当前环境中的依赖情况，进行不同的初始化工作（也就是常说的“自动配置”）。Starter 的作用是引入 autoconfigure 模块，提供 autoconfigure 完成某种初始化所需要的依赖，以使 autoconfigure 模块完成指定初始化工作。可以把 Starter 理解为一个告诉系统“要使用这个组件，那么这个组件需要哪些依赖”的文件。
所以分开 autoconfigure 和 Starter 的一个好处是，一个较复杂的 autoconfigure 模块，能够通过创建不同的 Starter 引入不同的依赖，来达到不同的初始化效果。使用者只需要根据需要引入对应的 Starter 就可以了。
当然，如果 autoconfigure 模块较简单的话，那么没必要拆分 autoconfigure 和 Starter。
创建自己的 Spring Boot Starter
创建一个 Starter 基本包含以下几步（不拆分 autoconfigure 和 Starter）：
- 创建一个 Starter 项目，关于项目的命名你可以参考这里[1]
- 创建一个 ConfigurationProperties 用于保存你的配置信息（如果你的项目不使用配置信息则可以跳过这一步，不过通常都会有配置信息）
- 创建一个 AutoConfiguration，引用定义好的配置信息；在 AutoConfiguration 中实现所有 Starter 应该完成的操作，并且把这个类的全类名加入 org.springframework.boot.autoconfigure.AutoConfiguration.imports 和 spring.factories 文件中
- 打包项目，之后在一个 Spring Boot 项目中引入该项目依赖，然后就可以使用该 Starter 了
我们来看一个例子。
首先新建一个 Maven 项目，设置pom.xml文件如下：
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.example</groupId>
<artifactId>http-spring-boot-starter</artifactId>
<version>1.0-SNAPSHOT</version>
<properties>
<maven.compiler.source>8</maven.compiler.source>
<maven.compiler.target>8</maven.compiler.target>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
</properties>
<dependencies>
<!-- 自定义 Starter 依赖此 jar 包 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<!-- 生成 spring-configuration-metadata.json（配置元数据）方便 IDE 给出提示 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<!-- lombok 用于自动生成 get、set 方法 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<scope>provided</scope>
<optional>true</optional>
</dependency>
</dependencies>
<dependencyManagement>
<!-- 依赖版本管理 -->
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-dependencies</artifactId>
<version>2.7.15</version>
<type>pom</type>
<scope>import</scope>
</dependency>
</dependencies>
</dependencyManagement>
</project>
注意：应该尽可能减少传递不必要的依赖到用到该 Starter 的项目中，尤其是在拆分 autoconfigure 和 Starter 模块的情况下，autoconfigure 中的依赖通常应该标记为 optional。毕竟 autoconfigure 本身就是用来实现“自动”配置的，也就是根据当前项目的依赖情况来完成配置，所以依赖的引入应该交给 Starter 或者使用者来处理。
创建 properties 类来保存配置信息：
@Setter
@Getter
@ConfigurationProperties(prefix = "http") // 自动获取配置文件中前缀为 http 的属性，把值传入对象参数
public class HttpProperties {
// 如果配置文件中配置了 http.url 属性，则该默认属性会被覆盖
private String url = "http://www.baidu.com/";
}
上面这个类就是定义了一个属性，其默认值是http://www.baidu.com/，我们可以通过在application.properties中添加配置http.url=https://www.zhihu.com来覆盖参数的值。
创建业务类：
@Setter
@Getter
public class HttpClient {
private String url;
// 根据 url 获取网页数据
public String getHtml() {
try {
URL url = new URL(this.url);
URLConnection urlConnection = url.openConnection();
BufferedReader br = new BufferedReader(new InputStreamReader(urlConnection.getInputStream(), "utf-8"));
String line = null;
StringBuilder sb = new StringBuilder();
while ((line = br.readLine()) != null) {
sb.append(line).append("\n");
}
return sb.toString();
} catch (Exception e) {
e.printStackTrace();
}
return "error";
}
}
这个业务类的操作非常简单，只包含了一个url属性和一个getHtml方法，用于获取一个网页的 HTML 数据。
创建 AutoConfiguration：
@AutoConfiguration
@EnableConfigurationProperties(HttpProperties.class)
public class HttpAutoConfiguration {
@Resource
private HttpProperties properties; // 使用配置
// 在 Spring 上下文中创建一个对象
@Bean
@ConditionalOnMissingBean
public HttpClient init() {
HttpClient client = new HttpClient();
String url = properties.getUrl();
client.setUrl(url);
return client;
}
}
在上面的 AutoConfiguration 中我们创建了一个 HttpClient 类的 bean，并且我们把 properties 中的一个参数赋给了该 bean。
关于@ConditionalOnMissingBean这个注解，它的意思是在该 bean 不存在的情况下此方法才会执行，这类注解是实现“自动配置”的关键，更多 @Conditional 系列的注解可以参考这里。
最后，我们在resources文件夹下新建目录META-INF/spring，在目录中新建org.springframework.boot.autoconfigure.AutoConfiguration.imports文件，并且在文件中配置 AutoConfiguration（如果有多个 AutoConfiguration 类，每行一个）：
com.example.starter.HttpAutoConfiguration
在 Spring Boot 2.7 之前，需要配置spring.factories文件，为了提升 Starter 的兼容性，我们同样建立一个spring.factories文件（在META-INF目录下），内容如下（如果有多个 AutoConfiguration 类，逗号分割）：
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.example.starter.HttpAutoConfiguration
到此，我们的 Starter 已经创建完毕了，使用 Maven 打包该项目。之后创建一个 Spring Boot 项目，在项目中添加我们之前打包的 Starter 作为依赖，然后测试使用 Starter 提供的功能，代码如下：
@SpringBootTest
class HttpSpringBootStarterTestApplicationTests {
@Resource
private HttpClient httpClient;
@Test
void contextLoads() {
System.out.println(httpClient.getHtml());
}
}
正常情况下此方法的执行会打印出 url http://www.baidu.com/的 HTML 内容，之后我们在 application.properties 中加入配置：
http.url=https://www.zhihu.com/
再次运行程序，此时打印的结果应该是知乎首页的 HTML 了，证明 properties 中的数据确实被覆盖了。
参考：
Creating Your Own Auto-configuration :: Spring Boot
SpringBoot 的 starter 到底是什么
SpringBoot3.x 自定义封装 starter 实战
Spring Boot 2.7 正式发布，一大波新特性
Spring Boot 2.7 Release Notes
使用 spring-boot-configuration-processor 生成配置文件说明
假设要建一个对象存储（oss）的 Starter，不拆分 autoconfigure 和 Starter 的情况下命名为
oss-spring-boot-starter。如果拆分，autoconfigure 模块命名为oss-spring-boot-autoconfigure，Starter 模块命名为oss-spring-boot-starter。 ↩︎
