Starter场景启动器主要的作用就是了简化依赖和进行自动化的配置管理，通过封装自定义的模块或者是依赖库能够为其他项目提供方便的依赖引入来快速实现项目的构建以及使用。下面我们就来详细介绍一下SpringBoot3中如何来实现自定义的Starter场景启动器。

创建项目

创建父级依赖模块

首先创建一个名为my-starter的父级模块，这个模块主要是用来进行依赖的管理，不包含实际的执行代码，如下所示。

<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>my-starter</artifactId>
    <version>1.0.0</version>
    <packaging>pom</packaging>

    <modules>
        <module>my-starter-autoconfigure</module>
        <module>my-starter-spring-boot</module>
    </modules>
</project>

创建好父级模块之后，接下来创建自动配置模块信息，如下所示

创建自动配置模块

在这个模块中提供了自动配置的逻辑，如下所示。

<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>

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

    <artifactId>my-starter-autoconfigure</artifactId>

    <dependencies>
        <!-- Spring Boot Starter -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-autoconfigure</artifactId>
        </dependency>

        <!-- 让 Spring Boot 发现 Starter -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>
</project>

创建好模块拆分之后，接下来我们在com.example.mystarter.autoconfigure包路径下创建一个自定义的自动配置类 MyServiceAutoConfiguration，如下所示。

@Configuration
@ConditionalOnProperty(prefix = "my.service", name = "enabled", havingValue = "true", matchIfMissing = true)
public class MyServiceAutoConfiguration {

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

创建 MyService 类

创建一个自定义的测试服务类，如下所示。

package com.example.mystarter.autoconfigure;

public class MyService {
    public String hello() {
        return "Hello from MyService!";
    }
}

接下来就需要添加自动配置依赖管理。

创建spring.factories

这里需要注意，在Spring Boot3之后，推荐通过META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 进行自动配置导入，所以需要在 resources/META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 文件中添加对应的配置内容，如下所示。

com.example.mystarter.autoconfigure.MyServiceAutoConfiguration

创建Starter依赖模块

下面我们创建另一个模块用于提供一个 Spring Boot Starter 依赖，如下所示。

<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://www.w3.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

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

    <artifactId>my-starter-spring-boot</artifactId>

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

测试Starter

创建好另一个Spring Boot的Maven项目，然后再项目的POM文件中引入如下的依赖配置。

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

接下来在applicaiton.properties配置文件中提那家如下的配置来开启自定义的MyService的服务，如下所示。

my.service.enabled=true

这样就可以在Spring Boot项目中对自定义依赖配置进行测试了。如下所示。

import com.example.mystarter.autoconfigure.MyService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class MyApp implements CommandLineRunner {

    @Autowired
    private MyService myService;

    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }

    @Override
    public void run(String... args) throws Exception {
        System.out.println(myService.hello());
    }
}

项目启动之后，就会看到在控制台输出如下的内容。

Hello from MyService!

总结

到这里整个的依赖配置就算是配置完成了，如果在实际开发中需要提供属性配置支持可以通过@ConfigurationProperties让用户可以在application.yml中自定义参数，另外需要注意的是对于Maven私服的使用，有兴趣的读者可以深入进行了解。