dubbo学习(六) -- dubbo spi

前言

了解过java spi后, 马上来看看dubbo spi有什么特殊之处

dubbo spi

demo

还是以一个运行的demo开始, 基本和官网一样

public static void main(String[] args) {

    ExtensionLoader<Robot> extensionLoader =
            ExtensionLoader.getExtensionLoader(Robot.class);
    Robot r = extensionLoader.getExtension("r");
    r.sayHello();
    Robot t = extensionLoader.getExtension("t");
    t.sayHello();
}

// 暴露的接口
@SPI
public interface Robot {

    void sayHello();
}
// 实现类
public class R2Robot implements Robot {
    @Override
    public void sayHello() {
        System.out.println("r2");
    }
}

public class T1Robot implements Robot {
    @Override
    public void sayHello() {
        System.out.println("T1");
    }
}

对比下前面的java spi的demo, 感觉套路差不多, 都是通Class创建一个加载器, 通过这个加载器获取到需要的实现类. 唯一的不同就是, java spi是通过迭代器获取到所有的实现类, 然后由用户再次筛选. 而dubbo spi可以直接通过一个key获取到对应的实现类. 现在来看下dubbo是如何实现的.

ExtensionLoader

先看注释, 再看属性

 * Load dubbo extensions
 * <ul>
 * <li>auto inject dependency extension </li>
 * <li>auto wrap extension in wrapper </li>
 * <li>default extension is an adaptive instance</li>
 * </ul>

额…有点短啊~ 翻译下
加载dubbo扩展

• 自动加载依赖的扩展
• 包装器自动包装扩展
• 默认扩展是一个adaptive实例

属性如下, 有点多啊~ 基本都是一些缓存信息, 有注释的都是在demo运行中使用到的

// 三个路径, 都可以加载扩展
private static final String SERVICES_DIRECTORY = "META-INF/services/";
private static final String DUBBO_DIRECTORY = "META-INF/dubbo/";
private static final String DUBBO_INTERNAL_DIRECTORY = DUBBO_DIRECTORY + "internal/";

private static final Pattern NAME_SEPARATOR = Pattern.compile("\\s*[,]+\\s*");
// 缓存ExtensionLoader
private static final ConcurrentMap<Class<?>, ExtensionLoader<?>> EXTENSION_LOADERS = new ConcurrentHashMap<>();
// 扩展实体缓存, 实例通过反射创建class.newInstance()
private static final ConcurrentMap<Class<?>, Object> EXTENSION_INSTANCES = new ConcurrentHashMap<>();

// ==============================
// 接口类型
private final Class<?> type;

// 缓存加载的类信息, key是配置名称
private final Holder<Map<String, Class<?>>> cachedClasses = new Holder<>();

// 缓存实例对象, key是配置的对象名称
private final ConcurrentMap<String, Holder<Object>> cachedInstances = new ConcurrentHashMap<>();

通过注释介绍和拥有的属性, 我们大概知道ExtensionLoader负责从文件中加载扩展, 并构造可运行实例, 当然在这过程中会缓存类信息, 实例信息等, 方便后面再次获取.
下面来跟踪下源码, 看看到底是如何实现的. 两个限制条件: 是否为interface; 是否spi注解

ExtensionLoader<Robot> extensionLoader = ExtensionLoader.getExtensionLoader(Robot.class);

// 源码
public static <T> ExtensionLoader<T> getExtensionLoader(Class<T> type) {
    if (type == null) {
        throw new IllegalArgumentException("Extension type == null");
    }
    // 必须是interface
    if (!type.isInterface()) {
        throw new IllegalArgumentException("Extension type (" + type + ") is not an interface!");
    }
    // 必须是SPI注解修饰
    if (!withExtensionAnnotation(type)) {
        throw new IllegalArgumentException("Extension type (" + type +
                ") is not an extension, because it is NOT annotated with @" + SPI.class.getSimpleName() + "!");
    }

    // 先从缓存中获取
    ExtensionLoader<T> loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);
    if (loader == null) { // 没有则构造一个并存入缓存
        EXTENSION_LOADERS.putIfAbsent(type, new ExtensionLoader<T>(type));
        loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);
    }
    return loader;
}

private static <T> boolean withExtensionAnnotation(Class<T> type) {
    return type.isAnnotationPresent(SPI.class);
}

so easy~
loader有了接下来就是创建对象, 创建对象的过程也很简单,
1 从缓存中获取, 并返回
2 没有, 则从配置文件中扩展
3 实例化对象
4 注入依赖
5 返回对象
代码比较简单就不全贴了.
看下依赖注入这里, 这里的注入就是通过set方法将依赖的扩展注入进来.

private T injectExtension(T instance) {
    try {
        if (objectFactory != null) {
            for (Method method : instance.getClass().getMethods()) {
                // 判断是否为set方法, 也就是说dubbo目前只支持set方法注入
                if (isSetter(method)) {
                    /**
                     * Check {@link DisableInject} to see if we need auto injection for this property
                     */
                    if (method.getAnnotation(DisableInject.class) != null) {
                        continue;
                    }
                    Class<?> pt = method.getParameterTypes()[0];
                    // 如果参数是基础类型就不注入, 因为这里注入指的是将加载的对象注入进来
                    if (ReflectUtils.isPrimitives(pt)) {
                        continue;
                    }
                    try {
                        String property = getSetterProperty(method);
                        Object object = objectFactory.getExtension(pt, property);
                        if (object != null) {
                            method.invoke(instance, object);
                        }
                    } catch (Exception e) {
                        logger.error("Failed to inject via method " + method.getName()
                                + " of interface " + type.getName() + ": " + e.getMessage(), e);
                    }
                }
            }
        }
    } catch (Exception e) {
        logger.error(e.getMessage(), e);
    }
    return instance;
}

总结

dubbo spi的逻辑还是比较简单的, 代码细节有兴趣可以跟一下.
真的是时间拖得越长, 文章越水. 水完这篇还有三篇~