Dubbo源码分析系列-深入Dubbo SPI机制

灰太狼 2021-10-13 22:48 466阅读 0赞

> 导语  
>   在之前的博客中介绍过关于Java中SPI的机制，也简单的分析了关于Java中SPI怎么去使用。SPI的全称Service Provider Interface，是一种服务发现机制。SPI的本质就是将接口实现类的全类名配置到文件中，通过类加载器来读取配置文件，从而达到类加载的目的。这样在运行的时候可以替换接口实现类。所以在很多的第三方框架中都使用到了这个技术。最为典型的就是关于日志的处理、关于数据库的处理等等。

## Dubbo SPI 源码分析 ##

在之前的博客中提到了Dubbo的扩展机制以及Java的SPI机制，其中提到了一个比较关键的类ExtensionLoader，这个类作为扩展类加载器的核心类。都知道在Java类加载机制中有四种类加载器，BootstrapClassLoader类加载器、ExtClassLoader扩展类加载器、ApplicationClassLoader 应用类加载器以及自定义类加载器。对于这几个类加载器在Java类加载机制中都有提到。这里我们通过Dubbo提供的ExtensionLoader扩展类加载器来深入了解一下Dubbo的SPI机制。  
**在ExtensionLoader类中怎么去获取一个ExtensionLoader实例**  
  在分析之前我们先来看一下，阿里把Dubbo项目给Apache之后，Apache给Dubbo做了很多的重构，在源码中很多阿里开发的功能被抛弃了。而这个类扩展功能org.apache.dubbo.common.extension.ExtensionLoader 也是被Apache重新编写。  
  在ExtensionLoader中提供了一个getExtensionLoader()通过传入的类型来获取到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 an interface!");
            }
            //判断该类型是否标注了@SPI注解也就是说是否是一个扩展类型
            if (!withExtensionAnnotation(type)) { 
                throw new IllegalArgumentException("Extension type (" + type +
                        ") is not an extension, because it is NOT annotated with @" + SPI.class.getSimpleName() + "!");
            }
    
    		//从缓存中获取到对应类型的扩展类加载器
            ExtensionLoader<T> loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);
            //如果加载器为空，则先进行创建，然后再次从缓存中获取
            if (loader == null) { 
                EXTENSION_LOADERS.putIfAbsent(type, new ExtensionLoader<T>(type));
                loader = (ExtensionLoader<T>) EXTENSION_LOADERS.get(type);
            }
            return loader;
        }

在那么当获取到扩展类加载器之后接下来的操作是什么呢？对于这些框架的底层实现来说有一个对应的获取扩展类的方法就会有一个对应的实现扩展的方法。下面就来看看这个实现扩展的方法。

public T getExtension(String name) { 
     		//获取通过名称进行获取
            if (StringUtils.isEmpty(name)) { 
                throw new IllegalArgumentException("Extension name == null");
            }
            if ("true".equals(name)) { 
            	//获取默认的扩展实现类
                return getDefaultExtension();
            }
            //创建一个目标持有对象
            final Holder<Object> holder = getOrCreateHolder(name);
            //获取对象实例
            Object instance = holder.get();
            //如果获取到对象为空，启动一个双重检查，
            if (instance == null) { 
                synchronized (holder) { 
                    instance = holder.get();‘
                    //如果确实没有对应的实例
                    if (instance == null) { 
                    	//创建一个扩展实例
                        instance = createExtension(name);
                        //将实例设置到holder
                        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, clazz.newInstance());
                    instance = (T) EXTENSION_INSTANCES.get(clazz);
                }
                //注入扩展实例
                injectExtension(instance);
                //获取包装类
                Set<Class<?>> 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 + ") couldn't be instantiated: " + t.getMessage(), t);
            }
        }

在这里会看到其中有几个关键方法  
当进入到该方法的时候进行一个扩展类的获取

> Class<?> clazz = getExtensionClasses().get(name);

通过扩展类获取到对应的实例

> EXTENSION\_INSTANCES.putIfAbsent(clazz, clazz.newInstance());

这是比较关键的一点，这里其实就是Dubbo的IOC以及AOP的具体实现。下面就来看看这几个方法的具体实现

> instance = injectExtension((T) wrapperClass.getConstructor(type).newInstance(instance));

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

首先检查缓存中是否存在对应的加载类。如果缓存中没有的话，通过synchronized加锁之后再次进行检查，如果加锁之后的检查还是为空，这时就通过loadExtensionClasses()方法加载扩展类。那么loadExtensionClasses()方法的内部实现又是什么样子的呢？

// synchronized in getExtensionClasses
    private Map<String, Class<?>> loadExtensionClasses() { 
    		//缓存默认扩展类加载
            cacheDefaultExtensionName();
    		//创建映射对象
            Map<String, Class<?>> extensionClasses = new HashMap<>();
            //把阿里的目录替换成了Apache的目录进行获取
            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;
        }

在这里会看到Apache官方提供了一个新的扩展加载方式，所以说在保留原来的基础上对于该方法进行了修改。这里我们来查看cacheDefaultExtensionName()方法，这个方法就是阿里原生提供的方法逻辑

private void cacheDefaultExtensionName() { 
    		//首先获取到SPI注解
            final SPI defaultAnnotation = type.getAnnotation(SPI.class);
            //如果获取到的注解不为空
            if (defaultAnnotation != null) { 
            	//获取到注解对应的value
                String value = defaultAnnotation.value();
                if ((value = value.trim()).length() > 0) { 
                	//按照value进行分隔。
                    String[] names = NAME_SEPARATOR.split(value);
                    //判断SPI内是否有非法内容如果存在非法内容则抛出异常。
                    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];
                    }
                }
            }
        }

cahcedDefaultName使用的位置如图所示。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70]  
其中最为重要的就是在getDefaultExtension() 方法中的使用了了这个方法中会使用默认名称进行加载

public T getDefaultExtension() { 
            getExtensionClasses();
            if (StringUtils.isBlank(cachedDefaultName) || "true".equals(cachedDefaultName)) { 
                return null;
            }
            return getExtension(cachedDefaultName);
        }

在上面的一段代码的分析中，可以看到loadExtensionClasses() 方法提供了两个方面的内容一个是对于SPI注解的解析，一个调用laodDirectory方法加载类所指定的配置文件。上的分析可以看到解析SPI注解就是为了获取其中的value。下面来看一下loadDirectory() 方法的使用  
  我们会注意到这些方法都是没有返回值的，其中操作的所有的内容都是被放到缓存中。这个点也是在Java编程中一个关键点，多使用缓存减少创建对象性能的消耗。

private void loadDirectory(Map<String, Class<?>> extensionClasses, String dir, String type) { 
     		//拼接文件名称
            String fileName = dir + type;
            try { 
            	//定义一个枚举类型
                Enumeration<java.net.URL> urls;
                //获取类加载器
                ClassLoader classLoader = findClassLoader();
                if (classLoader != null) { 
                	//通过类名获取url
                    urls = classLoader.getResources(fileName);
                } else { 
                    urls = ClassLoader.getSystemResources(fileName);
                }
                if (urls != null) { 
                
                    while (urls.hasMoreElements()) { 
                    	//进行加载资源
                        java.net.URL resourceURL = urls.nextElement();
                        loadResource(extensionClasses, classLoader, resourceURL);
                    }
                }
            } catch (Throwable t) { 
                logger.error("Exception occurred when loading extension class (interface: " +
                        type + ", description file: " + fileName + ").", t);
            }
        }

可以看到loadDirectory() 方法先通过classLoader获取的所有资源的URL，然后通过loadResource进行资源的加载操作。获取资源的方法就不需要在看了，这里主要来跟一下怎么去加载这个资源。

private void loadResource(Map<String, Class<?>> extensionClasses, ClassLoader classLoader, java.net.URL resourceURL) { 
            try { 
                try (BufferedReader reader = new BufferedReader(new InputStreamReader(resourceURL.openStream(), StandardCharsets.UTF_8))) { 
                	//获取到文件流对象
                    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方法对其进行缓存
                                    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);
                            }
                        }
                    }
                }
            } catch (Throwable t) { 
                logger.error("Exception occurred when loading extension class (interface: " +
                        type + ", class file: " + resourceURL + ") in " + resourceURL, t);
            }
        }

这里可以知道loadResource方法主要是用来读取和解析配置文件，并且通过反射加载类，最后调用loadClass方法进行其他操作，而loadClass方法主要的作用是什么？下面就来研究一下

private void loadClass(Map<String, Class<?>> extensionClasses, java.net.URL resourceURL, Class<?> clazz, String name) throws NoSuchMethodException { 
            if (!type.isAssignableFrom(clazz)) { 
                throw new IllegalStateException("Error occurred when loading extension class (interface: " +
                        type + ", class line: " + clazz.getName() + "), class "
                        + clazz.getName() + " is not subtype of interface.");
            }
            //检查目标类上是否有Adaptive 注解
            if (clazz.isAnnotationPresent(Adaptive.class)) { 
            	//设置Adaptive的缓存
                cacheAdaptiveClass(clazz);
            } else if (isWrapperClass(clazz)) { 
            	//设置Wrapper的缓存
                cacheWrapperClass(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);
                    }
                }
    			//切分name
                String[] names = NAME_SEPARATOR.split(name);
                if (ArrayUtils.isNotEmpty(names)) { 
                	//如果类上面有Activate注解，使用name数组第一个作为键，
                	//存储name到Activate 注解对象的映射关系
                    cacheActivateClass(clazz, names[0]);
                    for (String n : names) { 
                    	//缓存名称
                        cacheName(clazz, n);
                        //在扩展类中进行存储
                        saveInExtensionClass(extensionClasses, clazz, n);
                    }
                }
            }
        }

到这里关于缓存类以及类加载的过程就结束了，通过整个过程的分析可以看到Apache在阿里的基础上做到额改动还是很大的，但是基本的原理还是与Java的SPI机制是一样的。

## 总结 ##

在这里会看到通过Dubbo源码Apache对于Dubbo的SPI机制还是有很大的改动的，从类的路径获取上，注解的获取上都做了一定的优化，但是万变不离其宗。整个的设计原则还是按照JavaSPI提供的思路来设计的。所以首先要了解的就是Java的SPI机制以及类加载机制反射机制等等再去了解Dubbo的SPI机制会很容易理解。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L25paHVpMTIz_size_16_color_FFFFFF_t_70]: /images/20211013/e8fea5e39458441dac0d3e4c20b99fad.png