JDK源码解析之Java的SPI机制
1. spi 是什么
SPI全称Service Provider Interface，是Java提供的一套用来被第三方实现或者扩展的API，它可以用来启用框架扩展和替换组件。
系统设计的各个抽象，往往有很多不同的实现方案，在面向的对象的设计里，一般推荐模块之间基于接口编程，模块之间不对实现类进行硬编码。一旦代码里涉及具体的实现类，就违反了开闭原则，Java SPI就是为某个接口寻找服务实现的机制，Java Spi的核心思想就是解耦。
整体机制图如下：
Java SPI 实际上是“基于接口的编程＋策略模式＋配置文件”组合实现的动态加载机制。
总结起来就是：调用者根据实际使用需要，启用、扩展、或者替换框架的实现策略
2. 应用场景
-
数据库驱动加载接口实现类的加载
JDBC加载不同类型数据库的驱动
-
日志门面接口实现类加载
SLF4J加载不同提供应商的日志实现类
-
Spring Spring Boot
自动装配过程中，加载META-INF/spring.factories文件，解析properties文件
-
Dubbo
Dubbo大量使用了SPI技术，里面有很多个组件，每个组件在框架中都是以接口的形成抽象出来
例如Protocol 协议接口
3. 使用步骤
以支付服务为例：
-
创建一个
PayService添加一个pay方法package com.imooc.spi;
import java.math.BigDecimal;
public interface PayService {
void pay(BigDecimal price);
} -
创建
AlipayService和WechatPayService，实现PayService⚠️SPI的实现类必须携带一个不带参数的构造方法；
package com.imooc.spi;
import java.math.BigDecimal;
public class AlipayService implements PayService{
public void pay(BigDecimal price) {
System.out.println("使用支付宝支付");
}
}package com.imooc.spi;
import java.math.BigDecimal;
public class WechatPayService implements PayService{
public void pay(BigDecimal price) {
System.out.println("使用微信支付");
}
} -
resources目录下创建目录META-INF/services
-
在META-INF/services创建com.imooc.spi.PayService文件
-
先以AlipayService为例：在com.imooc.spi.PayService添加com.imooc.spi.AlipayService的文件内容
-
创建测试类
package com.imooc.spi;
import com.sun.tools.javac.util.ServiceLoader;
import java.math.BigDecimal;
public class PayTests {
public static void main(String[] args) {
ServiceLoader<PayService> payServices = ServiceLoader.load(PayService.class);
for (PayService payService : payServices) {
payService.pay(new BigDecimal(1));
}
}
} -
运行测试类，查看返回结果
使用支付宝支付
4. 原理分析
首先，我们先打开ServiceLoader<S> 这个类
public final class ServiceLoader<S> implements Iterable<S> {
// SPI文件路径的前缀
private static final String PREFIX = "META-INF/services/";
// 需要加载类的接口
private Class<S> service;
// 类加载器
private ClassLoader loader;
// 缓存providers，保存着service实现
private LinkedHashMap<String, S> providers = new LinkedHashMap();
// 懒加载的查找迭代器
private ServiceLoader<S>.LazyIterator lookupIterator;
......
}
参考具体ServiceLoader具体源码，代码量不多，实现的流程如下：
-
应用程序调用ServiceLoader.load方法
// 1. 获取ClassLoad
public static <S> ServiceLoader<S> load(Class<S> var0) {
ClassLoader var1 = Thread.currentThread().getContextClassLoader();
return load(var0, var1);
}
// 2. 调用构造方法
public static <S> ServiceLoader<S> load(Class<S> var0, ClassLoader var1) {
return new ServiceLoader(var0, var1);
}
// 3. 校验参数和ClassLoad
private ServiceLoader(Class<S> var1, ClassLoader var2) {
this.service = (Class)Objects.requireNonNull(var1, "Service interface cannot be null");
this.loader = var2 == null ? ClassLoader.getSystemClassLoader() : var2;
this.reload();
}
//4. 清理缓存容器，实例懒加载迭代器
public void reload() {
this.providers.clear();
this.lookupIterator = new ServiceLoader.LazyIterator(this.service, this.loader, null);
} -
我们简单看一下这个懒加载迭代器
private class LazyIterator implements Iterator<S> {
Class<S> service;
ClassLoader loader;
Enumeration<URL> configs;
Iterator<String> pending;
String nextName;
private LazyIterator(Class<S> var1, ClassLoader var2) {
this.configs = null;
this.pending = null;
this.nextName = null;
this.service = var2;
this.loader = var3;
}
// 迭代执行并获取解析出来的com.imooc.spi.AlipayService
public boolean hasNext() {
if (this.nextName != null) {
return true;
} else {
if (this.configs == null) {
try {
String var1 = "META-INF/services/" + this.service.getName();
if (this.loader == null) {
this.configs = ClassLoader.getSystemResources(var1);
} else {
this.configs = this.loader.getResources(var1);
}
} catch (IOException var2) {
ServiceLoader.fail(this.service, "Error locating configuration files", var2);
}
}
while(this.pending == null || !this.pending.hasNext()) {
if (!this.configs.hasMoreElements()) {
return false;
}
this.pending = ServiceLoader.this.parse(this.service, (URL)this.configs.nextElement());
}
this.nextName = (String)this.pending.next();
return true;
}
}
public S next() {
if (!this.hasNext()) {
throw new NoSuchElementException();
} else {
String var1 = this.nextName;
this.nextName = null;
Class var2 = null;
try {
// 通过反射方法Class.forName()加载类对象
var2 = Class.forName(var1, false, this.loader);
} catch (ClassNotFoundException var5) {
ServiceLoader.fail(this.service,