dubbo的spi机制

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/Andyzhu_2005/article/details/83115985

dubbo的spi机制

dubbo的扩展点加载机制源自于java的spi扩展机制。那么,何为java的spi扩展机制?

java的spi扩展机制

作为接口编程的一种典型应用,系统在设计某个功能模块时(需要其他的框架提供),只定义了接口,而服务提供者需要根据spi的相关规范,进行接口实现类的实现。而我们的系统不需要重新进行编译或者生成,即可以使用接口的新的实现类。

java的spi的步骤:

  1. 在META-INF/services/目录中创建以接口全限定名命名的文件该文件内容为Api具体实现类的全限定名
  2. 使用ServiceLoader类动态加载META-INF中的实现类
  3. 如SPI的实现类为Jar则需要放在主程序classPath中
  4. Api具体实现类必须有一个不带参数的构造方法
    具体案例:
    https://download.csdn.net/download/andyzhu_2005/10808099

dubbo的spi

dubbo的spi源于java的spi,但是做了如下两点改进:
1、java的spi一次性初始化所有的扩展实现,比较浪费时间。(这一点不太理解,其实dubbo中对于相关的接口的扩展实现,貌似也是一次性加载所有的)
2、dubbo存在接口名字命名的文件是以键值对形式存储的,可以通过名字快速寻找,而不需要像java原生的spi,需要通过iterator.hasNext()迭代寻找
3、扩展点自动装配功能(IOC)和aop功能(filter以及listener等wrapper)

何为 实现了ioc及aop功能

就是当加载一个扩展点时,会自动的注入这个扩展点所依赖的其他扩展点,如果描述不清楚的话,可以看下下面的例子:

接口A,实现类A1,A2
接口B,实现类B1,B2
其中实现类A1含有setB()方法,当通过扩展机制加载A的实现的时候,会自动的注入一个B的实现类,但是,此时不是注入B1,也不是注入B2,而是注入一个自适应的B的实现类:B$Adpative,该实现类是动态生成的,能够根据参数的不同,自动选择B1或者B2来进行调用。

扩展点使用单一实例加载,需要确保线程安全性。?

@Adaptive注解,有两种注解方式:一种是注解在类上,一种是注解在方法上。

注解在类上,而且是注解在实现类上,目前dubbo只有AdaptiveCompiler和AdaptiveExtensionFactory类上标注了此注解,这是些特殊的类,ExtensionLoader需要依赖他们工作,所以得使用此方式。
注解在方法上,注解在接口的方法上,除了上面两个类之外,所有的都是注解在方法上。ExtensionLoader根据接口定义动态的生成适配器代码,并实例化这个生成的动态类。被Adaptive注解的方法会生成具体的方法实现。没有注解的方法生成的实现都是抛不支持的操作异常UnsupportedOperationException。被注解的方法在生成的动态类中,会根据url里的参数信息,来决定实际调用哪个扩展。

扩展点的加载

在dubbo中,正常的spi扩展基本都如下:

/这样使用,先获取ExtensionLoader实例,然后加载自适应的Protocol扩展点
Protocol protocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension();
//使用
protocol.refer(Class<T> type, URL url));

1、第一步,getExtensionLoader(Protocol.class),根据要加载的接口Protocol,创建出一个ExtensionLoader实例,加载完的实例会被缓存起来,下次再加载Protocol的ExtensionLoader的时候,会使用已经缓存的这个,不会再新建一个实例:
2、getAdaptiveExtension()方法:相当于对于 ExtensionLoader.getExtensionLoader(Protocol.class)的ExtensionLoader实例,对相关的文件路径下,找到所有的此接口的实现,并实例化;
3、protocol.refer(Class type, URL url));通过接口的方法的url,找到protocol的具体实现名,比如dubbo,从而找到真正的protocol的实现,dubboprotocol的refer,执行。

每一个spi扩展(即有@spi注解的接口)都对应着一个ExtensionLoader,互相独立。而每个ExtensionLoader负责加载这个spi扩展下所有的实现(一次性的)。比如protocol对应的ExtensionLoader。

源码分析(以dubboprotocol为例):

 private static final Protocol protocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension();

这句代码就是获取protocol 的自适应实现。返回的protocol 实例会根据url的protocol的名称来加载不同的实现类。

ExtensionLoader.getExtensionLoader(Protocol.class)源码解析

    @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!");
        }
        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) {
            EXTENSION_LOADERS.putIfAbsent(type, new ExtensionLoader<T>(type));
            loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);
        }
        return loader;
    }

看下面这两句代码:

 EXTENSION_LOADERS.putIfAbsent(type, new ExtensionLoader<T>(type));
            loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);
ExtensionLoader<T> loader = (ExtensionLoader<T>) 

将断点打在 EXTENSION_LOADERS.get(type);上,当tpye是protocol时候,F6单句执行。
上面方法中

       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);
        }

EXTENSION_LOADERS是一个线程安全的ExtensionLoader的hashmap集合,集合的名就是各个type,比如com.alibaba.dubbo.rpc.Protocol,com.alibaba.dubbo.common.extension.ExtensionFactory等,都是被@spi注解的接口名称。第一次加载的时候,loader 为空,则执行 EXTENSION_LOADERS.putIfAbsent(type, new ExtensionLoader(type));
关注 new ExtensionLoader(type)方法,就是获得这个type(这里就是protocol)的ExtensionLoader。dubbo中大量的使用了这种缓存技术。

看ExtensionLoader的构造方法。是private的,即只能在类里内部调用,

    private ExtensionLoader(Class<?> type) {
        this.type = type;
        //如果type不是ExtensionFactory,则objectFactory 就是ExtensionFactory.class的扩展。
        objectFactory = (type == ExtensionFactory.class ? null : ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension());
    }

这里的objectFactory 可以理解为dubbo的容器,类似于spring的beanfactory,主要用于dubbo的ioc功能。后续再研究。
new ExtensionLoader(type)执行完,返回了protocol所属的ExtensionLoader,主要工作就是获得了一个objectFactory。

.getAdaptiveExtension();源码解析

接下来执行 private static final Protocol protocol = ExtensionLoader.getExtensionLoader(Protocol.class).getAdaptiveExtension();的getAdaptiveExtension()方法。
用于获取protocol的自适应类。(这些工作都是在ExtensionLoader类里执行,目前type=protocol)。

    public T getAdaptiveExtension() {
        Object instance = cachedAdaptiveInstance.get();
        //这里双重的instance == null有点像单例模式的双重检测,避免线程不安全
        if (instance == null) {
            if(createAdaptiveInstanceError == null) {
                synchronized (cachedAdaptiveInstance) {
                    instance = cachedAdaptiveInstance.get();
                    if (instance == null) {
                        try {
                        //instance ==null,进入createAdaptiveExtension()
                            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;
    }

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

instance为空,进入createAdaptiveExtension()方法,创建自适应扩展实现。 return injectExtension((T) getAdaptiveExtensionClass().newInstance());先看看getAdaptiveExtensionClass(),根据名称应该是获取到类名,后面的newInstance()是java的根据类名生成实例的操作。

  private Class<?> getAdaptiveExtensionClass() {
        getExtensionClasses();
        if (cachedAdaptiveClass != null) {
            return cachedAdaptiveClass;
        }
        return cachedAdaptiveClass = createAdaptiveExtensionClass();
    }

然后进入getExtensionClasses()

	private Map<String, Class<?>> getExtensionClasses() {
        Map<String, Class<?>> classes = cachedClasses.get();
        if (classes == null) {
            synchronized (cachedClasses) {
                classes = cachedClasses.get();
                if (classes == null) {
                    classes = loadExtensionClasses();
                    cachedClasses.set(classes);
                }
            }
        }
        return classes;
	}
/**
加载所有的实现类
**/
    private Map<String, Class<?>> loadExtensionClasses() {
    //获得接口的spi注解
        final SPI defaultAnnotation = type.getAnnotation(SPI.class);
        if(defaultAnnotation != null) {
            String value = defaultAnnotation.value();
            if(value != null && (value = value.trim()).length() > 0) {
            //正则表达式,如果spi注解的名字不止一个的话报错
                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];
            }
        }
        
        Map<String, Class<?>> extensionClasses = new HashMap<String, Class<?>>();
        //把相关路径下的类(对于protocol接口而言)全都加载到extensionClasses 中来
        loadFile(extensionClasses, DUBBO_INTERNAL_DIRECTORY);
        loadFile(extensionClasses, DUBBO_DIRECTORY);
        loadFile(extensionClasses, SERVICES_DIRECTORY);
        return extensionClasses;
    }

查看loadFile的方法,这个类主要就是把路径下的下面的protocol的接口实现类全部根据类名通过反射实例化

registry=com.alibaba.dubbo.registry.integration.RegistryProtocol
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
dubbo=com.alibaba.dubbo.rpc.protocol.dubbo.DubboProtocol
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=memcom.alibaba.dubbo.rpc.protocol.memcached.MemcachedProtocol
redis=com.alibaba.dubbo.rpc.protocol.redis.RedisProtocol
  private void loadFile(Map<String, Class<?>> extensionClasses, String dir) {
        String fileName = dir + type.getName();
        try {
            Enumeration<java.net.URL> 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 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的形式 registry=com.alibaba.dubbo.registry.integration.RegistryProtocol
                                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) {
                                        //返回类,
                                            Class<?> clazz = Class.forName(line, true, classLoader);
                                            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.class注解,如果有的话,说明这个类就是这个spi扩展的默认强制实现类(即不会根据url的spi的名称来找对应的实现类,并存入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());
                                                }
                                            } else {
                                                try {
                                                //判断这个类有没有以protocol接口实现类作为构造方法的参数,如果有,就说明是wrapper类,把它放入cachedWrapperClasses 类中,比如就是ProtocolFilterWrapper  。如果不是的话,直接进入下面的catch块
                                                    clazz.getConstructor(type);
                                                    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 = clazz.getAnnotation(Activate.class);
                                                        if (activate != null) {
                                                            cachedActivates.put(names[0], activate);
                                                        }
                                                        for (String n : names) {
                                                            if (! cachedNames.containsKey(clazz)) {
                                                                cachedNames.put(clazz, n);
                                                            }
                                                            Class<?> c = extensionClasses.get(n);
                                                            if (c == null) {
                                                            //把类放入extensionClasses中
                                                                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);
        }
    }

getExtensionClasses()执行完, 我们的extensionClasses已经存了关于protocol接口所有的以<名称,类>的hashmap集合了。下面进入createAdaptiveExtensionClass()方法,用于

    private Class<?> getAdaptiveExtensionClass() {
        getExtensionClasses();
        if (cachedAdaptiveClass != null) {
            return cachedAdaptiveClass;
        }
        return cachedAdaptiveClass = createAdaptiveExtensionClass();
    }


    private Class<?> createAdaptiveExtensionClass() {
        String code = createAdaptiveExtensionClassCode();
        ClassLoader classLoader = findClassLoader();
        com.alibaba.dubbo.common.compiler.Compiler compiler = ExtensionLoader.getExtensionLoader(com.alibaba.dubbo.common.compiler.Compiler.class).getAdaptiveExtension();
        return compiler.compile(code, classLoader);
    }

createAdaptiveExtensionClass()方法会自动的拼接一个关于protocol接口的自适应类,并会通过dubbo的编译器对这个类进行编译。生成的类如下:

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

public class Protocol$Adpative implements com.alibaba.dubbo.rpc.Protocol {
    @SuppressWarnings("unchecked")
	public com.alibaba.dubbo.rpc.Invoker refer(java.lang.Class arg0, com.alibaba.dubbo.common.URL arg1) {
        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);
    }

    @SuppressWarnings("unchecked")
	public com.alibaba.dubbo.rpc.Exporter export(com.alibaba.dubbo.rpc.Invoker arg0)  {
        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();
        //根据URL配置信息获取Protocol协议,默认是dubbo
        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])");
            //根据协议名,获取Protocol的实现
            //获得Protocol的实现过程中,会对Protocol先进行依赖注入,然后进行Wrapper包装,最后返回被修改过的Protocol
            //包装经过了ProtocolFilterWrapper,ProtocolListenerWrapper,RegistryProtocol
        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);
    }

    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!");
    }
}

这样就返回了protocol的自适应扩展类,其通过extName ,获取对应的实现类

protocol.export(Class type, URL url))源码解析

,比如我们调用dubboprotocol的export方法,则 通过上面的 生成的Protocol$Adpative类,根据url中的protocol的具体名字,下面的getExtension(extName)获取到对应的实例

  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);

看看objectFactory 是什么东西

 private ExtensionLoader(Class<?> type) {
        this.type = type;
        //如果type不是ExtensionFactory,则objectFactory 就是ExtensionFactory.class的扩展。
        objectFactory = (type == ExtensionFactory.class ? null : ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension());
    }

在ExtensionLoader类中有一个参数是objectFactory ,这个参数就是dubbo中的容器。
事实上,每一个ExtensionLoader都会有这么个objectFactory 。比如,我们在断点调试的时候,最先加载spi扩展的接口是com.alibaba.dubbo.common.threadpool.ThreadPool,那么在通过

//这里的tpye=com.alibaba.dubbo.common.threadpool.ThreadPool
   private ExtensionLoader(Class<?> type) {
        this.type = type;
        objectFactory = (type == ExtensionFactory.class ? null : ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension());
    }

实现ThreadPool的spi扩展时候,就会进行ExtensionLoader.getExtensionLoader(ExtensionFactory.class).getAdaptiveExtension())的操作,从而又编程对ExtensionFactory的spi加载或者加载完成后进行获取。
ExtensionFactory接口的spi扩展还是通过ExtensionLoader来实现的。
看一下他的实现。
在方法

 public static <T> ExtensionLoader<T> getExtensionLoader(Class<T> type)

中,如果传进来的是com.alibaba.dubbo.common.extension.ExtensionFactory,则我们在初始化 ExtensionLoader(Class<?> type)时候,objectFactory 为null。(这里的理解是我现在要通过ExtensionLoader类生成objectFactory ,所以ExtensionLoader类的构造方法中是不会有objectFactory 这个实例的,还没有生成嘛)
返回ExtensionLoader实例后,执行getAdaptiveExtension()操作,通过上面的分析,我们先看看ExtensionFactory有几个实现类。
adaptive=com.alibaba.dubbo.common.extension.factory.AdaptiveExtensionFactory
spi=com.alibaba.dubbo.common.extension.factory.SpiExtensionFactory
spring=com.alibaba.dubbo.config.spring.extension.SpringExtensionFactory
即有三个实现类,再查看com.alibaba.dubbo.common.extension.factory.AdaptiveExtensionFactory
spi=com.alibaba.dubbo.common.extension.factory.SpiExtensionFactory这个类,其类上有@Adaptive注解,说明这个类是ExtensionFactory的默认强制实现。

    public AdaptiveExtensionFactory() {
        ExtensionLoader<ExtensionFactory> loader = ExtensionLoader.getExtensionLoader(ExtensionFactory.class);
        List<ExtensionFactory> list = new ArrayList<ExtensionFactory>();
        for (String name : loader.getSupportedExtensions()) {
            list.add(loader.getExtension(name));
        }
        factories = Collections.unmodifiableList(list);
    }

上面方法就是把extension的两个spi扩展实现
spi=com.alibaba.dubbo.common.extension.factory.SpiExtensionFactory
spring=com.alibaba.dubbo.config.spring.extension.SpringExtensionFactory
给加载进来。
上面方法中的loader.getExtension(name),(name就是extensionFactory),就是获得spi扩展的具体实现。这里的实现是指已经通过newInstance获得类的实例。

    /**
     * 返回指定名字的扩展。如果指定名字的扩展不存在,则抛异常 {@link IllegalStateException}.
     *
     * @param name
     * @return
     */
	@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);
		}
		Object instance = holder.get();
		if (instance == null) {
		    synchronized (holder) {
	            instance = holder.get();
	            if (instance == null) {
	                instance = createExtension(name);
	                holder.set(instance);
	            }
	        }
		}
		return (T) instance;
	}


  @SuppressWarnings("unchecked")
    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, (T) clazz.newInstance());
                instance = (T) EXTENSION_INSTANCES.get(clazz);
            }
            injectExtension(instance);
            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);
        }
    }
    
    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())) {
                        Class<?> pt = method.getParameterTypes()[0];
                        try {
                            String property = method.getName().length() > 3 ? method.getName().substring(3, 4).toLowerCase() + method.getName().substring(4) : "";
                            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;
    }

而在之后的方法中会用到objectFactory.getExtension(pt, property);

    public <T> T getExtension(Class<T> type, String name) {
        for (ExtensionFactory factory : factories) {
            T extension = factory.getExtension(type, name);
            if (extension != null) {
                return extension;
            }
        }
        return null;
    }

再看看两个spi的具体实现:
第一个SpiExtensionFactory:

    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) {
                return loader.getAdaptiveExtension();
            }
        }
        return null;
    }

}

上面的方法是如果接口有spi注解,那就返回这个接口的自适应扩展实现。
而SpringExtensionFactory的实现就是正常的如果这个接口在spring容器里有,那就从容器中取。

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

}

所以,从上面可以看出,objectFactory就是一个容器,通过接口名获得相应的实例。
那么在哪里可以用到呢。dubbo中,可以实现实例的依赖注入功能。在createAdaptiveExtension()方法中,通过spi扩展获得自适应实现类的时候,前面的injectExtension()方法就是对实例中的set方法,进行属性的自动加载。

    private T createAdaptiveExtension() {
        try {
            return injectExtension((T) getAdaptiveExtensionClass().newInstance());
        } catch (Exception e) {
            throw new IllegalStateException("Can not create adaptive extenstion " + type + ", cause: " + e.getMessage(), e);
        }
    }
    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())) {
                            // pt =interface com.alibaba.dubbo.rpc.Protocol等有spi注解的接口
                        Class<?> pt = method.getParameterTypes()[0];
                        try {
                        //public void com.alibaba.dubbo.rpc.proxy.wrapper.StubProxyFactoryWrapper.setProtocol(com.alibaba.dubbo.rpc.Protocol)
                        //这里的 method.getName().substring(3, 4)就是p,method.getName().substring(4) 就是rotocol,即把Protocol首字母小写,取出来
                            String property = method.getName().length() > 3 ? method.getName().substring(3, 4).toLowerCase() + method.getName().substring(4) : "";
                            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;
    }
展开阅读全文

没有更多推荐了,返回首页