java spi浅析

1. Java spi是什么

SPI全称Service Provider Interface，是Java提供的一套用来被第三方实现或者扩展的接口，它可以用来启用框架扩展和替换组件。 SPI的作用就是为这些被扩展的API寻找服务实现。

2. 使用

1. 定义spi接口
2. 定义多态实现
3. 按固定规范 即classpath:/META-INF/services目录下新建spi接口的全限定类名文件 文件内按行填写该spi接口用到的实现类
4. ServiceLoader.load(spiInterface.class) 使用

工程目录结构

|- src/main/java
  |- spi (定义spi接口的目录)
    |- IEcho.java
    |- impl (spi的多态)
      |- EatEchoImpl.java
      |- SpeakEchoImpl.java
  |- App.java
|- src/main/resources
  |- META-INF
    |- services
      |- spi.IEcho (定义的接口的全限定接口名称 父目录固定名)

工程代码文件

spi/IEcho.java

package spi;
public interface IEcho {
    void echo();
}

spi/impl/EatEchoImpl.java

package spi.impl;
import spi.IEcho;
public class EatEchoImpl implements IEcho {
    @Override
    public void echo() {
        System.out.println("eat echo !!");
    }
}

spi/impl/SpeakEchoImpl.java

package spi.impl;
import spi.IEcho;
public class SpeakEchoImpl implements  IEcho  {
    @Override
    public void echo() {
        System.out.println("speak echo !!");
    }
}

App.java (启动类)

public class App {
    public static void main(String[] args) {
        for (IEcho echoService : ServiceLoader.load(IEcho.class)) {
            echoService.echo();
        }
    }
}

src/main/resources/META-INF/services/spi.IEcho

spi.impl.EatEchoImpl 
spi.impl.SpeakEchoImpl

App.java运行的结果如下

eat echo !!
speak echo !!

3. 其实Javaspi对我们并不陌生 我们使用的mysql-connector、dubbo等其实也用到了spi

上图是把mysql-connector这个jar包解压后的目录结构，我们看到有META-INF这个文件夹 继续深入

java.sql.Driver文件内容如下

com.mysql.jdbc.Driver

然后看下工程是在那里加载的

4. 源码解析

跟踪ServiceLoader.load方法如下

第一块对load方法本身进行解析 如下可以看出 load方法调用后仅仅是做了相关对象的初始化准备工作，最后实例化的LazyIterator是迭代器java.util.Iterator的一个实例，从类名LazyIterator结合load方法没做初始化可以猜测，spi的多态实现是在遍历时进行的实例化、初始化

1. ------------------------------------------------------------------------------------
ServiceLoader.load(IEcho.class)
2. ------------------------------------------------------------------------------------
public static <S> ServiceLoader<S> load(Class<S> service) {
        ClassLoader cl = Thread.currentThread().getContextClassLoader();
        return ServiceLoader.load(service, cl);
}
3. ------------------------------------------------------------------------------------
public static <S> ServiceLoader<S> load(Class<S> service,
                                            ClassLoader loader)
    {
        return new ServiceLoader<>(service, loader);
    }
4. ------------------------------------------------------------------------------------
private ServiceLoader(Class<S> svc, ClassLoader cl) {
        service = Objects.requireNonNull(svc, "Service interface cannot be null");
        loader = (cl == null) ? ClassLoader.getSystemClassLoader() : cl;
        acc = (System.getSecurityManager() != null) ? AccessController.getContext() : null;
        reload();
}
5. ------------------------------------------------------------------------------------
public void reload() {
        providers.clear();
        lookupIterator = new LazyIterator(service, loader);
}

第二块跟踪LazyIterator类的重写实现接口java.util.Iterator的hasNext和next方法

1. ------------------------------------------------------------------------------------
public boolean hasNext() {
            ...
                return hasNextService();
2. ------------------------------------------------------------------------------------
public S next() {
           ...
                return nextService();
3. ------------------------------------------------------------------------------------
private boolean hasNextService() {
            if (configs == null) {
                    // 根据load传进来的service类的类名和PREFIX 定位到spi实现类声明文件
                    // 其中静态常量PREFIX="META-INF/services/"
                    // 即定位到classpath:META-INF/services/spi.IEcho
                    String fullName = PREFIX + service.getName();
                    // 获取文件按行定义的文件路径集合
                    if (loader == null)
                        configs = ClassLoader.getSystemResources(fullName);
                    else
                        configs = loader.getResources(fullName);
                
            while ((pending == null) || !pending.hasNext()) {
                if (!configs.hasMoreElements()) {
                    return false;
                }
                // 这一步源码就是根据上面读出的文件路径 逐个进行读取和校验
                // 校验成功放到一个ArrayList里面 然后返回该ArrayList的迭代器
                pending = parse(service, configs.nextElement());
            }
            // 读取校验成功 把该全限定类名赋值给nextName
            nextName = pending.next();
            return true;
}
4. ------------------------------------------------------------------------------------
private S nextService() {
            if (!hasNextService())
                throw new NoSuchElementException();
             // hasNext获取到的下一行spi实现类名
            String cn = nextName;
            nextName = null;
            Class<?> c = null;
            try {
                // 加载这个全限定类名的class文件到jvm中
                c = Class.forName(cn, false, loader);
            } catch (ClassNotFoundException x) {
                fail(service,
                     "Provider " + cn + " not found");
            }
            if (!service.isAssignableFrom(c)) {
                fail(service,
                     "Provider " + cn  + " not a subtype");
            }
            try {
                // 实例化并强转为load传的参数的类型
                S p = service.cast(c.newInstance());
                providers.put(cn, p);
                return p;
            } catch (Throwable x) {
                fail(service,
                     "Provider " + cn + " could not be instantiated",
                     x);
            }
            throw new Error();          // This cannot happen
}

总结

spi通过定义一套定位、加载、实例化、使用的流程，基于Java多态很好的提供了一个拓展的通道。