Dubbo内核剖析-SPI实现源码解析

Dubbo约定如下

  • SPI文件存储路径在META-INF/dubbo/internal目录下,并且文件名为接口名的全路径名接口包名+接口名

  • 每个SPI文件里面格式定义为:扩展名=具体类名,例如dubbo=org.apache.dubbo.rpc.protocol.dubbo.DubboProtocol

实现路径:

  • getExtensionLoader(Class type) 就是为该接口new一个ExtensionLoader,然后缓存起来。

  • getAdaptiveExtension() 获取一个拓展装饰类的对象,如果@Adaptive注解在类上就是一个装饰类,如果注释在方法上就是一个动态代理类,例如Protocol$Adaptive对象。

  • getExtension(String name) 获取一个对象

这些方法都在ExtensionLoader中,ExtensionLoader是最核心的类,负责扩展点的加载和生命周期管理。

getExtensionLoader(Class type)

从Dubbo的第一行代码,解析getExtensionLoader的执行过程

Dubbo内核剖析-SPI实现源码解析_第1张图片
image.png

getExtensionLoader方法 这是一个静态工厂方法,入参是一个可扩展的接口,返回一个该接口的ExtensionLoader实体类。通过这个实体类,可以根据name获得具体的扩展,也可以获得一个自适应扩展。

   public static  ExtensionLoader getExtensionLoader(Class type) {
        if (type == null) {
            throw new IllegalArgumentException("Extension type == null");
        }
         // 扩展点必须是接口
        if (!type.isInterface()) {
            throw new IllegalArgumentException("Extension type(" + type + ") is not interface!");
        }
        // 必须要有@SPI注解
        if (!withExtensionAnnotation(type)) {
            throw new IllegalArgumentException("Extension type(" + type +
                    ") is not extension, because WITHOUT @" + SPI.class.getSimpleName() + " Annotation!");
        }
        // 从缓存中根据接口获取对应的ExtensionLoader
        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;
    }

如果缓存中没有获取到对应的ExtensionLoader则新建一个ExtensionLoader

Dubbo内核剖析-SPI实现源码解析_第2张图片
image.png

在ExtensionLoader结构体内也会调用ExtensionLoader.getExtensionLoader获取一个ExtensionFactory的ExtensionLoader实例,这个实例 objectFactory值是 null,然后调用getAdaptiveExtension获取一个自适应类(这个方法后面再详述)

Dubbo内核剖析-SPI实现源码解析_第3张图片
image.png

当调用完ExtensionLoader构造函数完成两个属性的初始化

  1. 每个ExtensionLoader都包含2个值type和objectFactory, type 构造器初始化时要得到的接口名,objectFactory 是一个AdaptiveExtensionFactory,里面包含一个SpiExtensionFactory


    Dubbo内核剖析-SPI实现源码解析_第4张图片
    image.png
  2. EXTENSION_LOADERS会存入两个值,并获取Container.class接口的ExtensionLoader实例返回。


    Dubbo内核剖析-SPI实现源码解析_第5张图片
    image.png

关于objectFactory的一些细节

  • objectFactory就是ExtensionFactory,它就是通过 ExtensionLoader.getExtensionLoader(ExtensionFactory.class)来实现的,但是它的objectFactory=null
  • objectFactory作用,它就是为dubbo的IOC提供所有对象。

getAdaptiveExtension()

在对自适应拓展生成过程进行深入分析之前,我们先来看一下与自适应拓展息息相关的一个注解,即 Adaptive 注解。该注解的定义如下:

@Documented
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.TYPE, ElementType.METHOD})
public @interface Adaptive {
   String[] value() default {};
}

从上面的代码中可知,Adaptive 可注解在类或方法上。

注解在类上:代表人工实现一个装饰类(设计模式中的装饰模式),它主要作用于固定已知类,目前整个系统只有2个,AdaptiveCompiler、AdaptiveExtensionFactory。

  • 为什么AdaptiveCompiler这个类是固定已知的?因为整个框架仅支持Javassist和JdkCompiler。
  • 为什么AdaptiveExtensionFactory这个类是固定已知的?因为整个框架仅支持2个objectFactory,一个是spi,另一个是spring

注解在方法上:代表自动生成和编译一个动态的Adpative类,因为有些拓展并不想在框架启动阶段被加载,而是希望在拓展方法被调用时,根据运行时参数进行加载,所以设计了动态$Adaptive类.

  • 例如 Protocol的spi类有 injvm、dubbo、registry、filter、listener等等 很多扩展未知类,它设计了Protocol$Adaptive的类,通过ExtensionLoader.getExtensionLoader(Protocol.class).getExtension(spi类)来提取对象。

从Protocol获取自适应类的过程来解析getAdaptiveExtension执行过程

Dubbo内核剖析-SPI实现源码解析_第6张图片
image.png

具有自适应功能的Protocol实现,在不同场景下会有所不同。 特定的Protocol实现由URL中的protocol属性确定。例如:

  • 当url是注册表时://224.5.6.7:1234 / org.apache.dubbo.registry.RegistryService?application = dubbo-sample,那么protocol属性是RegistryProtocol
  • 当url是dubbo://224.5.6.7:1234 / org.apache.dubbo.config.api.DemoService?application = dubbo-sample时,protocol属性是DubboProtocol

最后它将自动包装两个层,最终将获得ProtocolFilterWrapperProtocolListenerWrapper

    public T getAdaptiveExtension() {
        // 从缓存中获取自适应拓展
        Object instance = cachedAdaptiveInstance.get();
        //双重检查
        if (instance == null) {
            if (createAdaptiveInstanceError == null) {
                synchronized (cachedAdaptiveInstance) {
                    instance = cachedAdaptiveInstance.get();
                    if (instance == null) {
                        try {
                        // 创建自适应拓展
                            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;
    }

getAdaptiveExtension 方法首先会检查缓存,缓存未命中,则调用 createAdaptiveExtension 方法创建自适应拓展。

    private T createAdaptiveExtension() {
        try {
         // 获取自适应拓展类,并通过反射实例化
            return injectExtension((T) getAdaptiveExtensionClass().newInstance());
        } catch (Exception e) {
            throw new IllegalStateException("Can not create adaptive extension " + type + ", cause: " + e.getMessage(), e);
        }
    }

createAdaptiveExtension 主要执行三个动作:

  • 调用 getAdaptiveExtensionClass 方法获取自适应拓展 Class 对象
  • 通过反射进行实例化
  • 调用 injectExtension 方法向拓展实例中注入依赖

接下来,分析 getAdaptiveExtensionClass 方法的逻辑。

private Class getAdaptiveExtensionClass() {
    // 通过 SPI 获取所有的拓展类
    getExtensionClasses();
    // cachedAdaptiveClass缓存中存储的是有Adaptive注解的类,如AdaptiveExtensionFactory,若缓存不为空,则直接返回缓存
    if (cachedAdaptiveClass != null) {
        return cachedAdaptiveClass;
    }
    // 创建自适应拓展类
    return cachedAdaptiveClass = createAdaptiveExtensionClass();
}

getAdaptiveExtensionClass 方法同样包含了三个逻辑,如下:

  • 调用 getExtensionClasses 获取所有的拓展类
  • 检查缓存cachedAdaptiveClass,若缓存不为空,则直接返回缓存
  • 若缓存为空,则调用 createAdaptiveExtensionClass 创建自适应拓展类

首先从第一个逻辑说起,getExtensionClasses 这个方法用于获取某个接口的所有实现类。比如该方法可以获取 Protocol 接口的 DubboProtocol、HttpProtocol、InjvmProtocol 等实现类。在获取实现类的过程中,如果某个某个实现类被 Adaptive 注解修饰了,如AdaptiveExtensionFactory,那么该类就会被赋值给 cachedAdaptiveClass 变量。此时,上面步骤中的第二步条件成立(缓存不为空),直接返回 cachedAdaptiveClass 。如果所有的实现类均未被 Adaptive 注解修饰,那么执行第三步逻辑,创建自适应拓展类:

getExtensionClasses

先分析第一个逻辑 getExtensionClasses 获取所有的拓展类,代码如下:

private Map> getExtensionClasses() {
         //从缓存中获取
        Map> classes = cachedClasses.get();
        if (classes == null) {
            synchronized (cachedClasses) {
                classes = cachedClasses.get();
                if (classes == null) {
                    classes = loadExtensionClasses();
                    cachedClasses.set(classes);
                }
            }
        }
        return classes;
    }

getExtensionClasses 主要执行两个动作:

  • 检查缓存cachedClasses中是否有值。
  • 如果没有则loadExtensionClasses()获取所有的拓展类。
  • 最后将classes放入cachedClasses中。

接着看loadExtensionClasses()是如何获取所有的扩展类的。

private Map> loadExtensionClasses() {
         //从接口的SPI注解获取默认的扩展
        final SPI defaultAnnotation = type.getAnnotation(SPI.class);
        if (defaultAnnotation != null) {
            String value = defaultAnnotation.value();
            if ((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));
                }
                if (names.length == 1) {
                    cachedDefaultName = names[0];
                }
            }
        }
        
        //下面方法就是从META-INF/dubbo/internal(DubboSPI路径)和META-INF/services(JDK SPI路径)获取所有扩展。
        Map> extensionClasses = new HashMap>();
        loadDirectory(extensionClasses, DUBBO_INTERNAL_DIRECTORY, type.getName());
        loadDirectory(extensionClasses, DUBBO_INTERNAL_DIRECTORY, type.getName().replace("org.apache", "com.alibaba"));
        loadDirectory(extensionClasses, DUBBO_DIRECTORY, type.getName());
        loadDirectory(extensionClasses, DUBBO_DIRECTORY, type.getName().replace("org.apache", "com.alibaba"));
        loadDirectory(extensionClasses, SERVICES_DIRECTORY, type.getName());
        loadDirectory(extensionClasses, SERVICES_DIRECTORY, type.getName().replace("org.apache", "com.alibaba"));
        return extensionClasses;
    }

loadExtensionClasses 主要做两件事情。

  • 获取接口上SPI注解,获取默认的扩展
  • 从META-INF/dubbo/internal(DubboSPI路径)和META-INF/services(JDK SPI路径)获取所有扩展。

继续看loadDirectory方法

 private void loadDirectory(Map> extensionClasses, String dir, String type) {
        String fileName = dir + type;
        try {
            Enumeration urls;
            ClassLoader classLoader = findClassLoader();
            if (classLoader != null) {
                urls = classLoader.getResources(fileName);
            } else {
                urls = ClassLoader.getSystemResources(fileName);
            }
            if (urls != null) {
                while (urls.hasMoreElements()) {
                    java.net.URL resourceURL = urls.nextElement();
                    //加载文件资源,其实就是SPI接口实现
                    loadResource(extensionClasses, classLoader, resourceURL);
                }
            }
        } catch (Throwable t) {
            logger.error("Exception when load extension class(interface: " +
                    type + ", description file: " + fileName + ").", t);
        }
    }

loadDirectory 主要包含三个逻辑:

  • 获取一个类加载器。
  • 通过加载器,加载文件名为META-INF/dubbo/internal/org.apache.dubbo.rpc.Protocol资源。
  • 遍历urls获取META-INF/dubbo/internal/org.apache.dubbo.rpc.Protocol中的SPI实现。

loadResource代码如下:

 private void loadResource(Map> extensionClasses, ClassLoader classLoader, java.net.URL resourceURL) {
        try {
            BufferedReader reader = new BufferedReader(new InputStreamReader(resourceURL.openStream(), "utf-8"));
            try {
                String line;
                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 = line.substring(0, i).trim();
                                line = line.substring(i + 1).trim();
                            }
                            if (line.length() > 0) {
                                loadClass(extensionClasses, resourceURL, Class.forName(line, true, classLoader), name);
                            }
                        } catch (Throwable t) {
                            IllegalStateException e = new IllegalStateException("Failed to load extension class(interface: " + type + ", class line: " + line + ") in " + resourceURL + ", cause: " + t.getMessage(), t);
                            exceptions.put(line, e);
                        }
                    }
                }
            } finally {
                reader.close();
            }
        } catch (Throwable t) {
            logger.error("Exception when load extension class(interface: " +
                    type + ", class file: " + resourceURL + ") in " + resourceURL, t);
        }
    }

loadResource 逻辑比较简单就是一行行读取,然后获取扩展名和扩展实现类,然后调用loadClass方法

  private void loadClass(Map> extensionClasses, java.net.URL resourceURL, Class clazz, String name) throws NoSuchMethodException {
       //判断扩展clazz,是不是type的子类
        if (!type.isAssignableFrom(clazz)) {
            throw new IllegalStateException("Error when load extension class(interface: " +
                    type + ", class line: " + clazz.getName() + "), class "
                    + clazz.getName() + "is not subtype of interface.");
        }
        //判断Adaptive是否注释在类上。如果是且cachedAdaptiveClass为空则为cachedAdaptiveClass赋值。
        if (clazz.isAnnotationPresent(Adaptive.class)) {
            if (cachedAdaptiveClass == null) {
                cachedAdaptiveClass = clazz;
            } else if (!cachedAdaptiveClass.equals(clazz)) {
                throw new IllegalStateException("More than 1 adaptive class found: "
                        + cachedAdaptiveClass.getClass().getName()
                        + ", " + clazz.getClass().getName());
            }
           //判断clazz构造函数中是否有其父类接口,在Protocol只有ProtocolFilterWrapper和ProtocolListenerWrapper构造函数中有Protocol属性
        } else if (isWrapperClass(clazz)) {
            Set> wrappers = cachedWrapperClasses;
            if (wrappers == null) {
                cachedWrapperClasses = new ConcurrentHashSet>();
                wrappers = cachedWrapperClasses;
            }
            wrappers.add(clazz);
        } else {
            clazz.getConstructor();
            if (StringUtils.isEmpty(name)) {
                name = findAnnotationName(clazz);
                if (name.length() == 0) {
                    throw new IllegalStateException("No such extension name for the class " + clazz.getName() + " in the config " + resourceURL);
                }
            }
            String[] names = NAME_SEPARATOR.split(name);
            if (names != null && names.length > 0) {
            //判断clazz是否有Activate注解
                Activate activate = clazz.getAnnotation(Activate.class);
                if (activate != null) {
                    cachedActivates.put(names[0], activate);
                } else {
                    // support com.alibaba.dubbo.common.extension.Activate
                    com.alibaba.dubbo.common.extension.Activate oldActivate = clazz.getAnnotation(com.alibaba.dubbo.common.extension.Activate.class);
                    if (oldActivate != null) {
                        cachedActivates.put(names[0], oldActivate);
                    }
                }
                //如果前面的条件都不满足,则放入cachedNames和extensionClasses中
                for (String n : names) {
                    if (!cachedNames.containsKey(clazz)) {
                        cachedNames.put(clazz, n);
                    }
                    Class c = extensionClasses.get(n);
                    if (c == null) {
                        extensionClasses.put(n, clazz);
                    } else if (c != clazz) {
                        throw new IllegalStateException("Duplicate extension " + type.getName() + " name " + n + " on " + c.getName() + " and " + clazz.getName());
                    }
                }
            }
        }
    }

执行loadClass方法主要是为以下几个属性赋值

  1. cachedAdaptiveClass 如果这个类class含有adaptive注解就赋值,例如 AdaptiveExtensionFactory ,而例如Protocol在这个环节是没有的。

  2. cachedWrapperClasses 只有当改class无adaptive注解,并且构造函数包含目标接口(type)类型 例如Protocol里面的spi就只有ProtocolFilterWapper和ProtocolListenerWrapper能命中

  3. cachedActivates 剩下的类,包含Activate注解

  4. 剩下的类就存储在cachedNames 和extensionClasses,extensionClasses是从外部传入的,之后它的值会放入cachedClasses缓存中。

至此加载SPI扩展的方法就执行完了。

createAdaptiveExtensionClass

像Protocol所有的实现类均未被 Adaptive 注解修饰,就会调用createAdaptiveExtensionClass生成一个动态类。相关代码如下

private Class createAdaptiveExtensionClass() {
        //构建自适应拓展代码
        String code = createAdaptiveExtensionClassCode();
        ClassLoader classLoader = findClassLoader();
        //获取编译器实现类
        org.apache.dubbo.common.compiler.Compiler compiler = ExtensionLoader.getExtensionLoader(org.apache.dubbo.common.compiler.Compiler.class).getAdaptiveExtension();
        // 编译代码,生成 Class
        return compiler.compile(code, classLoader);
    }

createAdaptiveExtensionClass 方法用于生成自适应拓展类,该方法首先会生成自适应拓展类的源码,然后通过 Compiler 实例(Dubbo 默认使用 javassist 作为编译器)编译源码,得到代理类 Class 实例。生成动态类的代码比较复杂,但是所有的动态类都是根据一个模板来生成的。

package <扩展点接口所在包>

public class <扩展点接口名>$Adpative implements <扩展点接口>{
   public <有@Adaptive注解的接口方法>(<方法参数>){
          if(是否有URL类型参数?)  使用该URL参数
          else if(是否方法类型上有URL属性) 使用该URL属性
          #
          
          if(获取的URL == null){
             throw new IllegalArgumentException("url = null")
          }
          
          根据@Adaptive注解上声明的Key的顺序,从URL获取Value,作为实际扩展点名。
          如URL没有Value,则使用缺省扩展点实现。如没有扩展点,throw new IllegalArgumentException("Fail to get extension");
          
          扩展点实现调用方法,并返回结果
   }
   
   public <没有@Adaptive注解的接口方法>(<方法参数>){
      throw new UnsupportedOperationException("is not adaptive method!")
   }

}

下面是动态生成Protocol$Adpative的代码

package org.apache.dubbo.rpc;

import org.apache.dubbo.common.extension.ExtensionLoader;

public class Protocol$Adaptive implements org.apache.dubbo.rpc.Protocol {
    private static final org.apache.dubbo.common.logger.Logger logger = org.apache.dubbo.common.logger.LoggerFactory
            .getLogger(ExtensionLoader.class);
    private java.util.concurrent.atomic.AtomicInteger count = new java.util.concurrent.atomic.AtomicInteger(0);

    public void destroy() {
        throw new UnsupportedOperationException(
                "method public abstract void org.apache.dubbo.rpc.Protocol.destroy() of interface org.apache.dubbo.rpc.Protocol is not adaptive method!");
    }

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

    public org.apache.dubbo.rpc.Invoker refer(java.lang.Class arg0, org.apache.dubbo.common.URL arg1)
            throws org.apache.dubbo.rpc.RpcException {
        if (arg1 == null)
            throw new IllegalArgumentException("url == null");
        org.apache.dubbo.common.URL url = arg1;
        String extName = (url.getProtocol() == null ? "dubbo" : url.getProtocol());
        if (extName == null)
            throw new IllegalStateException("Fail to get extension(org.apache.dubbo.rpc.Protocol) name from url("
                    + url.toString() + ") use keys([protocol])");
        org.apache.dubbo.rpc.Protocol extension = null;
        try {
            extension = (org.apache.dubbo.rpc.Protocol) ExtensionLoader
                    .getExtensionLoader(org.apache.dubbo.rpc.Protocol.class).getExtension(extName);
        } catch (Exception e) {
            if (count.incrementAndGet() == 1) {
                logger.warn(
                        "Failed to find extension named " + extName
                                + " for type org.apache.dubbo.rpc.Protocol, will use default extension dubbo instead.",
                        e);
            }
            extension = (org.apache.dubbo.rpc.Protocol) ExtensionLoader
                    .getExtensionLoader(org.apache.dubbo.rpc.Protocol.class).getExtension("dubbo");
        }
        return extension.refer(arg0, arg1);
    }

    public org.apache.dubbo.rpc.Exporter export(org.apache.dubbo.rpc.Invoker arg0)
            throws org.apache.dubbo.rpc.RpcException {
        if (arg0 == null)
            throw new IllegalArgumentException("org.apache.dubbo.rpc.Invoker argument == null");
        if (arg0.getUrl() == null)
            throw new IllegalArgumentException("org.apache.dubbo.rpc.Invoker argument getUrl() == null");
        org.apache.dubbo.common.URL url = arg0.getUrl();
        String extName = (url.getProtocol() == null ? "dubbo" : url.getProtocol());
        if (extName == null)
            throw new IllegalStateException("Fail to get extension(org.apache.dubbo.rpc.Protocol) name from url("
                    + url.toString() + ") use keys([protocol])");
        org.apache.dubbo.rpc.Protocol extension = null;
        try {
            extension = (org.apache.dubbo.rpc.Protocol) ExtensionLoader
                    .getExtensionLoader(org.apache.dubbo.rpc.Protocol.class).getExtension(extName);
        } catch (Exception e) {
            if (count.incrementAndGet() == 1) {
                logger.warn(
                        "Failed to find extension named " + extName
                                + " for type org.apache.dubbo.rpc.Protocol, will use default extension dubbo instead.",
                        e);
            }
            extension = (org.apache.dubbo.rpc.Protocol) ExtensionLoader
                    .getExtensionLoader(org.apache.dubbo.rpc.Protocol.class)
                    .getExtension("dubbo");
        }
        return extension.export(arg0);
    }
}

生成动态类之后,在createAdaptiveExtension方法会通过反射生成实例,并调用injectExtension方法进入IOC反转控制模式,实现依赖注入。

private T createAdaptiveExtension() {
        try {
            return injectExtension((T) getAdaptiveExtensionClass().newInstance());
        } catch (Exception e) {
            throw new IllegalStateException("Can not create adaptive extension " + type + ", cause: " + e.getMessage(), e);
        }
    }

到此,关于getAdaptiveExtension自适应拓展的原理,实现就分析完了。有关动态编译和依赖注入的原理下一章再分析。

getExtension(String name)

上一节我们分析了Dubbo自适应扩展机制,下面我们从 ExtensionLoader 的 getExtension 方法作为入口,对拓展类对象的获取过程进行详细的分析。

  public T getExtension(String name) {
        
        if (StringUtils.isEmpty(name)) {
            throw new IllegalArgumentException("Extension name == null");
        }
        // 获取默认的拓展实现类
        if ("true".equals(name)) {
            return getDefaultExtension();
        }
         // Holder,用于持有目标对象
        Holder holder = cachedInstances.get(name);
        if (holder == null) {
            cachedInstances.putIfAbsent(name, new Holder());
            holder = cachedInstances.get(name);
        }
        Object instance = holder.get();
        if (instance == null) {
            synchronized (holder) {
                instance = holder.get();
                if (instance == null) {
                    instance = createExtension(name);
                    holder.set(instance);
                }
            }
        }
        return (T) instance;
    }
 
 

上面了逻辑比较简单首先判断是否使用默认扩展,如果不是查找缓存,若未命中则调用createExtension创建拓展对象。

 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> wrapperClasses = cachedWrapperClasses;
            if (CollectionUtils.isNotEmpty(wrapperClasses)) {
               // 循环创建 Wrapper 实例
                for (Class wrapperClass : wrapperClasses) {
                   // 将当前 instance 作为参数传给 Wrapper 的构造方法,并通过反射创建 Wrapper 实例。
                // 然后向 Wrapper 实例中注入依赖,最后将 Wrapper 实例再次赋值给 instance 变量
                    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);
        }
    }

createExtension 方法的逻辑稍复杂一下,主要执行以下四个步骤:

  1. 通过 getExtensionClasses 获取所有的拓展类(在上一节中我们已经讲解过这个方法)。
  2. 查找缓存EXTENSION_INSTANCES中,是否有扩展实例,没有则通过反射创建拓展对象。
  3. 调用injectExtension向拓展对象中注入依赖。
  4. 将拓展对象包裹在相应的 Wrapper 对象中,在上一节以Protocol讲解自适应扩展机制中,在获取扩展实现时,将自动包装两个层,最终将获得ProtocolFilterWrapper或** ProtocolListenerWrapper**,就是在这里实现的。

第一个步骤是加载拓展类的关键,第三和第四个步骤是 Dubbo IOC 与 AOP 的具体实现。

有关getExtensionClasses分析,请看上一节,下面着重分析第三和第四步骤,先分析

Dubbo IOC

  private T injectExtension(T instance) {
        try {
            if (objectFactory != null) {
            // 遍历目标类的所有方法
                for (Method method : instance.getClass().getMethods()) {
                 // 检测方法是否以 set 开头,且方法仅有一个参数,且方法访问级别为 public
                    if (method.getName().startsWith("set")
                            && method.getParameterTypes().length == 1
                            && Modifier.isPublic(method.getModifiers())) {
                            //判断是否需要自动注入
                        if (method.getAnnotation(DisableInject.class) != null) {
                            continue;
                        }
                         // 获取 setter 方法参数类型
                        Class pt = method.getParameterTypes()[0];
                        if (ReflectUtils.isPrimitives(pt)) {
                            continue;
                        }
                        try {
                          // 获取属性名,比如 setName 方法对应属性名 name
                            String property = method.getName().length() > 3 ? method.getName().substring(3, 4).toLowerCase() + method.getName().substring(4) : "";
                            // 从 ObjectFactory 中获取依赖对象
                            Object object = objectFactory.getExtension(pt, property);
                            if (object != null) {
                             // 通过反射调用 setter 方法设置依赖
                                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;
    }

在上面代码中,objectFactory 变量的类型为 AdaptiveExtensionFactory,AdaptiveExtensionFactory 内部维护了一个 ExtensionFactory 列表,用于存储其他类型的 ExtensionFactory。Dubbo 目前提供了两种 ExtensionFactory,分别是 SpiExtensionFactory 和 SpringExtensionFactory。前者用于创建自适应的拓展,后者是用于从 Spring 的 IOC 容器中获取所需的拓展。Dubbo的IOC反转控制,就是从spi和spring里面提取对象赋值。

Dubbo AOP

下面只截取了createExtension部分代码

  if (CollectionUtils.isNotEmpty(wrapperClasses)) {
                for (Class wrapperClass : wrapperClasses) {
                    instance = injectExtension((T) wrapperClass.getConstructor(type).newInstance(instance));
                }
            }

在Protocol中wrapperClass类是ProtocolFilterWrapper或** ProtocolListenerWrapper**这两个类中的构造函数都有Protocol参数,Dubbo AOP 获取wrapperClass然通过反射生成对象,进行AOP,然后调用injectExtension 进行IOC.最后将值重新赋给instance,所以getExtension方法最后返回的是一个wrapper类。

好了Dubbo SPI实现源码解析讲完了,本篇文章就先到这里了。

你可能感兴趣的:(Dubbo内核剖析-SPI实现源码解析)