1 SPI简介

SPI,Service Provider Interface,一种服务发现机制。

比如一接口有3个实现类,那么在系统运行时,这个接口到底该选择哪个实现类?
这就需要SPI,根据指定或默认的配置,找到对应的实现类,加载进来,然后使用该实现类实例
Dubbo和JDK的SPI机制对比详解_面试

在系统实际运行的时候,会加载你的配置,用实现A2实例化一个对象来提供服务。

比如你要通过jar包给某个接口提供实现,然后你就在自己jar包的META-INF/services/目录下放一个接口同名文件,指定接口的实现是自己这个jar包里的某个类。
Dubbo和JDK的SPI机制对比详解_Java_02

别人用这个接口,然后用你的jar包,就会在运行时通过你的jar包的那个文件找到这个接口该用哪个实现类。这是JDK提供的功能。

比如你有个工程A,有个接口A,接口A在工程A没有实现类,系统运行时怎么给接口A选个实现类呢?
可以自己搞个jar包,META-INF/services/,放上一个文件,文件名即接口名,接口A,接口A的实现类=com.javaedge.service.实现类A2

让工程A来依赖你的jar包,然后在系统运行时,工程A跑起来,对于接口A,就会扫描依赖的jar包,看看有没有META-INF/services文件夹。
如果有,再看看有没有名为接口A的文件,如果有,在里面找一下指定的接口A的实现是你的jar包里的哪个类!

2 适用场景

插件扩展的场景,比如你开发了一个开源框架,若你想让别人自己写个插件,安排到你的开源框架里中,扩展功能

2.1 Java中的SPI

经典的思想体现,其实大家平时都在用,比如JDBC。Java定义了一套JDBC的接口,但并未提供其实现类。

但实际上项目运行时,要使用JDBC接口的哪些实现类呢?
一般要根据自己使用的数据库引入:

  • MySQL,mysql-jdbc-connector.jar
    Dubbo和JDK的SPI机制对比详解_Java_03
    系统运行时碰到你使用JDBC的接口,就会在底层使用你引入的那个jar中提供的实现类。

2.2 Dubbo中的SPI

Dubbo 并未使用 Java SPI,而是重新实现了一套功能更强的 SPI 机制。Dubbo SPI 的相关逻辑被封装在了 ExtensionLoader 类,通过 ExtensionLoader,可以加载指定的实现类。Dubbo SPI 所需的配置文件需放置在 META-INF/dubbo 路径下
Dubbo和JDK的SPI机制对比详解_Java_04
配置内容如下。

Protocol protocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension();

Dubbo要判断一下,在系统运行时,应该选用这个Protocol接口的哪个实现类。
它会去找一个你配置的Protocol,将你配置的Protocol实现类,加载进JVM,将其实例化。
微内核,可插拔,大量的组件,Protocol负责RPC调用的东西,你可以实现自己的RPC调用组件,实现Protocol接口,给自己的一个实现类即可。
这行代码就是Dubbo里大量使用的,就是对很多组件,都是保留一个接口和多个实现,然后在系统运行的时候动态根据配置去找到对应的实现类。如果你没配置,那就走默认的实现。

2.2.1 实例

Dubbo和JDK的SPI机制对比详解_Dubbo_05

在Dubbo自己的jar里
/META_INF/dubbo/internal/com.alibaba.dubbo.rpc.Protocol文件中:
Dubbo和JDK的SPI机制对比详解_面试_06
Dubbo和JDK的SPI机制对比详解_SPI_07
Dubbo和JDK的SPI机制对比详解_Java_08
即可看到Dubbo的SPI机制默认流程,就是Protocol接口

  • @SPI(“dubbo”)
    通过SPI机制提供实现类,实现类是通过将dubbo作为默认key去配置文件里找到的,配置文件名称为接口全限定名,通过dubbo作为key可以找到默认的实现类org.apache.dubbo.rpc.protocol.dubbo.DubboProtocol

Dubbo的默认网络通信协议,就是dubbo协议,用的DubboProtocol
在 Java 的 SPI 配置文件里每一行只有一个实现类的全限定名,在 Dubbo的 SPI配置文件中是 key=value 的形式,我们只需要对应的 key 就能加载对应的实现。

实现源码

/**
  * 返回指定名字的扩展。如果指定名字的扩展不存在,则抛异常 {@link IllegalStateException}.
  */
@SuppressWarnings("unchecked")
public T getExtension(String name) {
	if (name == null || name.length() == 0)
	    throw new IllegalArgumentException("Extension name == null");
	if ("true".equals(name)) {
	    return getDefaultExtension();
	}
	Holder<Object> holder = cachedInstances.get(name);
	if (holder == null) {
	    cachedInstances.putIfAbsent(name, new Holder<Object>());
	    holder = cachedInstances.get(name);
	}
	//  DCL(double check lock)
	Object instance = holder.get();
	if (instance == null) {
	    synchronized (holder) {
            instance = holder.get();
            if (instance == null) {
                instance = createExtension(name);
                holder.set(instance);
            }
        }
	}
	return (T) instance;
}

不用像 Java 原生的 SPI 那样去遍历加载对应的服务类,只需要通过 key 去寻找,并且寻找的时候会先从缓存的对象里去取。

private T createExtension(String name) {
    Class<?> clazz = getExtensionClasses().get(name);
    if (clazz == null) {
        throw findException(name);
    }
    try {
        T instance = (T) EXTENSION_INSTANCES.get(clazz);
        if (instance == null) {
            EXTENSION_INSTANCES.putIfAbsent(clazz, clazz.newInstance());
            instance = (T) EXTENSION_INSTANCES.get(clazz);
        }
        injectExtension(instance);
        Set<Class<?>> wrapperClasses = cachedWrapperClasses;
        if (CollectionUtils.isNotEmpty(wrapperClasses)) {
            for (Class<?> wrapperClass : wrapperClasses) {
                instance = injectExtension((T) wrapperClass.getConstructor(type).newInstance(instance));
            }
        }
        initExtension(instance);
        return instance;
    } catch (Throwable t) {
        throw new IllegalStateException("Extension instance (name: " + name + ", class: " +
                type + ") couldn't be instantiated: " + t.getMessage(), t);
    }
}

若想动态替换默认实现类,需使用@Adaptive接口。Protocol接口中,有两个方法添加了@Adaptive注解,就是说那俩接口会被代理实现。

比如这个Protocol接口搞了俩@Adaptive注解了方法,在运行时会针对Protocol生成代理类,该代理类的那俩方法中会有代理代码,代理代码会在运行时动态根据url中的protocol来获取key(默认是dubbo),也可以自己指定,如果指定了别的key,那么就会获取别的实现类的实例。通过这个url中的参数不同,就可以控制动态使用不同的组件实现类

3 扩展Dubbo组件

自己写个工程,可以打成jar包的那种哦

  • 里面的src/main/resources目录下
  • 搞一个META-INF/services
  • 里面放个文件叫:com.alibaba.dubbo.rpc.Protocol
  • 文件里搞一个my=com.javaedge.MyProtocol
  • 自己把jar弄到nexus私服
  • 然后自己搞一个dubbo provider工程,在这个工程里面依赖你自己搞的那个jar
  • 然后在spring配置文件里给个配置:
<dubbo:protocol name=”my” port=”20000” />

这个时候provider启动的时候,就会加载到我们jar包里的my=com.javaedge.MyProtocol这行配置,接着会根据你的配置使用你定义好的MyProtocol了,这个就是简单说明一下,你通过上述方式,可以替换掉大量的dubbo内部的组件,就是扔个你自己的jar包,然后配置一下即可~

  • Dubbo的SPI原理图
    Dubbo和JDK的SPI机制对比详解_面试_09

Dubbo中提供了大量的类似上面的扩展点.
你要扩展一个东西,只需自己写个jar,让你的consumer或者是provider工程,依赖它,在你的jar里指定目录下配置好接口名称对应的文件,里面通过key=实现类然后对对应的组件,用类似<dubbo:protocol>用你的哪个key对应的实现类来实现某个接口,你可以自己去扩展dubbo的各种功能,提供你自己的实现!

参考

  • 《Java工程师面试突击第1季》
  • https://dubbo.apache.org/zh-cn/docs/source_code_guide