dubbo spi機制源碼學習

dubbo是微內核架構。什麼是微內核,仍是開閉原則的應用,把核心流程架構固定,但流程各個節點對從新和改進是開放的。具體實現機制就是spi(servicer provider intefance)。jdk自身有一套spi機制實現。dubbo在jdk基礎上作了擴展和改進。
這篇說說,dubbo本身實現的spijava

所謂spi,就是接口由框架定義。具體實現能夠有不一樣提供商提供不一樣的實現。
打開dubbo jar包能夠發如今/META-INF/dubbo/internal目錄下,有許多接口名命名的文件
而文件內容就是,文件名錶明接口的各類實現類。這就是dubbo spi機制配置基礎。
以com.alibaba.dubbo.rpc.Protocol文件爲例,內容以下(dubbo2.5.6版本)web

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接口目前有這麼多具體擴展實現,
「=」號前面是擴展名,後面是擴展實現類。redis

SPI的啓動使用入口類是ExtensionLoader。這個類沒定義public定構造函數,只有一個private的而public的靜態方法也只有一個getExtensionLoader,這也是使用spi的入口方法。spring

若想取得某個接口類型的擴展,必須先獲取對應的ExtensionLoadersql

/***
     * 獲取某個接口的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()方法:app

/**
     * 返回指定名字的擴展。若是指定名字的擴展不存在,則拋異常 {@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);
        }
    }

 這裏先沿着着第一步驟流程分析:jvm

//跟蹤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,依賴注入流程分析:

//看下方法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類裏其餘方法也基本都依賴以上方法,變量。
相關文章
相關標籤/搜索