Dubbo中参数回调 Callback 实现深究

参数回调 Callback是Dubbo中一种机制,与调用本地callback相同,将基于长连接生成反向代理在服务端执行客户端的逻辑,本文将以以下内容展开。

  1. callback例子
  2. callback中,关键配置,服务端对于 配置了 <dubbo:argument index="1" callback="true"/> ,是怎么处理的。
  3. 为什么客户端虽然没有对callback指定,但是如果服务端不指定callback,而客户端为什么会报错?
  4. 服务端收到消息后,对callback有特殊处理吗?
  5. 服务端是通过怎样方式调用客户端逻辑?通过zk上面节点信息call,还是怎样呢?
  6. 客户端中,传递过去的 为一个类,有什么处理?
  7. 客户端又是如何相应 服务端发起的回调呢?
  8. 客户端回调,是通过新的new 对象调用,还是基于旧实例调用呢?

例子

何为在服务器执行客户端逻辑?简单点说,就是客户端可以定义一个方法,而此方法调用方为服务端。 要使用参数回调这个功能,有两个要素:

  1. 服务端对该Service 需要配置需要回调的参数。
  2. 客户端调用对应服务端 Service 对象时,传入对应逻辑。 而 服务端配置例子如下:
     <dubbo:service interface="com.anla.rpc.callback.provider.service.CallbackService" ref="callbackService" connections="1" callbacks="1000">
     <dubbo:method name="addListener">
         <dubbo:argument index="1" callback="true" />
         <!--也可以通过指定类型的方式-->
         <!--<dubbo:argument type="com.demo.CallbackListener" callback="true" />-->
     </dubbo:method>
    </dubbo:service>
    

具体例子地址在这里:Callback 参数回调

服务端配置

前几篇文章分析了 服务端配置及初始化过程,有兴趣同学可以回看,这里只拎初对Callback 的单独配置。 provider的初始化过程B:外部化配置初始化过程 Provider的初始化过程C:服务暴露详解

当服务暴露是,主要配置以及export 过程 在ServiceConfig 进行的,而在配置读取时 会首先对 dubbo:methoddubbo:argument 进行初始化,对 callback 原理进行标识则是在 doExportUrlsFor1Protocol 方法中进行。 这个方法代码比较长,逻辑上包括对 配置进行读取,对dubbo 中的 url进行拼凑,以及 输出 invoker等逻辑,可以看上面两篇文章有细分析。 而callbcak 原理在以下逻辑

        if (CollectionUtils.isNotEmpty(methods)) {
        // 判断 methods 是否为空
            for (MethodConfig method : methods) {
                appendParameters(map, method, method.getName());
                String retryKey = method.getName() + ".retry";
                if (map.containsKey(retryKey)) {
                    String retryValue = map.remove(retryKey);
                    if ("false".equals(retryValue)) {
                        map.put(method.getName() + ".retries", "0");
                    }
                }
                List<ArgumentConfig> arguments = method.getArguments();
                if (CollectionUtils.isNotEmpty(arguments)) {
                // 判断arguments 是否为空
                    for (ArgumentConfig argument : arguments) {
                        // convert argument type
                        if (argument.getType() != null && argument.getType().length() > 0) {
                        // 以 <dubbo:argument type="com.demo.CallbackListener" callback="true" /> 方式配置
                            Method[] methods = interfaceClass.getMethods();
                            // visit all methods
                            if (methods != null && methods.length > 0) {
                                for (int i = 0; i < methods.length; i++) {
                                    String methodName = methods[i].getName();
                                    // target the method, and get its signature
                                    if (methodName.equals(method.getName())) {
                                        Class<?>[] argtypes = methods[i].getParameterTypes();
                                        // one callback in the method
                                        if (argument.getIndex() != -1) {
                                            if (argtypes[argument.getIndex()].getName().equals(argument.getType())) {
                                                appendParameters(map, argument, method.getName() + "." + argument.getIndex());
                                            } else {
                                                throw new IllegalArgumentException("Argument config error : the index attribute and type attribute not match :index :" + argument.getIndex() + ", type:" + argument.getType());
                                            }
                                        } else {
                                            // multiple callbacks in the method
                                            for (int j = 0; j < argtypes.length; j++) {
                                                Class<?> argclazz = argtypes[j];
                                                if (argclazz.getName().equals(argument.getType())) {
                                                    appendParameters(map, argument, method.getName() + "." + j);
                                                    if (argument.getIndex() != -1 && argument.getIndex() != j) {
                                                        throw new IllegalArgumentException("Argument config error : the index attribute and type attribute not match :index :" + argument.getIndex() + ", type:" + argument.getType());
                                                    }
                                                }
                                            }
                                        }
                                    }
                                }
                            }
                        } else if (argument.getIndex() != -1) {
                        // 以  <dubbo:argument index="1" callback="true" /> 配置
                            appendParameters(map, argument, method.getName() + "." + argument.getIndex());
                        } else {
                            throw new IllegalArgumentException("Argument config must set index or type attribute.eg: <dubbo:argument index='0' .../> or <dubbo:argument type=xxx .../>");
                        }

                    }
                }
            } // end of methods for
        }

以上代码包括几步:

  1. 判断 methods 是否为空
  2. 判断arguments 是否为空 如果通过判断,则进入以下设置parameter 过程
  3. 以 <dubbo:argument type="com.demo.CallbackListener" callback="true" /> 方式配置的适配
  4. <dubbo:argument index="1" callback="true" /> 方式配置的适配。

服务端对Dubbo 配置方面就是这些,最终,在注册中心留下的ProviderService 则会多个callback 的配置。 如下形式 addListener.1.callback=true 说明这个接口的 addListener 方法的 第1个参数是callback类型(从0开始)。

Consumer 对 Callback 适配

开篇有个问题,当 服务端对接口没有配置 callback时候,客户端 直接启动,则会报错,即对象没有实现 Serializable。当然呢,Dubbo 默认以 Hessian 作为序列化框架,而 Hessian 则要求实现 Serializable

Caused by: java.lang.IllegalStateException: Serialized class com.anla.rpc.callback.consumer.Consumer$CallBackDemo must implement java.io.Serializable
    at com.alibaba.com.caucho.hessian.io.SerializerFactory.getDefaultSerializer(SerializerFactory.java:401)
    at com.alibaba.com.caucho.hessian.io.SerializerFactory.getSerializer(SerializerFactory.java:375)
    at com.alibaba.com.caucho.hessian.io.Hessian2Output.writeObject(Hessian2Output.java:389)
    at org.apache.dubbo.common.serialize.hessian2.Hessian2ObjectOutput.writeObject(Hessian2ObjectOutput.java:89)
    at org.apache.dubbo.rpc.protocol.dubbo.DubboCodec.encodeRequestData(DubboCodec.java:185)
    at org.apache.dubbo.remoting.exchange.codec.ExchangeCodec.encodeRequest(ExchangeCodec.java:238)
    at org.apache.dubbo.remoting.exchange.codec.ExchangeCodec.encode(ExchangeCodec.java:69)
    at org.apache.dubbo.rpc.protocol.dubbo.DubboCountCodec.encode(DubboCountCodec.java:40)
    at org.apache.dubbo.remoting.transport.netty4.NettyCodecAdapter$InternalEncoder.encode(NettyCodecAdapter.java:70)

所以这里就引出了 Consumer 端初始化配置的操作,上述明显是执行dubbo调用才会爆出的错误。所以肯定在Consumer在配置配置初始化会在注册中心和 服务端交互。

Consumer 中对callback 支持主要 体现在以下两个方面:

  1. 从注册中心获取配置,参数写道url中
  2. 代理将callback方法暴露出去,但是不注册到zk上
  3. 将callback 参数 不直接发送。

另一方面,如果Consumer 端传入一个实现了Serializable,而客户端尝试调用其里面内部方法,则会报错,客户端会报空指针错误:

Exception in thread "main" java.lang.NullPointerException
    at java.util.concurrent.ConcurrentHashMap.putVal(ConcurrentHashMap.java:1011)
    at java.util.concurrent.ConcurrentHashMap.put(ConcurrentHashMap.java:1006)
    at com.anla.rpc.callback.provider.impl.CallbackServiceImpl.addListener(CallbackServiceImpl.java:44)
    at org.apache.dubbo.common.bytecode.Wrapper1.invokeMethod(Wrapper1.java)
    at org.apache.dubbo.rpc.proxy.javassist.JavassistProxyFactory$1.doInvoke(JavassistProxyFactory.java:47)
    at org.apache.dubbo.rpc.proxy.AbstractProxyInvoker.invoke(AbstractProxyInvoker.java:84)
    at org.apache.dubbo.config.invoker.DelegateProviderMetaDataInvoker.invoke(DelegateProviderMetaDataInvoker.java:56)
    at org.apache.dubbo.rpc.protocol.InvokerWrapper.invoke(InvokerWrapper.java:56)
    at org.apache.dubbo.rpc.filter.ExceptionFilter.invoke(ExceptionFilter.java:55)

而服务端也会给出给出红色警告信息:

十月 13, 2019 11:38:17 下午 com.alibaba.com.caucho.hessian.io.SerializerFactory getDeserializer
警告: Hessian/Burlap: 'com.anla.rpc.callback.consumer.Consumer$CallBackDemo' is an unknown class in sun.misc.Launcher$AppClassLoader@18b4aac2:
java.lang.ClassNotFoundException: com.anla.rpc.callback.consumer.Consumer$CallBackDemo

为什么会出现这样信息呢?读完这篇文章估计大家就会有结论了。

Consumer 增加callback配置

Consumer 端 从 注册中心获取 相关配置 在 RegistryProtocol 中进行,而具体管控则是由 RegistryDirectory 进行调用。整个Consumer配置可以看 : @Reference或ReferenceConfig.get代理对象如何产生(一):SPI模式中 Wrapper和 SPI 类组装逻辑Dubbo 消费者中 代理对象 初始化详解

本文同样只拎出 获取 callback 配置相关过程。

Protocl 会执行 refer 方法,去获取某Invoker 首先进入 RegistryProtocoldoRefer 方法:

    private <T> Invoker<T> doRefer(Cluster cluster, Registry registry, Class<T> type, URL url) {
    // 构造一个RegistryDirectory
        RegistryDirectory<T> directory = new RegistryDirectory<T>(type, url);
        directory.setRegistry(registry);
        directory.setProtocol(protocol);
        // all attributes of REFER_KEY
        Map<String, String> parameters = new HashMap<String, String>(directory.getUrl().getParameters());
        URL subscribeUrl = new URL(CONSUMER_PROTOCOL, parameters.remove(REGISTER_IP_KEY), 0, type.getName(), parameters);
        // 订阅的url
        if (!ANY_VALUE.equals(url.getServiceInterface()) && url.getParameter(REGISTER_KEY, true)) {
            directory.setRegisteredConsumerUrl(getRegisteredConsumerUrl(subscribeUrl, url));
            registry.register(directory.getRegisteredConsumerUrl());
        }
        directory.buildRouterChain(subscribeUrl);
        // 开始订阅
        directory.subscribe(subscribeUrl.addParameter(CATEGORY_KEY,
                PROVIDERS_CATEGORY + "," + CONFIGURATORS_CATEGORY + "," + ROUTERS_CATEGORY));
        // 返回Invoker
        Invoker invoker = cluster.join(directory);
        ProviderConsumerRegTable.registerConsumer(invoker, url, subscribeUrl, directory);
        return invoker;
    }

doRefer 方法中 主要通过 构造一个 RegistryDirectory 进行整个 对外服务相关管理,设置完相关参数,执行

        directory.subscribe(subscribeUrl.addParameter(CATEGORY_KEY,
                PROVIDERS_CATEGORY + "," + CONFIGURATORS_CATEGORY + "," + ROUTERS_CATEGORY));

RegistryDirectory 方法:

    public void subscribe(URL url) {
        setConsumerUrl(url);
        CONSUMER_CONFIGURATION_LISTENER.addNotifyListener(this);
        serviceConfigurationListener = new ReferenceConfigurationListener(this, url);
        registry.subscribe(url, this);
    }

而后在 FailbackRegistrysubscribe 方法:

    @Override
    public void subscribe(URL url, NotifyListener listener) {
        super.subscribe(url, listener);
        removeFailedSubscribed(url, listener);
        try {
            // Sending a subscription request to the server side
            doSubscribe(url, listener);
        } catch (Exception e) {
            Throwable t = e;

            List<URL> urls = getCacheUrls(url);
            if (CollectionUtils.isNotEmpty(urls)) {
                notify(url, listener, urls);
                logger.error("Failed to subscribe " + url + ", Using cached list: " + urls + " from cache file: " + getUrl().getParameter(FILE_KEY, System.getProperty("user.home") + "/dubbo-registry-" + url.getHost() + ".cache") + ", cause: " + t.getMessage(), t);
            } else {
                // If the startup detection is opened, the Exception is thrown directly.
                boolean check = getUrl().getParameter(Constants.CHECK_KEY, true)
                        && url.getParameter(Constants.CHECK_KEY, true);
                boolean skipFailback = t instanceof SkipFailbackWrapperException;
                if (check || skipFailback) {
                    if (skipFailback) {
                        t = t.getCause();
                    }
                    throw new IllegalStateException("Failed to subscribe " + url + ", cause: " + t.getMessage(), t);
                } else {
                    logger.error("Failed to subscribe " + url + ", waiting for retry, cause: " + t.getMessage(), t);
                }
            }

            // Record a failed registration request to a failed list, retry regularly
            addFailedSubscribed(url, listener);
        }
    }

代码较深,就单以文字加部分代码分析。

  1. 如果使用Zookeeper 协议,则会进入 ZookeeperRegistry 执行 doSubscribe ,这个方法则主要是从zk上获取各种类型的节点以及数量,以及将自己 的信息 在zookeeper 上的 ${service}/consumers 下面创建一个节点。并且会获取${service} 下面所有类型的节点。
  2. 执行 notify 方法,主要目的 注册后第一次通过注册中心信息去更改 对应配置。 上述 notify 方法主要是 执行 FailbackRegistrynotify 方法。
  3. 执行FailbackRegistrynotify 方法后,会执行其doNotify方法,这个方法最终会执行到 AbstractRegistrynotify 方法。
  4. 最终的 notify 会执行到 RegistryDirectory 中。对 对应接口暴露下 三种类型(providersconsumersrouters) 节点进行读取 。

当服务端url 有值是,会执行 RegistryDirectoryrefreshOverrideAndInvoker 。将其进行配置更新,最终将服务端配置addListener.1.callback=true 加入到自己请求参数中,当进行序列化时绕过Hessian。

Consumer 构造Request数据

当Consumer 端这边已经搞好配置,也拿到了 负载均衡后的 Invoker,一步一步穿过Protocol,Transporter,转由Netty发送,而Netty 发送,则会对其进行编码,从而使用 到Dubbo 自实现的编码方式,具体逻辑如下:

  1. 进入到 NettyCodecAdapter 的 内部类 InternalEncoderencode 方法。
  2. 进入 DubboCountCodecencode
  3. 依次进入 ExchangeCodecencodeencodeRequestencodeReguqestData 方法, encodeRequestData 则关乎到 callback 参数设置:

     @Override
     protected void encodeRequestData(Channel channel, ObjectOutput out, Object data, String version) throws IOException {
         RpcInvocation inv = (RpcInvocation) data;
    
         out.writeUTF(version);
         out.writeUTF(inv.getAttachment(PATH_KEY));
         out.writeUTF(inv.getAttachment(VERSION_KEY));
    
         out.writeUTF(inv.getMethodName());
         out.writeUTF(ReflectUtils.getDesc(inv.getParameterTypes()));
         Object[] args = inv.getArguments();
         // 对参数进行编码
         if (args != null) {
             for (int i = 0; i < args.length; i++) {
                 out.writeObject(encodeInvocationArgument(channel, inv, i));
             }
         }
         out.writeObject(inv.getAttachments());
     }
    

    而后进入到 encodeInvocationArgument 进行callback 参数判断以及填充:

     public static Object encodeInvocationArgument(Channel channel, RpcInvocation inv, int paraIndex) throws IOException {
         // get URL directly
         URL url = inv.getInvoker() == null ? null : inv.getInvoker().getUrl();
         byte callbackStatus = isCallBack(url, inv.getMethodName(), paraIndex);
         Object[] args = inv.getArguments();
         Class<?>[] pts = inv.getParameterTypes();
         switch (callbackStatus) {
             case CallbackServiceCodec.CALLBACK_NONE:
                 return args[paraIndex];
             case CallbackServiceCodec.CALLBACK_CREATE:
                 inv.setAttachment(INV_ATT_CALLBACK_KEY + paraIndex, exportOrUnexportCallbackService(channel, url, pts[paraIndex], args[paraIndex], true));
                 return null;
             case CallbackServiceCodec.CALLBACK_DESTROY:
                 inv.setAttachment(INV_ATT_CALLBACK_KEY + paraIndex, exportOrUnexportCallbackService(channel, url, pts[paraIndex], args[paraIndex], false));
                 return null;
             default:
                 return args[paraIndex];
         }
     }
    

    上述 isCallBack(url, inv.getMethodName(), paraIndex); 则使用了从 服务端获取而来的 addListener.1.callback=true,从而标明是callback类型,并且如果是callback则直接返回null 而非callback 则直接返回 args[paraIndex];,由于没有实现 Serializable,所以会报错。

Consumer 端 callback 产生以及传递

如果说,callback 参数是直接发送null,那么callback如何传递给服务端呢?二者如何交互呢? 先看第一个 , 当判断为 CALLBACK_CREATE 事件是,将 exportOrUnexportCallbackService 返回的 String 放入到 需要传递的 RpcInvocation 中,并且以 sys_callback_arg + paraIndex 作为key。 而在encodeRequestData 方法最后,会执行 out.writeObject(inv.getAttachments());RpcInvocation 的所有attachments 都交由 Netty发送。 所以,最终 callback 在客户端是以 String 类型 通过Netty 发送给 Provider 端。

下面看 exportOrUnexportCallbackService 执行了什么操作:

    private static String exportOrUnexportCallbackService(Channel channel, URL url, Class clazz, Object inst, Boolean export) throws IOException {
        // 获取一个instid
        int instid = System.identityHashCode(inst);
        // 由于会调用共用的export,所以这个 callback 的服务和 主 服务共享一个 service
        // 以下为构造参数过程
        Map<String, String> params = new HashMap<>(3);
        params.put(IS_SERVER_KEY, Boolean.FALSE.toString());
        params.put(IS_CALLBACK_SERVICE, Boolean.TRUE.toString());
        String group = (url == null ? null : url.getParameter(GROUP_KEY));
        if (group != null && group.length() > 0) {
            params.put(GROUP_KEY, group);
        }
        // add method, for verifying against method, automatic fallback (see dubbo protocol)
        params.put(METHODS_KEY, StringUtils.join(Wrapper.getWrapper(clazz).getDeclaredMethodNames(), ","));

        Map<String, String> tmpMap = new HashMap<>(url.getParameters());
        tmpMap.putAll(params);
        tmpMap.remove(VERSION_KEY);// doesn't need to distinguish version for callback
        tmpMap.put(INTERFACE_KEY, clazz.getName());
        URL exportUrl = new URL(DubboProtocol.NAME, channel.getLocalAddress().getAddress().getHostAddress(), channel.getLocalAddress().getPort(), clazz.getName() + "." + instid, tmpMap);

        // no need to generate multiple exporters for different channel in the same JVM, cache key cannot collide.
        String cacheKey = getClientSideCallbackServiceCacheKey(instid);
        String countKey = getClientSideCountKey(clazz.getName());
        if (export) {
            // one channel can have multiple callback instances, no need to re-export for different instance.
            if (!channel.hasAttribute(cacheKey)) {
                if (!isInstancesOverLimit(channel, url, clazz.getName(), instid, false)) {
                // 构造一个callback 的Invoker
                    Invoker<?> invoker = PROXY_FACTORY.getInvoker(inst, clazz, exportUrl);
                    // 暴露该服务,获取一个 Exporter                    
                    Exporter<?> exporter = protocol.export(invoker);
                    // this is used for tracing if instid has published service or not.
                    // 将Exporter 放入channel 中
                    channel.setAttribute(cacheKey, exporter);
                    logger.info("Export a callback service :" + exportUrl + ", on " + channel + ", url is: " + url);
                    increaseInstanceCount(channel, countKey);
                }
            }
        } else {
        // 如果是销毁callback操作
            if (channel.hasAttribute(cacheKey)) {
                Exporter<?> exporter = (Exporter<?>) channel.getAttribute(cacheKey);
                exporter.unexport();
                channel.removeAttribute(cacheKey);
                decreaseInstanceCount(channel, countKey);
            }
        }
        return String.valueOf(instid);
    }

上面方法有以下几个过程:

  1. 构造URL 参数,设置Callback 应有的参数
  2. 通过类实例,类,以及url 获取一个Invoker,PROXY_FACTORY.getInvoker(inst, clazz, exportUrl);
  3. 执行 protocol.export(invoker); 使用DubboProtocol 暴露服务
  4. Exporter 放入channelattribute 中。

下面看看 callback 的 Invoker 产生逻辑,即 PROXY_FACTORY.getInvoker(inst, clazz, exportUrl); 代码逻辑: 最终通过 JavaassistProxyFactory 产生一个代理Invoker,用于执行传入inst 实例的方法。

    @Override
    public <T> Invoker<T> getInvoker(T proxy, Class<T> type, URL url) {
        // TODO Wrapper cannot handle this scenario correctly: the classname contains '$'
        final Wrapper wrapper = Wrapper.getWrapper(proxy.getClass().getName().indexOf('$') < 0 ? proxy.getClass() : type);
        return new AbstractProxyInvoker<T>(proxy, type, url) {
            @Override
            protected Object doInvoke(T proxy, String methodName,
                                      Class<?>[] parameterTypes,
                                      Object[] arguments) throws Throwable {
                return wrapper.invokeMethod(proxy, methodName, parameterTypes, arguments);
            }
        };
    }

所以这个 getInvoker 最终获取一个 Invoker ,这个Invoker 只是包装了一层,最终执行 wrapper.invokeMethod(proxy, methodName, parameterTypes, arguments); 即执行 传入proxy 的,执行 methodName 的方法。

Provider 对 Callback 适配

服务端对callback 也有着特定的适配:

  1. 需要配置 callback类型参数用于告诉 客户端 参数类型
  2. 在 数据解码阶段,将callback参数的解码

当 Provider 获取而来的 具体 Callback 对象时,参数有了封装,看截图: 在这里插入图片描述 此处相信认真读的同学有个疑问:

  1. 从 上面分析来看,客户端传递过来时候,对callback处理就是传null,以及设置 attachments。那为啥到服务端会变为 有 InvokerInvoocationHandler 以及 AsyncToSyncInvoker 的包装类型呢?

往下看。

当在客户端传递过来是,在Netty 的encode 逻辑处,对callback进行了适配,所以其实在 provider 的 decode 逻辑进行了封装,用 InvokerInvoocationHandler 以及 AsyncToSyncInvoker 的包装类型。 下面看看具体逻辑:

  1. NettyCodecAdapter 的 内部类的 InternalDecoderdecode 方法开始。
  2. 进入DubboCountCodec 的 decode方法
  3. 再到 ExchangeCodec 的 两个重载的 decode方法,再到DubboCodecdecodeBody
  4. 通过使用 DecodeableRpcInvocation 来解码 RpcInvocation 类型数据
  5. CallbackServiceCodec 中的 decodeInvocationArgument 进行 callback 类型判定以及解码。
    public static Object decodeInvocationArgument(Channel channel, RpcInvocation inv, Class<?>[] pts, int paraIndex, Object inObject) throws IOException {
         // 如果是callback 类型,则创建client 端的代理,即这个代理对象可以发起对client端的远程调用
         URL url = null;
         try {
         // 解析初url
             url = DubboProtocol.getDubboProtocol().getInvoker(channel, inv).getUrl();
         } catch (RemotingException e) {
             if (logger.isInfoEnabled()) {
                 logger.info(e.getMessage(), e);
             }
             return inObject;
         }
         // 解析callback类型
         byte callbackstatus = isCallBack(url, inv.getMethodName(), paraIndex);
         switch (callbackstatus) {
         // 普通参数
             case CallbackServiceCodec.CALLBACK_NONE:
                 return inObject;
                 // 创建callback
             case CallbackServiceCodec.CALLBACK_CREATE:
                 try {
                     return referOrDestroyCallbackService(channel, url, pts[paraIndex], inv, Integer.parseInt(inv.getAttachment(INV_ATT_CALLBACK_KEY + paraIndex)), true);
                 } catch (Exception e) {
                     logger.error(e.getMessage(), e);
                     throw new IOException(StringUtils.toString(e));
                 }
                 // 销毁callback
             case CallbackServiceCodec.CALLBACK_DESTROY:
                 try {
                     return referOrDestroyCallbackService(channel, url, pts[paraIndex], inv, Integer.parseInt(inv.getAttachment(INV_ATT_CALLBACK_KEY + paraIndex)), false);
                 } catch (Exception e) {
                     throw new IOException(StringUtils.toString(e));
                 }
             default:
                 return inObject;
         }
     }
    
  6. 而最终有consumer 端传递的url 有指定 参数回调及类型,所以判定为callback

看看 referOrDestroyCallbackService 中是如何在服务端构造一个 代理对象的:

    private static Object referOrDestroyCallbackService(Channel channel, URL url, Class<?> clazz, Invocation inv, int instid, boolean isRefer) {
        Object proxy = null;
        // invoker 缓存对象 的key:callback.service.proxy.12503143.com.anla.rpc.callback.provider.service.CallbackListener.654342195.invoker 
        String invokerCacheKey = getServerSideCallbackInvokerCacheKey(channel, clazz.getName(), instid);
        // 代理缓存对象key:callback.service.proxy.12503143.com.anla.rpc.callback.provider.service.CallbackListener.654342195
        String proxyCacheKey = getServerSideCallbackServiceCacheKey(channel, clazz.getName(), instid);
        // 判断当前 channel 是否已经产生了代理对象。
        proxy = channel.getAttribute(proxyCacheKey);
        // count 的key  callback.service.proxy.12503143.com.anla.rpc.callback.provider.service.CallbackListener.COUNT
        String countkey = getServerSideCountKey(channel, clazz.getName());
        if (isRefer) {
            if (proxy == null) {
                URL referurl = URL.valueOf("callback://" + url.getAddress() + "/" + clazz.getName() + "?" + INTERFACE_KEY + "=" + clazz.getName());
                referurl = referurl.addParametersIfAbsent(url.getParameters()).removeParameter(METHODS_KEY);
                // 以下判断是否超出 服务的 callback 参数
                if (!isInstancesOverLimit(channel, referurl, clazz.getName(), instid, true)) {
                    @SuppressWarnings("rawtypes")
                    // 构造一个Invoker
                    Invoker<?> invoker = new ChannelWrappedInvoker(clazz, channel, referurl, String.valueOf(instid));
                    // 使用 JavassistProxyFactory 生成一个由 InvokerInvocationHandler+ AsyncToSyncInvoker 的包装的invoker
                    proxy = PROXY_FACTORY.getProxy(new AsyncToSyncInvoker<>(invoker));
                    // 设置channel属性
                    channel.setAttribute(proxyCacheKey, proxy);
                    channel.setAttribute(invokerCacheKey, invoker);
                    // 设置计数到channel中
                    increaseInstanceCount(channel, countkey);
                    // 忽略并发问题,快速失败
                // 将构造出的invoker 放入channel中
                    Set<Invoker<?>> callbackInvokers = (Set<Invoker<?>>) channel.getAttribute(CHANNEL_CALLBACK_KEY);
                    if (callbackInvokers == null) {
                        callbackInvokers = new ConcurrentHashSet<Invoker<?>>(1);
                        callbackInvokers.add(invoker);
                        channel.setAttribute(CHANNEL_CALLBACK_KEY, callbackInvokers);
                    }
                    logger.info("method " + inv.getMethodName() + " include a callback service :" + invoker.getUrl() + ", a proxy :" + invoker + " has been created.");
                }
            }
        } else {
            if (proxy != null) {
            // 从Invoker 中拿出并销毁
                Invoker<?> invoker = (Invoker<?>) channel.getAttribute(invokerCacheKey);
                try {
                    Set<Invoker<?>> callbackInvokers = (Set<Invoker<?>>) channel.getAttribute(CHANNEL_CALLBACK_KEY);
                    if (callbackInvokers != null) {
                        callbackInvokers.remove(invoker);
                    }
                    invoker.destroy();
                } catch (Exception e) {
                    logger.error(e.getMessage(), e);
                }
                // 直接从map中删除。
                channel.removeAttribute(proxyCacheKey);
                channel.removeAttribute(invokerCacheKey);
                decreaseInstanceCount(channel, countkey);
            }
        }
        return proxy;
    }

此时该回调的Invoker 中的url为 callback开头:

callback://192.168.1.107:20880/com.anla.rpc.callback.provider.service.CallbackListener?addListener.1.callback=true&anyhost=true&application=provider&bean.name=com.anla.rpc.callback.provider.service.CallbackService&bind.ip=192.168.1.107&bind.port=20880&callbacks=1000&connections=1&deprecated=false&dubbo=2.0.2&dynamic=true&generic=false&interface=com.anla.rpc.callback.provider.service.CallbackListener&pid=1090&register=true&release=2.7.2&side=provider&timestamp=1571061967992

但是此 url 好像并没有体现出任何作用。 另一方面,这次从服务端发起的回调也是 twoWay类型,即服务端会等待客户端执行结果。 但是在服务端并没有设置超时控制的 task 回调,但是会记录下调用的异常。

Dubbo 客户端接受回调

当服务端调用之后,则是直接以 Netty 调用方式调用 dubbo接口,而不再去询问注册中心是否有对应服务。 客户端拿到 回调用,通过 对事件进行判断是 以下事件某一种:CONNECTEDDISCONNECTEDSENTRECEIVEDCAUGHT的某种,而此次回调属于 RECEIVED 事件,从而 使用一个 ChannelEventRunnable 用于执行其逻辑。

在Netty 传输时,Invoker 并没有拿回来,而只是 拿到 serviceKey 去解析,从而获取到 客户端 所缓存的 DubboExporter,最终由 DubboExporter 返回对应的Invoker 对象,这个Invoker 对象就是dubbo 为callback 方法创建的一个代理对象,而由该Invoker 对象则最终负责由服务端传递过来的 参数类型调用对应的方法。

流程

简单梳理下参数回调Callback 整体实现原理:

  1. Provider 端配置Service,以及Service 的callback 参数
  2. Consumer 端通过注册中心的url进行参数适配,将callback 参数形式加入自己的url中
  3. 在TCP层发送时,Consumer 对Callback类型参数进行特殊处理,从而避免匿名内部类没有实现Serializable 接口的报错
  4. Provider 在收到TCP 消息时,进行解码,如果是callback类型,则封装为新的面向客户端的 Invoker 代理
  5. 当在Provider 执行完,转而通过上一步封装号的Invoker代理想Consumer发起通信调用请求
  6. Consumer 收到RECEIVE 消息类型是,通过特定serviceKey 获取 已有的Exporter以及Invoker 进行本地调用

整个参数回调Callback 实现就研究完成。

相信读完全篇文章,大家就会对博主开篇几个问题有自己见解了,如果对问题仍然不太懂,可以结合源码进行多次调试。 当然各位同学也可以关注博主公众号,通过后台获取博主私人微信进行交流,一起探讨其中疑问

觉得博主写的有用,不妨关注博主公众号: 六点A君。 哈哈哈,Dubbo小吃街不迷路

原创文章,转载请注明: 转载自并发编程网 – ifeve.com本文链接地址: Dubbo中参数回调 Callback 实现深究


FavoriteLoading添加本文到我的收藏
  • Trackback 关闭
  • 评论 (0)
  1. 暂无评论

您必须 登陆 后才能发表评论

return top