Java中必须理解的SPI机制

本文首发于 程序员溪言 微信公众号
链接：https://mp.weixin.qq.com/s/X9WgNv7Dl39VW29mkf_v1Q

目录：
一、是什么？
二、有什么用（优缺点）?
三、怎么用？
四、源码分析

---

一、是什么？

SPI全称：服务提供接口（Service Provider Interface）
是一种 JDK 内置的服务发现机制。将服务接口和服务实现分离以达到解耦的目的，提升程序的可扩展性。

SPI机制在框架中有大量的应用，如JDBC数据库驱动包、SpingBoot相关starter组件源码等。

在面向对象的设计思想中，模块之间的对接，我们更多的是面向接口的编程，而不是直接操作实现类，一旦代码中实现类的耦合度太高，就违反了可插拔原则，维护代码成本极高。而SPI技术正好弥补这一缺点，实现了代码之间的解耦，可拔插原则。

二、有什么用（优缺点）？

• 优点：

  1. 实现代码的解耦，使得接口的定义与具体的业务实现分离，轻松可拔插；

  2. 通过SPI的方式，第三方服务模块实现接口后，在第三方的项目代码的META-INF/services目录下的配置文件指定实现类的全路径名，即可找到实现类;

  3. 可以不用像硬编码一样，import导入实现类。

• 缺点：

  1. 获取实现类的方式不够灵活，基本上只能通过Iterator遍历全部获取，意味着接口的所有实现类全部实例化一遍，就是不使用的实现类也会被实例化，这就使得资源浪费了；

  2. 一般使用ServiceLoader 加载实现类，多个并发多线程使用 ServiceLoader 类的实例是不安全的。

三、怎么用？

1）使用导图及流程

image

1. 接口、实现类的编写

   • 定义一个服务（由接口或者抽象类表示）
   • 多个实现类实现被定义的服务

2. 配置文件的编写

   • 在资源目录（resources）下创建META-INF/services
   • 在META-INF/services目录下放置配置文件
     • 配置文件名为被实现接口的全限定名
     • 文件中写入接口实现类的全限定名
     • 设置文件为UTF-8编码

3. spi机制的使用

   • ServiceLoader<接口名> serviceLoader = ServiceLoader.load(接口名.class)

2）使用示例

1、我们需要在项目中创建目录META-INF\services；

2、定义一个接口服务提供，如: SpiTestDemo；

public interface SpiTestDemo {
 
    void way1();
 
    void way2();
 
}

3、分别定义两个服务接口实现类，如:SpiTestDemoImpl1，SpiTestDemoImpl2；

public class SpiTestDemoImpl1 implements SpiTestDemo {
    @Override
    public void way1() {
        System.out.println("SpiTestDemoImpl1------way1");
    }
 
    @Override
    public void way2() {
        System.out.println("SpiTestDemoImpl1------way2");
    }
}
 
 
public class SpiTestDemoImpl2 implements SpiTestDemo {
    @Override
    public void way1() {
        System.out.println("SpiTestDemoImpl2------way1");
    }
 
    @Override
    public void way2() {
        System.out.println("SpiTestDemoImpl2------way2");
    }
}

4、我们需要在META-INF/services目录下创建一个以接口的全限定名命名的文件

com.example.spitestdemo.SpiTestDemo

image

文件的内容为接口实现类的全限定名，如：

com.example.spitestdemo.SpiTestDemoImpl1
com.example.spitestdemo.SpiTestDemoImpl2

5、测试使用spi机制的结果

@SpringBootTest
class SpitestdemoApplicationTests {
 
    @Test
    public void testWay(){
        ServiceLoader serviceLoader = ServiceLoader.load(SpiTestDemo.class);
        for(SpiTestDemo spiTestDemo : serviceLoader){
            spiTestDemo.way1();
            spiTestDemo.way2();
        }
    }
 
}

输出结果：

image

注：为什么配置文件是要放在META-INF/services，原因是ServiceLoader默认是加载该目录下文件

image

四、源码分析

这里就拿最熟悉的mysql jar包中jdbc加载驱动这一步骤源码简单分析其结构。

1. 查看源码，可以知道mysql的jar包中就能显示整个spi机制的所有的配置文件及源码。

2. 在连接数据库的时候，第一步加载驱动，就是使用spi机制，spi机制会自动找到相关的驱动实现，如下图完整结构

image

3. 而这个接口服务是在jdk中

image

4. 初始化加载主要是通过ServiceLoader来实现服务查找

image