Dubbo 的 SPI

从自定义 Dubbo 的 rpc 协议来学习 Dubbo 的 SPI

SPI 全称为 Service Provider Interface

JDK 的 SPI 实现

Copy

public class SpiTest {

    public static void main(String[] args) {
        // 注解1
        ServiceLoader<Human> load = ServiceLoader.load(Human.class);
        // 注解2
        Iterator<Human> iterator = load.iterator();
        // 注解3
        while (iterator.hasNext()) {
            // 注解4
            Human next = iterator.next();
            System.out.println(next.getName());
        }
    }

}

Copy

public final class ServiceLoader<S> implements Iterable<S> {


    //扫描目录前缀
    private static final String PREFIX = "META-INF/services/";

    // 被加载的类或接口
    private final Class<S> service;

    // 用于定位、加载和实例化实现方实现的类的类加载器
    private final ClassLoader loader;

    // 上下文对象
    private final AccessControlContext acc;

    // 按照实例化的顺序缓存已经实例化的类
    private LinkedHashMap<String, S> providers = new LinkedHashMap<>();

    // 懒查找迭代器
    private java.util.ServiceLoader.LazyIterator lookupIterator;

    // 私有内部类，提供对所有的service的类的加载与实例化
    private class LazyIterator implements Iterator<S> {
        Class<S> service;
        ClassLoader loader;
        Enumeration<URL> configs = null;
        String nextName = null;

        //...
        private boolean hasNextService() {
            if (configs == null) {
                try {
                    //获取目录下所有的类
                    String fullName = PREFIX + service.getName();
                    if (loader == null)
                        configs = ClassLoader.getSystemResources(fullName);
                    else
                        configs = loader.getResources(fullName);
                } catch (IOException x) {
                    //...
                }
                //....
            }
        }

        private S nextService() {
            String cn = nextName;
            nextName = null;
            Class<?> c = null;
            try {
                //反射加载类
                c = Class.forName(cn, false, loader);
            } catch (ClassNotFoundException x) {
            }
            try {
                //实例化
                S p = service.cast(c.newInstance());
                //放进缓存
                providers.put(cn, p);
                return p;
            } catch (Throwable x) {
                //..
            }
            //..
        }
    }
}

注解 1

load 方法关注最后一步关注实例化一个 LazyIterator 实例，赋值给变量 lookupIterator

注解 2

iterator 方法就是实例化了一个匿名类

注解 3

hasNext 方法最终调用的就是这里，从中我们可以看到 fullName 的 PREFIX 就是我们在 resources 下创建的文件夹 META-INF/services/ 与 service 的全路径名字拼接，所以我们创建的文件是固定的，然后通过 getResources 获取内容，nextElement 读取下一个

注解 4