dubbo spi机制源码学习

dubbo是微内核架构。什么是微内核,还是开闭原则的应用,把核心流程架构固定,但流程各个节点对重新和改进是开放的。具体实现机制就是spi(servicer provider intefance)。jdk自身有一套spi机制实现。dubbo在jdk基础上做了扩展和改进。
这篇说说,dubbo自己实现的spi

所谓spi,就是接口由框架定义。具体实现可以有不同提供商提供不同的实现。
打开dubbo jar包可以发现在/META-INF/dubbo/internal目录下,有许多接口名命名的文件
而文件内容就是,文件名代表接口的各种实现类。这就是dubbo spi机制配置基础。
以com.alibaba.dubbo.rpc.Protocol文件为例,内容如下(dubbo2.5.6版本)

registry=com.alibaba.dubbo.registry.integration.RegistryProtocol
dubbo=com.alibaba.dubbo.rpc.protocol.dubbo.DubboProtocol
filter=com.alibaba.dubbo.rpc.protocol.ProtocolFilterWrapper
listener=com.alibaba.dubbo.rpc.protocol.ProtocolListenerWrapper
mock=com.alibaba.dubbo.rpc.support.MockProtocol
injvm=com.alibaba.dubbo.rpc.protocol.injvm.InjvmProtocol
rmi=com.alibaba.dubbo.rpc.protocol.rmi.RmiProtocol
hessian=com.alibaba.dubbo.rpc.protocol.hessian.HessianProtocol
com.alibaba.dubbo.rpc.protocol.http.HttpProtocol
com.alibaba.dubbo.rpc.protocol.webservice.WebServiceProtocol
thrift=com.alibaba.dubbo.rpc.protocol.thrift.ThriftProtocol
memcached=com.alibaba.dubbo.rpc.protocol.memcached.MemcachedProtocol
redis=com.alibaba.dubbo.rpc.protocol.redis.RedisProtocol

在dubbo spi机制中的意思就是,com.alibaba.dubbo.rpc.Protocol接口目前有这么多具体扩展实现,
“=”号前面是扩展名,后面是扩展实现类。

SPI的启动使用入口类是ExtensionLoader。这个类没定义public定构造函数,只有一个private的而public的静态方法也只有一个getExtensionLoader,这也是使用spi的入口方法。

若想取得某个接口类型的扩展,必须先获取对应的ExtensionLoader

/***
     * 获取某个接口的ExtensionLoader
     * @param type 需要spi实现的接口class 比如com.alibaba.dubbo.rpc.Protocol.class;
     * @param <T>
     * @return
     */
    @SuppressWarnings("unchecked")
    public static <T> ExtensionLoader<T> getExtensionLoader(Class<T> type) {
        if (type == null)
            throw new IllegalArgumentException("Extension type == null");
        if (!type.isInterface()) {
            throw new IllegalArgumentException("Extension type(" + type + ") is not interface!");
        }
        //判断接口上是否有SPI注解  dubbo里所有需要spi扩展的接口,都要在类级别加spi注解
        if (!withExtensionAnnotation(type)) {
            throw new IllegalArgumentException("Extension type(" + type +
                    ") is not extension, because WITHOUT @" + SPI.class.getSimpleName() + " Annotation!");
        }
        //缓存是否存在
        ExtensionLoader<T> loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);
        if (loader == null) {
            //利用私有构造器,创建new ExtensionLoader<T>(type) 放入缓存
            EXTENSION_LOADERS.putIfAbsent(type, new ExtensionLoader<T>(type));
            loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);
        }
        return loader;
    }

 /***
     * 私有构造器
     * @param type
     */
    private ExtensionLoader(Class<?> type) {
        //要扩展的接口class 和 ExtensionLoader实例1:1对应
        this.type = type;
        //objectFactory 对象 ,ExtensionFactory本身也是spi的
        //如果是ExtensionFactory本身的ExtensionLoader实例,objectFactory字段为null
        //否则,是ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension();关于getAdaptiveExtension()方法返回的实例,后面会看到
        objectFactory = (type == ExtensionFactory.class ? null : ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension());
    }

有了ExtensionLoader实例,我们就可以通过spi机制获取想要的接口扩展实例了。

下面就以com.alibaba.dubbo.rpc.Protocol接口获取名为dubbo的扩展实例为例说明。java代码如下:

  com.alibaba.dubbo.rpc.Protocol protocal=ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.rpc.Protocol protocal.class).getExtension("dubbo");

跟进getExtension()方法:

/**
     * 返回指定名字的扩展。如果指定名字的扩展不存在,则抛异常 {@link IllegalStateException}.
     *
     * @param name
     * @return
     */
    @SuppressWarnings("unchecked")
    public T getExtension(String name) {
        if (name == null || name.length() == 0)
            throw new IllegalArgumentException("Extension name == null");
        //true 是默认扩展 
        if ("true".equals(name)) {
            //获取接口的默认扩展实例
            return getDefaultExtension();
        }
        //指定扩展的实例,是否已缓存
        Holder<Object> holder = cachedInstances.get(name);
        if (holder == null) {
            //没有缓存,放入map 扩展名: holder 里空对象
            cachedInstances.putIfAbsent(name, new Holder<Object>());
            holder = cachedInstances.get(name);
        }
        //有缓存,取的缓存对象
        Object instance = holder.get();
        if (instance == null) {
            synchronized (holder) {
                //holder里对象为null
                instance = holder.get();
                if (instance == null) {
                    //根据扩展名,获取具体扩展实例,放入缓存holder
                    instance = createExtension(name);
                    holder.set(instance);
                }
            }
        }
        //返回具体扩展实例
        return (T) instance;
    }

    这里有两个相关方法getDefaultExtension()和createExtension();前一个是获取默认扩展,后一个则是通过扩展名后去扩展实例。
    这里看下createExtension(name)方法实现:

/***
     * 这个方法,总结起来有3个步骤,
     * 1,通过扩展名,找到扩展实现类,这过程可能触发spi文件加载解析
     * 2,利用反射机制,获取扩展类实例,并完成依赖注入
     * 3,[如果接口扩展有包装类],实例化包装类
     * 最后返回经由以上3步流程后,产生的对象。
     * 这3步,前一步都是后一步的基础,要顺序完成
     * 
     * @param name
     * @return
     */
    @SuppressWarnings("unchecked")
    private T createExtension(String name) {
        //根据扩展名,获得扩展实现类的 class 完成第1步
        Class<?> clazz = getExtensionClasses().get(name);
        if (clazz == null) {
            throw findException(name);
        }
        try {
            //从缓存里,获取实现类实例
            T instance = (T) EXTENSION_INSTANCES.get(clazz);
            if (instance == null) {
                //利用newInstance()反射,构造类实例,并放入缓存
                EXTENSION_INSTANCES.putIfAbsent(clazz, (T) clazz.newInstance());
                instance = (T) EXTENSION_INSTANCES.get(clazz);
            }
            //完成接口实现类依赖注入,依赖组件先从spi机制构造查找,再从spring容器查找。完成第2步
            injectExtension(instance);

            //如果这接口的实现,还有wrapper类,(有接口类型的构造函数)
            //还有把当前实例instance,注入到包装类,包装类有多个,依次层层,循环构造注入
            //最后返回的是,最后一个包装类实例,这也是dubbo的aop实现机制
	    //完成第3步
            Set<Class<?>> wrapperClasses = cachedWrapperClasses;
            if (wrapperClasses != null && wrapperClasses.size() > 0) {
                for (Class<?> wrapperClass : wrapperClasses) {
                    instance = injectExtension((T) wrapperClass.getConstructor(type).newInstance(instance));
                }
            }
            return instance;
        } catch (Throwable t) {
            throw new IllegalStateException("Extension instance(name: " + name + ", class: " +
                    type + ")  could not be instantiated: " + t.getMessage(), t);
        }
    }

 这里先沿着着第一步骤流程分析:

    //跟踪getExtensionClasses()方法:
    /***
     * 构造获取某个接口所有,扩展名:扩展实现  map,并放入 cachedClasses 对象缓存
     * @return
     */
    private Map<String, Class<?>> getExtensionClasses() {
        Map<String, Class<?>> classes = cachedClasses.get();
        if (classes == null) {
            synchronized (cachedClasses) {
                classes = cachedClasses.get();
                if (classes == null) {
                    //加载类路径中的spi配置文件,构造cachedClasses
                    classes = loadExtensionClasses();
                    cachedClasses.set(classes);
                }
            }
        }
        return classes;
    }

    //跟踪loadExtensionClasses():

    // 加载类路径中的spi配置文件,构造cachedClasses,以及赋值相属性值
    private Map<String, Class<?>> loadExtensionClasses() {
        final SPI defaultAnnotation = type.getAnnotation(SPI.class);
        if (defaultAnnotation != null) {//获取spi 注解  SPI(value="xxx"),默认实现xxx
            String value = defaultAnnotation.value();
            if (value != null && (value = value.trim()).length() > 0) {
                String[] names = NAME_SEPARATOR.split(value);
                if (names.length > 1) {//默认实现,只能有一个
                    throw new IllegalStateException("more than 1 default extension name on extension " + type.getName()
                            + ": " + Arrays.toString(names));
                }
                //获取spi的默认实现
                if (names.length == 1) cachedDefaultName = names[0];
            }
        }
        //
        Map<String, Class<?>> extensionClasses = new HashMap<String, Class<?>>();
        //读取三个目录下的spi 配置文件;/META-INF/dubbo/internal, /META-INF/dubbo, /META-INF/services
        //构造 扩展名:实现类 map
        loadFile(extensionClasses, DUBBO_INTERNAL_DIRECTORY);
        loadFile(extensionClasses, DUBBO_DIRECTORY);
        loadFile(extensionClasses, SERVICES_DIRECTORY);
        return extensionClasses;
    }

 //然后 loadFile(Map<String, Class<?>> extensionClasses, String dir)方法:

 private void loadFile(Map<String, Class<?>> extensionClasses, String dir) {
        //拼接接口名,作为文件名,比如/META-INF/dubbo/internal/com.alibaba.dubbo.rpc.Protocol
        String fileName = dir + type.getName();
        try {
            Enumeration<java.net.URL> urls;
            ClassLoader classLoader = findClassLoader();
            if (classLoader != null) {
                //通过类加载器,获取类路径里,所有指定文件名的文件url
                urls = classLoader.getResources(fileName);
            } else {
                urls = ClassLoader.getSystemResources(fileName);
            }
            //遍历读取每个url
            if (urls != null) {
                while (urls.hasMoreElements()) {
                    java.net.URL url = urls.nextElement();
                    try {
                        //每行,进行解析
                        BufferedReader reader = new BufferedReader(new InputStreamReader(url.openStream(), "utf-8"));
                        try {
                            String line = null;
                            while ((line = reader.readLine()) != null) {
                                final int ci = line.indexOf('#');//#后的配置忽略
                                if (ci >= 0) line = line.substring(0, ci);
                                line = line.trim();
                                if (line.length() > 0) {
                                    try {
                                        String name = null;
                                        int i = line.indexOf('=');
                                        if (i > 0) {
                                            //name 是扩展名
                                            name = line.substring(0, i).trim();
                                            //line 是扩展实现类,全名
                                            line = line.substring(i + 1).trim();
                                        }
                                        if (line.length() > 0) {
                                            //利用反射,后去实现类class
                                            Class<?> clazz = Class.forName(line, true, classLoader);
                                            if (!type.isAssignableFrom(clazz)) {//现在实现类,是否实现了接口type
                                                throw new IllegalStateException("Error when load extension class(interface: " +
                                                        type + ", class line: " + clazz.getName() + "), class "
                                                        + clazz.getName() + "is not subtype of interface.");
                                            }
                                            //实现类是否有Adaptive注解
                                            if (clazz.isAnnotationPresent(Adaptive.class)) {
                                                if (cachedAdaptiveClass == null) {
                                                    cachedAdaptiveClass = clazz;//把这里类class,赋给cachedAdaptiveClass
                                                } else if (!cachedAdaptiveClass.equals(clazz)) {
                                                    //一个接口的spi实现,只能有一个实现类是Adaptive的
                                                    throw new IllegalStateException("More than 1 adaptive class found: "
                                                            + cachedAdaptiveClass.getClass().getName()
                                                            + ", " + clazz.getClass().getName());
                                                }
                                            } else {
                                                try {
                                                    //实现类里,是否有,参数是接口类型的(比如 com.alibaba.dubbo.rpc.Protocol类型,并且1个参数)的构造函数
                                                    //表示它是个接口包装类
                                                    clazz.getConstructor(type);
                                                    //不报错,表示有,就放入cachedWrapperClasses set里,
                                                    //一个接口的spi实现类,可以有多个包装类
                                                    Set<Class<?>> wrappers = cachedWrapperClasses;
                                                    if (wrappers == null) {
                                                        cachedWrapperClasses = new ConcurrentHashSet<Class<?>>();
                                                        wrappers = cachedWrapperClasses;
                                                    }
                                                    wrappers.add(clazz);
                                                } catch (NoSuchMethodException e) {
                                                    //不是包装类
                                                    clazz.getConstructor();
                                                    if (name == null || name.length() == 0) {
                                                        //弃用方法
                                                        name = findAnnotationName(clazz);
                                                        if (name == null || name.length() == 0) {
                                                            if (clazz.getSimpleName().length() > type.getSimpleName().length()
                                                                    && clazz.getSimpleName().endsWith(type.getSimpleName())) {
                                                                name = clazz.getSimpleName().substring(0, clazz.getSimpleName().length() - type.getSimpleName().length()).toLowerCase();
                                                            } else {
                                                                throw new IllegalStateException("No such extension name for the class " + clazz.getName() + " in the config " + url);
                                                            }
                                                        }
                                                    }
                                                    String[] names = NAME_SEPARATOR.split(name);
                                                    if (names != null && names.length > 0) {
                                                        //实现类,是否有Activate注解
                                                        Activate activate = clazz.getAnnotation(Activate.class);
                                                        if (activate != null) {
                                                            //如果有,加入,cachedActivates map 扩展名:实现类class,形式
                                                            cachedActivates.put(names[0], activate);
                                                        }
                                                        for (String n : names) {
                                                            if (!cachedNames.containsKey(clazz)) {
                                                                //实现类:扩展名 map 放入缓存
                                                                cachedNames.put(clazz, n);
                                                            }
							    //Adaptive 和wapper类都不在extensionClasses里!!!
                                                            Class<?> c = extensionClasses.get(n);
                                                            if (c == null) {
                                                                //填充,扩展名:实现类 map
                                                                extensionClasses.put(n, clazz);
                                                            } else if (c != clazz) {
                                                                throw new IllegalStateException("Duplicate extension " + type.getName() + " name " + n + " on " + c.getName() + " and " + clazz.getName());
                                                            }
                                                        }
                                                    }
                                                }
                                            }
                                        }
                                    } catch (Throwable t) {
                                        IllegalStateException e = new IllegalStateException("Failed to load extension class(interface: " + type + ", class line: " + line + ") in " + url + ", cause: " + t.getMessage(), t);
                                        exceptions.put(line, e);
                                    }
                                }
                            } // end of while read lines
                        } finally {
                            reader.close();
                        }
                    } catch (Throwable t) {
                        logger.error("Exception when load extension class(interface: " +
                                type + ", class file: " + url + ") in " + url, t);
                    }
                } // end of while urls
            }
        } catch (Throwable t) {
            logger.error("Exception when load extension class(interface: " +
                    type + ", description file: " + fileName + ").", t);
        }
    }

    //以上完成了扩展类的实例化

接下来步骤2,依赖注入流程分析:

扫描二维码关注公众号,回复: 962435 查看本文章
//看下方法injectExtension(T instance):
    //实例对象,字段依赖注入。字段类型可以是spi 接口类型,或者是Spring bean 类型
    // 依赖注入的字段对象,是通过ExtensionLoader的objectFactory属性完成的,
    // objectFacotry 会根据先后通过spi机制和从spring 容器里获取属性对象并注入。
    // objectFactory 是在ExtensionLoader私有构造函数中赋值
    private T injectExtension(T instance) {
        try {
            if (objectFactory != null) {
                for (Method method : instance.getClass().getMethods()) {
                    if (method.getName().startsWith("set")
                            && method.getParameterTypes().length == 1
                            && Modifier.isPublic(method.getModifiers())) {
                        //获取,所有public ,并且只有一个参数,的set 方法。
                        //获取参数类型
                        Class<?> pt = method.getParameterTypes()[0];
                        try {
                            //根据驼峰命名法,根据方法名,构造set方法要赋值的属性名
                            String property = method.getName().length() > 3 ? method.getName().substring(3, 4).toLowerCase() + method.getName().substring(4) : "";
                            //通过getExtension的方法获取属性对象,所以还要看getExtension的实现。
                            Object object = objectFactory.getExtension(pt, property);
                            if (object != null) {
                                //利用反射机制,赋值对象属性
                                method.invoke(instance, object);
                            }
                        } catch (Exception e) {
                            logger.error("fail to inject via method " + method.getName()
                                    + " of interface " + type.getName() + ": " + e.getMessage(), e);
                        }
                    }
                }
            }
        } catch (Exception e) {
            logger.error(e.getMessage(), e);
        }
        return instance;
    }

回头看下,ExtensionLoader定义的私有构造函数,可以看到这里的objectFactory
通过ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension();语句赋值
它是ExtensionFactory接口的,Adaptive扩展实现。看下getAdaptiveExtension()方法:

//获取一个spi接口的Adatptive(实现类有Adatptive注解的)类型扩展实例,
    @SuppressWarnings("unchecked")
    public T getAdaptiveExtension() {
        Object instance = cachedAdaptiveInstance.get();
        //先取缓存,
        if (instance == null) {
            if (createAdaptiveInstanceError == null) {
                synchronized (cachedAdaptiveInstance) {
                    instance = cachedAdaptiveInstance.get();
                    if (instance == null) {
                        try {
                            //缓存不存在,就创建Adaptive扩展实例
                            instance = createAdaptiveExtension();
                            //对象放入缓存
                            cachedAdaptiveInstance.set(instance);
                        } catch (Throwable t) {
                            createAdaptiveInstanceError = t;
                            throw new IllegalStateException("fail to create adaptive instance: " + t.toString(), t);
                        }
                    }
                }
            } else {
                throw new IllegalStateException("fail to create adaptive instance: " + createAdaptiveInstanceError.toString(), createAdaptiveInstanceError);
            }
        }

        return (T) instance;
    }

   //跟进createAdaptiveExtension():

    private T createAdaptiveExtension() {
        try {
            //获取AdaptiveExtensionClass的class 通过反射获取实例,同时要走依赖注入流程
            //AdaptiveExtensionClass 已在spi 文件解析时赋值
            return injectExtension((T) getAdaptiveExtensionClass().newInstance());
        } catch (Exception e) {
            throw new IllegalStateException("Can not create adaptive extenstion " + type + ", cause: " + e.getMessage(), e);
        }
    }
   //下面getAdaptiveExtensionClass()方法:
/***
     * 返回 接口的Adaptive类class
     * @return
     */
    private Class<?> getAdaptiveExtensionClass() {
        //如果有必要,触发spi加载流程,
	//找到类上有Adaptive注解的class,赋值给cachedAdaptiveClass
        getExtensionClasses();
        if (cachedAdaptiveClass != null) {
            return cachedAdaptiveClass;
        }

        //Adaptive注解不在扩展实现类上,而是在待扩展接口方法上
	//这种情况,就是dubbo动态生成生成java类字串,动态编译生成想要的class
	//这个下面再分析下
        return cachedAdaptiveClass = createAdaptiveExtensionClass();
    }

目前ExtensionFactory接口3个实现类中,只有AdaptiveExtensionFactory类是Adaptive的。

@Adaptive
public class AdaptiveExtensionFactory implements ExtensionFactory {

    private final List<ExtensionFactory> factories;

    /***
     * 无参构造函数中,把其他实现类实例,加入factories list ,有序list 
     * 目前
     */
    public AdaptiveExtensionFactory() {
        ExtensionLoader<ExtensionFactory> loader = ExtensionLoader.getExtensionLoader(ExtensionFactory.class);
        List<ExtensionFactory> list = new ArrayList<ExtensionFactory>();
        //getSupportedExtensions()返回的是 非包装类扩展,非Adaptive扩展,防止无限循环
        for (String name : loader.getSupportedExtensions()) {
            list.add(loader.getExtension(name));
        }
        factories = Collections.unmodifiableList(list);
    }

    public <T> T getExtension(Class<T> type, String name) {
        //循环factories,通过每个factory getExtension 获取bean
        for (ExtensionFactory factory : factories) {
            T extension = factory.getExtension(type, name);
            if (extension != null) {
                return extension;
            }
        }
        return null;
    }

}

//可以看到其他两个实现:

/**
 * SpiExtensionFactory
 *
 * @author william.liangf
 */
public class SpiExtensionFactory implements ExtensionFactory {
    /***
     * spi机制获取 type 接口扩展
     * @param type object type.
     * @param name object name.
     * @param <T>
     * @return
     */
    public <T> T getExtension(Class<T> type, String name) {
        if (type.isInterface() && type.isAnnotationPresent(SPI.class)) {
            ExtensionLoader<T> loader = ExtensionLoader.getExtensionLoader(type);
            if (loader.getSupportedExtensions().size() > 0) {
                //获取的是接口Adaptive实现
                return loader.getAdaptiveExtension();
            }
        }
        return null;
    }

}

/**
 * SpringExtensionFactory
 *
 * @author william.liangf
 */
public class SpringExtensionFactory implements ExtensionFactory {

    private static final Set<ApplicationContext> contexts = new ConcurrentHashSet<ApplicationContext>();

    /***
     * 静态pulbic 方法,这个要手动把spring 容器传入
     * @param context
     */
    public static void addApplicationContext(ApplicationContext context) {
        contexts.add(context);
    }

    public static void removeApplicationContext(ApplicationContext context) {
        contexts.remove(context);
    }

    @SuppressWarnings("unchecked")
    public <T> T getExtension(Class<T> type, String name) {
        /**
         * 搜寻spring 容器
         */
        for (ApplicationContext context : contexts) {
            if (context.containsBean(name)) {
                Object bean = context.getBean(name);
                if (type.isInstance(bean)) {
                    return (T) bean;
                }
            }
        }
        return null;
    }

}
//以上,实例的依赖注入的代码分析完了。

关于第3步,实例化包装类流程分析:

代码上面createExtension方法里已贴出,为了更好的理解,我们可以看下Protocol接口的实现中,ProtocolFilterWrapper,ProtocolListenerWrapper两个包装类,
可以看到他们都有Protocol类型的public构造函数,实例化时,把上层的protocol对象作为参数传入构参作为内部属性,同时包装类本身会实现
Protocol接口,所以这就可以做些类似aop的操作,如ProtocolFilterWrapper
 

/**
 * ListenerProtocol
 *
 * @author william.liangf
 */
public class ProtocolFilterWrapper implements Protocol {

    private final Protocol protocol;

    public ProtocolFilterWrapper(Protocol protocol) {
        if (protocol == null) {
            throw new IllegalArgumentException("protocol == null");
        }
        this.protocol = protocol;
    }

    /***
     * 实例化过滤器链
     * @param invoker
     * @param key
     * @param group
     * @param <T>
     * @return
     */
    private static <T> Invoker<T> buildInvokerChain(final Invoker<T> invoker, String key, String group) {
        Invoker<T> last = invoker;
        List<Filter> filters = ExtensionLoader.getExtensionLoader(Filter.class).getActivateExtension(invoker.getUrl(), key, group);
        if (filters.size() > 0) {
            for (int i = filters.size() - 1; i >= 0; i--) {
                final Filter filter = filters.get(i);
                final Invoker<T> next = last;
                last = new Invoker<T>() {

                    public Class<T> getInterface() {
                        return invoker.getInterface();
                    }

                    public URL getUrl() {
                        return invoker.getUrl();
                    }

                    public boolean isAvailable() {
                        return invoker.isAvailable();
                    }

                    public Result invoke(Invocation invocation) throws RpcException {
                        return filter.invoke(next, invocation);
                    }

                    public void destroy() {
                        invoker.destroy();
                    }

                    @Override
                    public String toString() {
                        return invoker.toString();
                    }
                };
            }
        }
        return last;
    }

    public int getDefaultPort() {
        return protocol.getDefaultPort();
    }

    /***
     * 暴露过程前,执行过滤器链
     * @param invoker 服务的执行体
     * @param <T>
     * @return
     * @throws RpcException
     */
    public <T> Exporter<T> export(Invoker<T> invoker) throws RpcException {
        if (Constants.REGISTRY_PROTOCOL.equals(invoker.getUrl().getProtocol())) {
            return protocol.export(invoker);
        }
        return protocol.export(buildInvokerChain(invoker, Constants.SERVICE_FILTER_KEY, Constants.PROVIDER));
    }

    /***
     * 调用前执行过滤器链
     * @param type 服务的类型
     * @param url  远程服务的URL地址
     * @param <T>
     * @return
     * @throws RpcException
     */
    public <T> Invoker<T> refer(Class<T> type, URL url) throws RpcException {
        if (Constants.REGISTRY_PROTOCOL.equals(url.getProtocol())) {
            return protocol.refer(type, url);
        }
        return buildInvokerChain(protocol.refer(type, url), Constants.REFERENCE_FILTER_KEY, Constants.CONSUMER);
    }

    public void destroy() {
        protocol.destroy();
    }

}

以上基本上是获取扩展实例的流程。

上面提到Adaptive类的另一种配置方式,即Adaptive注解配置在方法上,
dubbo里,配置Adaptive类有两种方式,一种接口实现里,类上本身有Adaptive注解。
还有一种配置,是在接口定义的方法级上有Adaptive注解。
这两种,第一种优先,没有第一种,dubbo自动完成第二种Adaptive类的生成。
还拿Protocol接口做例子:

@SPI("dubbo")
public interface Protocol {

    /**
     * 获取缺省端口,当用户没有配置端口时使用。
     *
     * @return 缺省端口
     */
    int getDefaultPort();

    /**
     * 暴露远程服务:<br>
     * 1. 协议在接收请求时,应记录请求来源方地址信息:RpcContext.getContext().setRemoteAddress();<br>
     * 2. export()必须是幂等的,也就是暴露同一个URL的Invoker两次,和暴露一次没有区别。<br>
     * 3. export()传入的Invoker由框架实现并传入,协议不需要关心。<br>
     *
     * @param <T>     服务的类型
     * @param invoker 服务的执行体
     * @return exporter 暴露服务的引用,用于取消暴露
     * @throws RpcException 当暴露服务出错时抛出,比如端口已占用
     */
    @Adaptive
    <T> Exporter<T> export(Invoker<T> invoker) throws RpcException;

    /**
     * 引用远程服务:<br>
     * 1. 当用户调用refer()所返回的Invoker对象的invoke()方法时,协议需相应执行同URL远端export()传入的Invoker对象的invoke()方法。<br>
     * 2. refer()返回的Invoker由协议实现,协议通常需要在此Invoker中发送远程请求。<br>
     * 3. 当url中有设置check=false时,连接失败不能抛出异常,并内部自动恢复。<br>
     *
     * @param <T>  服务的类型
     * @param type 服务的类型
     * @param url  远程服务的URL地址
     * @return invoker 服务的本地代理
     * @throws RpcException 当连接服务提供方失败时抛出
     */
    @Adaptive
    <T> Invoker<T> refer(Class<T> type, URL url) throws RpcException;

    /**
     * 释放协议:<br>
     * 1. 取消该协议所有已经暴露和引用的服务。<br>
     * 2. 释放协议所占用的所有资源,比如连接和端口。<br>
     * 3. 协议在释放后,依然能暴露和引用新的服务。<br>
     */
    void destroy();

}

可以看到export,refer方法上有Adaptive注解。
根据上面分析,我们跟踪下createAdaptiveExtensionClass方法:

private Class<?> createAdaptiveExtensionClass() {
        //生成Adaptive类源码字串
        String code = createAdaptiveExtensionClassCode();
        ClassLoader classLoader = findClassLoader();
        //通过spi获取java 编译器
        com.alibaba.dubbo.common.compiler.Compiler compiler = ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.common.compiler.Compiler.class).getAdaptiveExtension();
        //编译源码返回class
        return compiler.compile(code, classLoader);
    }

createAdaptiveExtensionClassCode();方法就不贴了,就是字符串拼接,
不同的接口,生成的code会有不同。
这里贴出Protocal生成的Adaptive类,实际上dubbo也会把生成的Adaptive源码输出到日志。体现的思想是,所谓Adaptive方法,其实现,内部的对象类型都是参数(url)和spi机制动态决定的。

package com.alibaba.dubbo.rpc;

import com.alibaba.dubbo.common.extension.ExtensionLoader;

public class Protocol$Adpative implements com.alibaba.dubbo.rpc.Protocol {
    public void destroy() {
        throw new UnsupportedOperationException("method public abstract void com.alibaba.dubbo.rpc.Protocol.destroy() of interface com.alibaba.dubbo.rpc.Protocol is not adaptive method!");
    }

    public int getDefaultPort() {
        throw new UnsupportedOperationException("method public abstract int com.alibaba.dubbo.rpc.Protocol.getDefaultPort() of interface com.alibaba.dubbo.rpc.Protocol is not adaptive method!");
    }

    public com.alibaba.dubbo.rpc.Invoker refer(java.lang.Class arg0, com.alibaba.dubbo.common.URL arg1) throws com.alibaba.dubbo.rpc.RpcException {
        if (arg1 == null) throw new IllegalArgumentException("url == null");
        com.alibaba.dubbo.common.URL url = arg1;
        String extName = (url.getProtocol() == null ? "dubbo" : url.getProtocol());
        if (extName == null)
            throw new IllegalStateException("Fail to get extension(com.alibaba.dubbo.rpc.Protocol) name from url(" + url.toString() + ") use keys([protocol])");
        com.alibaba.dubbo.rpc.Protocol extension = (com.alibaba.dubbo.rpc.Protocol) ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.rpc.Protocol.class).getExtension(extName);
        return extension.refer(arg0, arg1);
    }

    public com.alibaba.dubbo.rpc.Exporter export(com.alibaba.dubbo.rpc.Invoker arg0) throws com.alibaba.dubbo.rpc.RpcException {
        if (arg0 == null) throw new IllegalArgumentException("com.alibaba.dubbo.rpc.Invoker argument == null");
        if (arg0.getUrl() == null)
            throw new IllegalArgumentException("com.alibaba.dubbo.rpc.Invoker argument getUrl() == null");
        com.alibaba.dubbo.common.URL url = arg0.getUrl();
        String extName = (url.getProtocol() == null ? "dubbo" : url.getProtocol());
        if (extName == null)
            throw new IllegalStateException("Fail to get extension(com.alibaba.dubbo.rpc.Protocol) name from url(" + url.toString() + ") use keys([protocol])");
        com.alibaba.dubbo.rpc.Protocol extension = (com.alibaba.dubbo.rpc.Protocol) ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.rpc.Protocol.class).getExtension(extName);
        return extension.export(arg0);
    }
}

//第二种Adpative类在dubbo中非常常用
//ExtensionLoader类里其他方法也基本都依赖以上方法,变量。

猜你喜欢

转载自my.oschina.net/u/146130/blog/1620015