详解Spring的SPI机制和自定义Springboot的Starter包

以你之姓@ 2024-03-25 23:04 27阅读 0赞

为了给组里的实习生妹妹讲如何自定义**Springboot**的**Starter**，

我觉得需要让她先知道**Springboot**的自动装配机制，

但又感觉是不是得先让她了解**Spring**的**SPI**机制，

最后又觉得还有必要说明一下一个@**Configuration**配置类在**Spring**中如何被解析，这又会引出对**ConfigurationClassPostProcessor**的讲解，

完了，收不住了，到处都是知识盲区。

知识盲区脑图如下。

![format_png][]

--------------------

### 前言 ###

本文会先对**JDK**的**SPI**机制和**Spring**的**SPI**机制进行说明和演示，最后演示如何自定义**Springboot**的**starter**。

**Springboot**版本：**2.4.1**

### 正文 ###

#### 一. JDK-SPI机制 ####

**SPI**全称为**Service Provider Interface**，是指在模块装配的时候动态加载接口的实现类的一种机制。使用**JDK-SPI**的规则如下所示。

*  服务提供模块提供了接口的具体实现后，需要在服务提供模块的**jar**包的**META-INF/services**目录下创建一个配置文件，配置文件名为接口的全限定名，文件内容为当前**jar**包中接口的实现类的全限定名；
 *  服务提供模块的**jar**包需要在主程序的**classpath**下；
 *  在主程序中，通过**java.util.ServiceLoader**的**load(接口.class)** 方法来加载接口的实现类，实现方式就是遍历**classpath**下每个**jar**包中的**META-INF/services**目录下的配置文件，通过配置文件中的接口实现类的全限定名加载接口实现类；
 *  接口实现类必须有无参构造方法。

下面是一个具体示例。

定义接口和实现类，如下所示。

public interface MyApi {}
    
    public class MyController implements MyApi {}
    
    public class MyService implements MyApi {}
    
    public class MyDao implements MyApi {}
    复制代码

在**META-INF/services**目录下创建配置文件，配置文件名为`com.learn.spi.jdkspi.MyApi`，内容如下所示。

com.learn.spi.jdkspi.MyController
    com.lear

[format_png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/25/01761affe1fd4ede9857399d0f7aa86d.png