SPI的高级用法

`SPI`机制相信很多人都了解过，这里就不赘述，今天我们讲一讲`SPI`的一些用法。

# 常规用法

`SPI`最常见的使用案例大概就是`JDBC驱动类`。早期的`JDBC`并不是采用`SPI`机制加载驱动类，而是需要用户显式加载驱动类（`Class.forName("com.mysql.jdbc.Driver")`或者在配置文件中指定驱动类名称），但在`JDBC4.0`后，不再需要用户显式指定驱动类，而是改为`SPI`方式自动加载驱动类（见`java.sql.DriverManager`的注释）。

![](/media/202108/2021-08-24_173113.png)

以MySQL为例，`mysql-connector-java-8.0.20.jar`中，原本的驱动类`com.mysql.jdbc.Driver`已经被废弃，采用了新的驱动类`com.mysql.cj.jdbc.Driver`。

![废弃驱动类](/media/202108/2021-08-24_174322.png)

![新驱动类](/media/202108/2021-08-24_174456.png)

在MySQL8.x的JAR包中，采用了SPI机制注册驱动类，如下图所示：

![SPI清单文件](/media/202108/2021-08-24_174640.png)

JDBC的`java.sql.DriverManager`类加载后调用`java.sql.DriverManager#loadInitialDrivers`使用SPI机制扫描注册的驱动类并加载驱动类。

![](/media/202108/2021-08-24_175242.png)

这是一种常见的SPI使用技巧，JDBC提供了统一的API和抽象接口，各个数据库厂商实现JDBC的接口，提供SPI清单文件，JDBC使用SPI机制扫描到注册类后，触发注册类类加载，厂商的驱动类使用`java.sql.DriverManager#registerDriver(java.sql.Driver)`方法将自身注册到JDBC驱动类列表中。

# 高级用法

最近在查看`cn.hutool.extra`包实现时，发现了另一种用法。

以汉字转拼音为例，市面上有很多的拼音库，例如：
- TinyPinyin
- JPinyin
- Pinyin4j

hutool采用了`自定义适配器 + SPI`实现自动引入拼音库：
- hutool定义了拼音库的门面接口(`PinyinEngine.class`)
- hutool为每个拼音库定义了实现类，实现了该门面接口
![](/media/202108/2021-08-18_154312.png)
- hutool在自己的项目中定义了spi描述文件
![](/media/202108/2021-08-18_154452.png)
- hutool使用SPI机制加载这些门面类，自动引入首个类加载成功的门面类
![](/media/202108/2021-08-18_154649.png)

这里最精华的部门在于使用了SPI的`懒加载机制`，根据SPI描述文件中的定义顺序依次尝试加载这些门面实现类，每个门面实现类中都分别引用了各自依赖的拼音库
**（在编译hutool时引入这些依赖库才能编译成功，用户使用hutool时，如果没有依赖这些库，且没有主动触发这些门面类的类加载，是不会触发异常的）**，如果用户没有引入对应的拼音库，当类加载加载这个门面类时就会触发异常。

> 小知识：Alibaba的fastjson，其代码经常被人调侃质量低，常见的调侃点：内部大量使用了`Class.forName(xxx)`的方式判断是否运行在某个框架中(比如其判断是否运行在`spring`环境时)。