spring-boot如何自行写一个starter并且使用

news2025/7/11 1:26:47

这里说的starter是pom中引入的一系列starter包，比如spring-boot-starter-web、mybatis-plus-boot-starter等。本文先已mybatis-spring-boot-starter的使用进行说明，然后得到使用的流程（套路），然后根据该流程，自行写一个strange-spring-boot-starter,然后进行使用。

一、为什么spring引入外部一个starter即可使用，不用关心第三方Bean的装配？

从注解入手理解springboot原理
可以回顾上一章知识点。为什么引入pom中引入第三方包，一个starter就完成其他的装载？
简单来说因为@SpringBootApplication中@EnableAutoConfiguration中@Import(AutoConfigurationImportSelector.class)注解寻找关于AutoConfigurationImportSelector类中的selectImports方法，该方法会去寻找spring.factories文件，找到该文件，找到对应的Key,就能够认识和装配的第三方类。然后这个值对应类的全路径，然后根据全路径去装配该类，完成一系列外部类IOC化。

在这里插入图片描述

二、mybits-starter说明一个starter使用流程

对应外部的中间件：
例如我们引入mybits。

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.3.2</version>
</dependency>

能够找到对应spring.factories文件，然后根据文件中的引导类MybatisAutoConfiguration，来自动装配对应的类。
在这里插入图片描述
那如何能够读取到配置文件中信息？
1、引导类MybatisAutoConfiguration中有该注解@EnableConfigurationProperties(MybatisProperties.class)，去实现yml或者properties配置文件读取。

2、然后根据前缀mybatis，可以读取到对应的value值。
在这里插入图片描述
3、配置数据源。@AutoConfigureAfter(DataSourceAutoConfiguration.class)注解中有spring.datasource一个前缀的ConfigurationProperties可以配置数据源。

三、总结如何使用一个starter

1、引入对应的依赖，例如mybits-starter。 2、xxxAutoConfiguration用来引导相应的Bean进行装载。
为什么是xxxAutoConfiguration?
原因：@EnableAutoConfiguration会找到spring.factories，然后根据org.springframework.boot.autoconfigure.EnableAutoConfiguration找到需要装载的引导类。
3、如何在配置文件配置属性。
使用@EnableConfigurationProperties(MybatisProperties.class)注解进行读取配置。
4、有时候还需要再引导类加上中间件的注解。
SpringApplication.run(）——>步骤：解析当前类上的所有注解——>中间件 IOC（有些中间件是没有starter的，需要通过注解告诉spring进行加载到容器中）。

四、如何手写一个starter

官方的starter格式：spring-boot-starter-*。
官方没有纳入的中间件格式或者自己开发：thirdpartproject-spring-starter。
例如mybatis-spring-boot-starter就不是spring-boot官方开发的。
自行写一个strange-spring-boot-starter,然后进行使用。

1、创建一个maven工程

在这里插入图片描述

2、pom引入spring-boot-starter-parent和spring-boot-autoconfigure

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.4.0</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<dependencies>
    <!--自动化配置依赖，自定义starter核心依赖包-->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-autoconfigure</artifactId>
    </dependency>
</dependencies>

3、项目结构

TcProperties获取项目配置文件属性。
TcAutoConfiguration为引导类，给到其他项目中spring.factories写入作为引导类，然后会创建所需的Bean。
Itc为一个接口，ItcImpl实现该接口，然后打印出tcProperties.name +",欢迎来到spring-boot自定义starter"作为业务或逻辑代码。
spring.factories配置引导类。

在这里插入图片描述

3.1 TcProperties获取配置文件属性

spring.tc为前缀，可以在项目配置文件配置该前缀，读取对应的vaule。默认为strange bug。当这个starter写好后，先默认打印当前值，然后再配置文件中配置，打印出配置的值。

/**
 * @Author taochui
 * @Description: 获取配置文件属性，如果没有则为默认值
 * @Date： 2022/12/13 1:56
 */
@ConfigurationProperties(prefix = "spring.tc")
public class TcProperties {
    String name = "strange bug";


    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

}

3.2 Itc 写一个接口进行测试

/**

@Author taochui
@Description: 写一个接口进行测试
@Date： 2022/12/13 1:42
*/
public interface Itc {
void welcome();
}

3.3 ItcImpl 实现Itc接口

/**
 * @Author taochui
 * @Description: 实现Itc接口，然后打印出配置文件中信息
 * @Date： 2022/12/13 1:44
 */
public class ItcImpl implements Itc {
    @Autowired
    private TcProperties tcProperties;
    @Override
    public void welcome() {
        System.out.println(tcProperties.name + ",欢迎来到spring-boot自定义starter");
    }
}

3.4 TcAutoConfiguration 项目初始化就能够自动装配

/**
 * @Author taochui
 * @Description: 项目初始化就能够自动装配，starter引导类TcAutoConfiguration
 * 交给spring.factories 中org.springframework.boot.autoconfigure.EnableAutoConfiguration
 * 项目启动，就能够加载该引导类
 * @Date： 2022/12/13 1:46
 */
@Configuration
@ConditionalOnClass(Itc.class) //条件：当存在Itc类时才会使标有该注解的类或方法生效
@EnableConfigurationProperties(TcProperties.class)
public class TcAutoConfiguration {

    @Bean
    @ConditionalOnMissingBean //IOC容器不存在该Bean才创建
    public Itc tc(){
        return new ItcImpl();
    }

}

3.5 spring.factories文件引导类

# Auto Configure
org.springframework.boot.autoconfigure.EnableAutoConfiguration=\
com.tc.TcAutoConfiguration

3.6 打成jar包，至此一个简单的starter开发完成。

五、如何使用自行开发的starter

1、maven中引入，可以找到该starter中pom，项目的说明。例如我的是：

   <groupId>com.tc</groupId>
    <artifactId>strange-spring-boot-starter</artifactId>
    <version>1.0-SNAPSHOT</version>

把该pom放到其他的spring-boot项目中，成功后可以在左边的Maven中找到该包，实例：
在这里插入图片描述
2、TrainApplication中实现ApplicationRunner，重写一下run方法，注入自行写的类，进行打印。

@SpringBootApplication(exclude = DataSourceAutoConfiguration.class) //排除掉数据库自动加载
public class TrainApplication implements ApplicationRunner {

    @Autowired
    private Itc itc;

    public static void main(String[] args) {
        SpringApplication.run(TrainApplication.class, args);
        System.out.println("******************************启动springBoot******************************");
    }

    @Override
    public void run(ApplicationArguments args) throws Exception {
        System.out.println("启动时执行");
       itc.welcome();

    }
}

3、默认未进行yml文件配置，运行。打印结果和上面默认的strange bug一直，打印出strange bug,欢迎来到spring-boot自定义starter。
在这里插入图片描述
4、配置文件中加入配置，如下，修改name为starter。运行，打印结果为starter,欢迎来到spring-boot自定义starter。说明已经完成配置文件value的读取。