面向接口编程？Service Provider Interface是什么Interface

刺骨的言语ヽ痛彻心扉 2023-09-25 19:53 128阅读 0赞

![format_png][]

#### 什么是SPI ####

> **Service provider interface** (**SPI**) is an API intended to be implemented or extended by a third party. It can be used to enable framework extension and replaceable components.

直译过来SPI是一个能被第三方继承或者实现的API，一般用于框架扩张或者可变组件。可能这个理解起来还是比较难，再找一个图来看看

![format_png 1][]

看起来好像比较简单一点了，但是对于我在刚接触SPI的时候还是比较难懂，所以我画了一个我觉得比较适合新手同学的图

![format_png 2][]

可以看到我用3个颜色来标注3个处理接口方，常规情况下，这3方一般是隶属于**3个组织**，或者1个组织的**3个部门**，转化成具体的代码就是这3方一般是属于**3个工程**的。

#### SPI实践 ####

有了以上的基础知识，接下来再用一个例子来加深大家的了解，大体的步骤如下：

1.  定义一个Interface规范
2.  有两个工程实现这个Interface
3.  再定义一个使用Interface的工程

具体的工程目录如下：

![format_png 3][]

接口定义方

整个模块啥也不干，单纯地定义一个接口

![format_png 4][]

接口实现方

**接口实现方**如果想实现上面定义的接口，第一步首先肯定是在pom文件中**引入`java-api-service` 这个模块**

![format_png 5][]

接着也是啥也不干，单纯地实现定义的接口即可，下面是**接口实现方1的代码**

![format_png 6][]

为了大家看得更清楚一点，我特意在一个接口实现方中定义了两个具体实现类

*  XxlServiceLoader
    
    ![format_png 7][]
 *  XxlOtherServiceLoader
    
    ![format_png 8][]

接口**实现方2的代码**也是类似的

![format_png 9][]

*  CuteyServiceLoader
    
    ![format_png 10][]

**注意：这两个接口实现方是隶属不同module，但是共同依赖了接口定义方**

但是实现了接口还不行，要想实现SPI还得有一个公共的约定配置文件，在META-INF目录下新建一个services目录，有些工程创建的时候可能没有META-INF，那就得在resource目录下先新建META-INF。接着在services目录中新增一个文本文件，**文件名为接口定义的全限定类名**，比如上面的例子实现的接口是`InterfaceService` ，那文本文件名称就必须是`com.cutey.none.spi.service.InterfaceService` 。**注意，这里的文本文件并不是指文件格式txt，而是单纯文本文件。**

文本文件的内容为具体实现类的全限定类名，针对上面的例子，不同实现的文本文件内容如下：

1.  接口实现方1
    
        com.cutey.none.spi.serviceloader.XxlOtherServiceLoader
        com.cutey.none.spi.serviceloader.XxlServiceLoader
        复制代码
2.  接口实现方2
    
        com.cutey.none.spi.serviceloader.CuteyServiceLoader
        复制代码

实际文件目录及内容如图

![format_png 11][]

接口使用方

有了以上接口定义和接口实现，接下来看看使用方是怎么使用的，首先使用方要使用这个接口，那肯定也是要依赖接口定义方，接着要使用具体的实现，那同样也需要依赖接口实现方。

![format_png 12][]

整个工程是比较简单的，里面只有一个类似Main的方法

![format_png 13][]

App类里面的内容如下，类里面的读取SPI是用`java.util.ServiceLoader`

![format_png 14][]

看下输出是什么

![format_png 15][]

可以看到在使用方中没有写任何接口实现的代码，仅仅是导入了2个依赖jar，就能使用依赖jar包中的具体实现，感兴趣的同学可以试试如果只依赖上述的单独1个jar会不会是你想的预期。

#### 工程中的SPI ####

上面用一个简单的例子帮大家快速体验了下什么是SPI，现在再来简单看看身边有哪些使用SPI的例子。由wikipedia可以看到有这些使用了SPI，接下来我们挑耳熟能详的数据库和spring.factories来看看。

![format_png 16][]

数据库

稍微熟悉一点的同学都知道以前是使用`Class.forName("com.mysql.cj.jdbc.Driver");` 去加载驱动类的。对于mysql而言mysql8更改了驱动类的包路径，然后引入了mysql8后发现代码跑不通了还专门去网上搜为什么。所以这种方式肯定是有弊端的，浅举3个

1.  需要手动编写驱动类地址，不管是硬编码还是配置文件的形式，都需要我们**在使用的时候编写驱动类全限定类名**
2.  更改驱动类不方便，需要找到定义的地方，然后再去替换
3.  当类名发生变化后需要使用方去适配，如果存在信息差那会导致程序运行不了

而在有了spi后，已经不用以上方式去加载驱动类了，而是使用`DriverManager.getConnection()` 去连接数据库，可以看到，连驱动类是啥都已经不关注了。当然，**无论哪种形式肯定都要引用数据库的jar包，这是大前提**。

由于这里不是讲SPI的原理，就不深究`DriverManager`里面干了啥，这里就贴一张图表明确实用到了spi，感兴趣的同学可以自行研究源码。

![format_png 17][]

为了让各位同学更简单直白的看到这个效果，咱新建一个工程，然后**pom文件中引入mysql和oracle的依赖**，编写个main方法去加载，看能不能取到两个数据库驱动类的全限定类名。

工程目录如下

![format_png 18][]

好不客气地说是啥都没有，然后增加Main类中的方法

![format_png 19][]

接着打断点进行代码调试，看下`providerNames`是不是真的有我们引入的依赖jar包了。

![format_png 20][]

具体怎么做到的呢，在最开始spi实践我们自己实现的时候就知道是在`src/main/resources/META-INF/services` 目录下有个以接口作为文件名的文本文件，那现在就**去mysql和oracle中的jar包中验证下**。

![format_png 21][]

可以看到确实如此，看到这里就能体会到一个最最最明显的好处，那就是哪怕以后mysql的**接口实现类发生了变化**，我们也**不用关注**，因为在它本身的jar包中就提供了驱动实现类的全限定类名。

spring.factories

写在前面，spring.factories是SpringBoot的特性，而非是Spring，然后是用于自动装配（目前我了解到的是只用于这个）。所谓自动装配，说得再简单，那就是**在不侵入式修改代码的情况下能够加载其他jar包内的bean**。

下面演示代码的整体概要：

*  有两个模块，java-spi-springboot-provider 和 java-spi-springboot
 *  前者包含Student的bean，后着包含Teacher的bean
 *  java-spi-springboot要使用java-spi-springboot-provider 里的bean
 *  两个bean所在的包路径不一样，Student的全限定类名为`com.xxl.cutey.none.javaspispringbootprovider.Student` ，Teacher的全限定类名为`com.cutey.none.xxl.javaspispringboot.Teacher`
 *  java-spi-springboot依赖java-spi-springboot-provider

整体的工程目录图如下

![format_png 22][]

各位小伙伴先别想着spring.factories，就正常情况下，我们是怎么使用别的jar包里面的bean的。也就是在非provider中使用Student这个bean，那首先必是要先加`@Component` 注解。

*  java-spi-springboot-provider
    
    新建一个Student类，然后在主启动类中读取这个bean
    
    ![format_png 23][]
    
    主启动类
    
    ![format_png 24][]
    
    注意，在主启动类和bean不在同一个包路径下的时候，是需要用scanBasePackage扫包才能把bean注入到IOC容器中。接下来看下输出，没问题。
    
    ![format_png 25][]
 *  java-spi-springboot
    
    新建一个Teacher和主启动类都和上面一样就不再赘述，现在是想用上面声明的bean，那就只有一个方法，修改scanBasePackages，要么是扫两个Bean的公共包，还记得吗，Student和Teacher我特意把全限定类名改得不懂；要么是具体写完这两个Bean的全限定类名。
    
    ![format_png 26][]
    
    看下输出，注意：如果Student的包名没写对，那肯定是获取不到Student的bean的，因为它是在别的jar包下面。
    
    ![format_png 27][]

问题来了，如果我想要再引别的组织的包呢，要知道在真实开发中，不同部门，不同组织，甚至不同公司之间相互引用实在是太正常了，难道每次引用一个都得这么加吗，这就引出了spring.factories。

我们改造的是java-spi-springboot-provider

![format_png 28][]

接下来我们再修改下java-spi-springboot中的包，把扫描的student的包去掉

![format_png 29][]

我们可以神奇的发现，还是能读取出来bean

![format_png 30][]

让我们浅浅看Spring用是不是真的用到了SPI

![format_png 31][]

诶，好像没看到跟数据库一样用到了jdk中的ServiceLoader呀，是不是骗你们了捏，其实不是，其实SpringFactoriesLoader就是类是jdk中的ServiceLoader。说白了，spring使用的SPI的思想，而SPI准确来说也不是一个接口，而是面向接口编程的其中一种思想，是接口使用方和接口定义方约定一种面向编程的思想。

[format_png]: https://img-blog.csdnimg.cn/img_convert/2a417642a23145c87776c845aa23dac3.webp?x-oss-process=image/format,png
[format_png 1]: https://img-blog.csdnimg.cn/img_convert/11b4a04b10386c09cf6a7142b99e888f.webp?x-oss-process=image/format,png
[format_png 2]: https://img-blog.csdnimg.cn/img_convert/6a25925a2b0662c158f1e2122e755428.webp?x-oss-process=image/format,png
[format_png 3]: https://img-blog.csdnimg.cn/img_convert/bf649daf8981dd3e2df09022288d2c6e.webp?x-oss-process=image/format,png
[format_png 4]: https://img-blog.csdnimg.cn/img_convert/c76d0d8fe21eed3f816b0c4d42bb0c0f.webp?x-oss-process=image/format,png
[format_png 5]: https://img-blog.csdnimg.cn/img_convert/219c86498019bba33db7edd62427c5cb.webp?x-oss-process=image/format,png
[format_png 6]: https://img-blog.csdnimg.cn/img_convert/0b58a77bcd157bafb50546e5ded018a0.webp?x-oss-process=image/format,png
[format_png 7]: https://img-blog.csdnimg.cn/img_convert/c5146caed20028e11ac653e9eea5e864.webp?x-oss-process=image/format,png
[format_png 8]: https://img-blog.csdnimg.cn/img_convert/25475416dc7c276645c360a3bb55ae4d.webp?x-oss-process=image/format,png
[format_png 9]: https://img-blog.csdnimg.cn/img_convert/462830b5ff2464ec9e98080ea78095a0.webp?x-oss-process=image/format,png
[format_png 10]: https://img-blog.csdnimg.cn/img_convert/520e5c184c9ed71d42dc74b9198562bd.webp?x-oss-process=image/format,png
[format_png 11]: https://img-blog.csdnimg.cn/img_convert/36d47ebf44a700e759243b60564e6026.webp?x-oss-process=image/format,png
[format_png 12]: https://img-blog.csdnimg.cn/img_convert/9a54e4329acef3ee3fe815989773c6da.webp?x-oss-process=image/format,png
[format_png 13]: https://img-blog.csdnimg.cn/img_convert/76fef38d5a74b85878c09c5184d79b4a.webp?x-oss-process=image/format,png
[format_png 14]: https://img-blog.csdnimg.cn/img_convert/bbd2a3ef8a94400a37f9914bfb4a4e44.webp?x-oss-process=image/format,png
[format_png 15]: https://img-blog.csdnimg.cn/img_convert/5eab3d973e92bc9a06e088b6719b2c7f.webp?x-oss-process=image/format,png
[format_png 16]: https://img-blog.csdnimg.cn/img_convert/44076eb06749fb1c558ccf7bfbb1f71b.webp?x-oss-process=image/format,png
[format_png 17]: https://img-blog.csdnimg.cn/img_convert/dc5186cbb99e250b1fa1f3b368b19bc0.webp?x-oss-process=image/format,png
[format_png 18]: https://img-blog.csdnimg.cn/img_convert/e2c8b2bf28b1754991fa0523592335bb.webp?x-oss-process=image/format,png
[format_png 19]: https://img-blog.csdnimg.cn/img_convert/c4783eacf4fbabf2f0030afb2f81809c.webp?x-oss-process=image/format,png
[format_png 20]: https://img-blog.csdnimg.cn/img_convert/d0a2ffe7a85497cf2adafbace27ed396.webp?x-oss-process=image/format,png
[format_png 21]: https://img-blog.csdnimg.cn/img_convert/187dbc111ba09dfd9797149f1d147338.webp?x-oss-process=image/format,png
[format_png 22]: https://img-blog.csdnimg.cn/img_convert/71e31a8c88df6651af1627355db6c91a.webp?x-oss-process=image/format,png
[format_png 23]: https://img-blog.csdnimg.cn/img_convert/cdb44e5ea0f0f3801de42a605903f10d.webp?x-oss-process=image/format,png
[format_png 24]: https://img-blog.csdnimg.cn/img_convert/e100dee595b0a1f705c7690c13c6462a.webp?x-oss-process=image/format,png
[format_png 25]: https://img-blog.csdnimg.cn/img_convert/b844d98de315a545ac72ae11a4711296.webp?x-oss-process=image/format,png
[format_png 26]: https://img-blog.csdnimg.cn/img_convert/da3c17a82fadda010af8a38195674311.webp?x-oss-process=image/format,png
[format_png 27]: https://img-blog.csdnimg.cn/img_convert/0558bdda00e86e00a12e48ff5e810b78.webp?x-oss-process=image/format,png
[format_png 28]: https://img-blog.csdnimg.cn/img_convert/c02fde8490e2a3c717b128be442f8176.webp?x-oss-process=image/format,png
[format_png 29]: https://img-blog.csdnimg.cn/img_convert/39144618978c5ab64abe8989510c3ed9.webp?x-oss-process=image/format,png
[format_png 30]: https://img-blog.csdnimg.cn/img_convert/fce975912ee64e1a215807759306a2b7.webp?x-oss-process=image/format,png
[format_png 31]: https://img-blog.csdnimg.cn/img_convert/5131e239bcb05567060fe2f6628b17ff.webp?x-oss-process=image/format,png