JDK自带SPI机制与Dubbo的SPI机制对比

1. JDK自带SPI机制 (1) 简介

SPI 全称为 Service Provider Interface，是一种服务发现机制。SPI 的本质是将接口实现类的全限定名配置在文件中，并由服务加载器读取配置文件，加载实现类。这样可以在运行时，动态为接口替换实现类。正因此特性，我们可以在不改动接口源代码的情况下，通过 SPI 机制为我们的程序提供拓展功能。

(2) 编写示例

新建maven工程后，先定义一个接口

public interface UploadCDN {
    void upload(String url);
}

接下来定义两个实现类

public class QiyiCDN implements UploadCDN {
    @Override
    public void upload(String url) {
        System.out.println("upload to Qiyi");
    }
}
public class ChinaNetCDN implements UploadCDN {
    @Override
    public void upload(String url) {
        System.out.println("upload to ChinaNetCDN");
    }
}

在resource/meta-INF/services下创建一个文本文件，文件名为接口的全限定名：com.lzq.spidemo.service.UploadCDN，并写入以下内容

com.lzq.spidemo.service.Impl.QiyiCDN
com.lzq.spidemo.service.Impl.ChinaNetCDN

开始编写测试代码

public class Demo {
    public static void main(String[] args) {
        //注意："meta-INF/services/"这个目录是在ServiceLoader写死的
        ServiceLoader uploadCDN = ServiceLoader.load(UploadCDN.class);
        for (UploadCDN u : uploadCDN) {
            u.upload("filePath");
        }
    }
}

可以看到，所有的实现类都会创建新实例并调用对应方法。

(3) ServiceLoader源码

load函数会将当前线程的类加载器和接口的类对象传入ServiceLoader对象

public static  ServiceLoader load(Class service) {
    ClassLoader cl = Thread.currentThread().getContextClassLoader();
    return ServiceLoader.load(service, cl);
}

创建ServiceLoader对象后，会初始化一个内部的迭代器对象LazyIterator

private class LazyIterator implements Iterator { Class service; ClassLoader loader; Enumeration configs = null; Iterator pending = null; String nextName = null; private LazyIterator(Class service, ClassLoader loader) { this.service = service; this.loader = loader; } private boolean hasNextService() { if (nextName != null) { return true; } if (configs == null) { try { //查找到对应接口的文本文件，然后解析获取到其中记录的所有实现类 String fullName = PREFIX + service.getName(); if (loader == null) configs = ClassLoader.getSystemResources(fullName); else configs = loader.getResources(fullName); } catch (IOException x) { fail(service, "Error locating configuration files", x); } } while ((pending == null) || !pending.hasNext()) { if (!configs.hasMoreElements()) { return false; } pending = parse(service, configs.nextElement()); } nextName = pending.next(); return true; } }
2.Dubbo的SPI机制 (1) 简介
dubbo的spi在jdk的spi基础上做了扩展，可以指定或者某个实现类
(2) 实例
先定义一个接口LoadBalance, 这里的@SPI作用于接口类上，用来指定默认的实现类标识。

@Adaptive表名该方法会被代理动态实现。

@SPI("demo") public interface LoadBalance { @Adaptive void Hello(); }

定义两个实现类

public class DemoLoadbalance implements LoadBalance { @Override public void Hello() { System.out.println("this is demo balance"); } } public class TestLoadBalance implements LoadBalance { @Override public void Hello() { System.out.println("this is test balance"); } }

在resource/meta-INF/services下创建一个文本文件，文件名为接口的全限定名：

com.lzq.dubbospidemo.service.LoadBalance，并写入以下内容，注意这里和jdk的写法不一样，前面需要写上标识

demo=com.lzq.dubbospidemo.service.impl.DemoLoadbalance test=com.lzq.dubbospidemo.service.impl.TestLoadBalance

开始测试

public static void main(String[] args) { ExtensionLoader extensionLoader = ExtensionLoader.getExtensionLoader(LoadBalance.class); LoadBalance demoBalance = extensionLoader.getExtension("demo"); demoBalance.Hello(); LoadBalance testBalance = extensionLoader.getExtension("test"); testBalance.Hello(); LoadBalance balance = extensionLoader.getDefaultExtension(); balance.Hello(); }

测试结果如图

3. 源码解析

先看一下获取ExtensionLoader的过程

public static ExtensionLoader getExtensionLoader(Class type) { if (type == null) { //不能传入null参数 throw new IllegalArgumentException("Extension type == null"); } else if (!type.isInterface()) { //需要是接口 throw new IllegalArgumentException("Extension type(" + type + ") is not interface!"); } else if (!withExtensionAnnotation(type)) { //需要带有SPI注解 throw new IllegalArgumentException("Extension type(" + type + ") is not extension, because WITHOUT @" + SPI.class.getSimpleName() + " Annotation!"); } else { //EXTENSION_LOADERS是一个可以并发访问的map对象，在这里相当于一个缓存 //下面的步骤首先尝试从缓存获取loader对象，若缓存中不存在则新建loader对象 //放入缓存，然后再次从缓存中获取 ExtensionLoader loader = (ExtensionLoader)EXTENSION_LOADERS.get(type); if (loader == null) { EXTENSION_LOADERS.putIfAbsent(type, new ExtensionLoader(type)); loader = (ExtensionLoader)EXTENSION_LOADERS.get(type); } return loader; } }

下面看看获取具体实现类的过程

public T getExtension(String name) { if (name != null && name.length() != 0) { //参数为true，使用默认的extension if ("true".equals(name)) { return this.getDefaultExtension(); } else { //和上面一样，先查看缓存是否有对应的实例对象，没有就新建然后再获取 //这里Holder对象持有一个volatile的value属性，保证了对所有线程的可见性 Holder

JDK自带SPI机制与Dubbo的SPI机制对比

大数据系统相关栏目本月热门文章