• 实现原理

    getAdaptiveExtension

    关于getAdaptiveExtension方法我们在上篇文章已经讲过,此方法就是通过双检查法来从缓存中获取Adaptive实例,如果没获取到,则创建一个。

        public T getAdaptiveExtension() {
            //从装载适配器实例缓存里面找
            Object instance = cachedAdaptiveInstance.get();
            if (instance == null) {
                //创建cachedAdaptiveInstance异常
                if (createAdaptiveInstanceError != null) {
                    throw new IllegalStateException("Failed to create adaptive instance: " +
                            createAdaptiveInstanceError.toString(),
                            createAdaptiveInstanceError);
                }

                synchronized (cachedAdaptiveInstance) {
                    instance = cachedAdaptiveInstance.get();
                    if (instance == null) {
                        try {
                            //创建对应的适配器类
                            instance = createAdaptiveExtension();
                            //缓存
                            cachedAdaptiveInstance.set(instance);
                        } catch (Throwable t) {
                            createAdaptiveInstanceError = t;
                            throw new IllegalStateException("Failed to create adaptive instance: " + t.toString(), t);
                        }
                    }
                }
            }

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

    getAdaptiveExtensionClass

    在getAdaptiveExtensionClass方法中有两个分支,如果某个子类标注了@Adaptive注解,那么就会使用该子类所自定义的Adaptive机制,如果没有子类标注该注解,那么就会使用下面的createAdaptiveExtensionClass()方式来创建一个目标类class对象。整个过程通过AdaptiveClassCodeGenerator来为目标类生成子类代码,并以字符串的形式返回,最后通过javassist或jdk的方式进行编译然后返回class对象。

        private Class<?> getAdaptiveExtensionClass() {
            //获取所有的扩展类
            getExtensionClasses();
            //如果可以适配
            if (cachedAdaptiveClass != null) {
                return cachedAdaptiveClass;
            }
            //如果没有适配扩展类就创建
            return cachedAdaptiveClass = createAdaptiveExtensionClass();
        }
        private Class<?> createAdaptiveExtensionClass() {
            //生成代码片段
            String code = new AdaptiveClassCodeGenerator(type, cachedDefaultName).generate();
            //获取ClassLoader
            ClassLoader classLoader = findClassLoader();
            //通过jdk或者javassist的方式编译生成的子类字符串,从而得到一个class对象
            org.apache.dubbo.common.compiler.Compiler compiler =
                    ExtensionLoader.getExtensionLoader(org.apache.dubbo.common.compiler.Compiler.class).getAdaptiveExtension();
            //编译
            return compiler.compile(code, classLoader);
        }

    generate

    generate方法是生成目标类的方法,其实和创建一个类一样,其主要四个步骤:

        public String generate() {
            // 判断目标接口是否有方法标注了@Adaptive注解,如果没有则抛出异常
            if (!hasAdaptiveMethod()) {
                throw new IllegalStateException("No adaptive method exist on extension " + type.getName() + ", refuse to create the adaptive class!");
            }

            StringBuilder code = new StringBuilder();
            //生成package
            code.append(generatePackageInfo());
            //生成import信息 只导入了ExtensionLoader类,其余的类都通过全限定名的方式来使用
            code.append(generateImports());
            //生成类声明信息
            code.append(generateClassDeclaration());

            Method[] methods = type.getMethods();
            //为各个方法生成实现方法信息
            for (Method method : methods) {
                code.append(generateMethod(method));
            }
            code.append("}");

            if (logger.isDebugEnabled()) {
                logger.debug(code.toString());
            }
            //返回class代码
            return code.toString();
        }

    接下来主要看方法实现的生成,对于包路径、类的生成的代码相对比较简单,这里进行忽略,对于方法生成主要包含以下几个步骤:

        private String generateMethod(Method method) {
            //获取方法返回值
            String methodReturnType = method.getReturnType().getCanonicalName();
            //获取方法名称
            String methodName = method.getName();
            //获取方法体内容
            String methodContent = generateMethodContent(method);
            //获取方法参数
            String methodArgs = generateMethodArguments(method);
            //生成异常信息
            String methodThrows = generateMethodThrows(method);
            //格式化
            return String.format(CODE_METHOD_DECLARATION, methodReturnType, methodName, methodArgs, methodThrows, methodContent);
        }

    需要注意的是,这里所使用的所有类都是使用的其全限定类名,在上面生成的代码中也可以看到,在方法生成的整个过程中,方法的返回值,方法名,方法参数以及异常信息都可以通过反射的信息获取到,而方法体则需要根据一定规则来生成,这里我们要看一下方法体是如何生成的;

        private String generateMethodContent(Method method) {
            //获取Adaptive的注解信息
            Adaptive adaptiveAnnotation = method.getAnnotation(Adaptive.class);
            StringBuilder code = new StringBuilder(512);
            if (adaptiveAnnotation == null) {
                //如果当前方法没有被Adaptive修饰则需要抛出异常
                return generateUnsupported(method);
            } else {
                //获取参数中类型为URL的参数所在的参数索引位 通过下标获取对应的参数值信息
                int urlTypeIndex = getUrlTypeIndex(method);

                if (urlTypeIndex != -1) {
                    //如果参数中存在URL类型的参数,那么就为该参数进行空值检查,如果为空,则抛出异常
                    code.append(generateUrlNullCheck(urlTypeIndex));
                } else {
                    //如果参数中不存在URL类型的参数,则会检查每个参数,判断是否有某个方法的返回类型是URL类型,
                    //如果存在该方法,首先对该参数进行空指针检查,如果为空则抛出异常。如果不为空则调用该对象的目标方法,
                    //获取URL对象,然后对获取到的URL对象进行空值检查,为空抛出异常。
                    code.append(generateUrlAssignmentIndirectly(method));
                }
                //获取@Adaptive注解的参数,如果没有配置,就会使用目标接口的类型由驼峰形式转换为点分形式
                //的名称作为将要获取的参数值的key名称
                String[] value = getMethodAdaptiveValue(adaptiveAnnotation);

                //判断是否存在Invocation类型的参数 关于这个对象我们在后续章节在进行讲解
                boolean hasInvocation = hasInvocationArgument(method);

                //为Invocation类型的参数添加空值检查的逻辑
                code.append(generateInvocationArgumentNullCheck(method));

                //生成获取extName的逻辑,获取用户配置的扩展的名称
                code.append(generateExtNameAssignment(value, hasInvocation));
                //extName空值检查代码
                code.append(generateExtNameNullCheck(value));
                
                //通过extName在ExtensionLoader中获取其对应的基础服务类
                code.append(generateExtensionAssignment());

                //生成实例的当前方法的调用逻辑,然后将结果返回
                code.append(generateReturnAndInvocation(method));
            }

            return code.toString();
        }

    上面整体的逻辑还是比较清楚的,通过对比PersonService$Adaptive生成我们可以更容易理解改代码生成的过程,整体的逻辑可以分为四步:

    结束

    欢迎大家点点关注,点点赞!Dubbo-Adaptive实现原理-LMLPHP

    09-05 15:56