本文通过探析 JDK 提供的,在开源项目中比较常用的 Java SPI 机制,希望给大家在实际开发实践、学习开源项目提供参考。
一、SPI 是什么
SPI 全称 Service Provider Interface
,是 Java 提供的一套用来被第三方实现或者扩展的 API,它可以用来启用框架扩展和替换组件。整体机制图如下:
Java SPI 实际上是“基于接口的编程+策略模式+配置文件”组合实现的动态加载机制。
系统设计的各个抽象,往往有很多不同的实现方案,在面向的对象的设计里,一般推荐模块之间基于接口编程,模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类,就违反了可拔插的原则,如果需要替换一种实现,就需要修改代码。为了实现在模块装配的时候能不在程序里动态指明,这就需要一种服务发现机制。
Java SPI 就是提供这样的一个机制:为某个接口寻找服务实现的机制。有点类似 IOC 的思想,就是将装配的控制权移到程序之外,在模块化设计中这个机制尤其重要。所以 SPI 的核心思想就是解耦。
二、使用场景
概括地说,适用于:调用者根据实际使用需要,启用、扩展、或者替换框架的实现策略
比较常见的例子:
- 数据库驱动加载接口实现类:
JDBC
加载不同类型数据库的驱动 - 日志门面接口实现类加载:
SLF4J
加载不同提供商的日志实现类 - Spring:Spring 中大量使用了SPI,比如:对
servlet3.0
规范对ServletContainerInitializer
的实现、自动类型转换 Type Conversion SPI(Converter SPI、Formatter SPI)等 - Dubbo:Dubbo中也大量使用 SPI 的方式实现框架的扩展, 不过它对 Java 提供的原生SPI做了封装,允许用户扩展实现 Filter 接口
三、使用介绍
要使用 Java SPI,需要遵循如下约定:
- 当服务提供者提供了接口的一种具体实现后,在 jar 包的
META-INF/services
目录下创建一个以“接口全限定名”为命名的文件,内容为实现类的全限定名; - 接口实现类所在的 jar 包放在主程序的
classpath
中; - 主程序通过
java.util.ServiceLoder
动态装载实现模块,它通过扫描META-INF/services
目录下的配置文件找到实现类的全限定名,把类加载到 JVM; - SPI 的实现类必须携带一个不带参数的构造方法;
1、示例代码
(1)步骤一
定义一组接口 (假设是org.foo.demo.IShout
),并写出接口的一个或多个实现,(假设是org.foo.demo.animal.Dog
、org.foo.demo.animal.Cat
)。
public interface IShout {
void shout();
}
public class Cat implements IShout {
@Override
public void shout() {
System.out.println("miao miao");
}
}
public class Dog implements IShout {
@Override
public void shout() {
System.out.println("wang wang");
}
}
(2)步骤二
在 src/main/resources/
下建立 /META-INF/services
目录, 新增一个以接口命名的文件 (org.foo.demo.IShout
文件),内容是要应用的实现类(这里是org.foo.demo.animal.Dog
和org.foo.demo.animal.Cat
,每行一个类)。
#文件 src/main/resources/META-INF/services/org.foo.demo.IShout
org.foo.demo.animal.Dog
org.foo.demo.animal.Cat
(3)步骤三
使用ServiceLoader
来加载配置文件中指定的实现。
public class SPIMain {
public static void main(String[] args) {
ServiceLoader<IShout> shouts = ServiceLoader.load(IShout.class);
for (IShout s : shouts) {
s.shout();
}
}
}
代码输出:
wang wang
miao miao