dubbo剖析:四 网络通信之 -- Client实现

引子:

  • dubbo剖析:二 服务引用 中,我们讲到了RegistryProtocol.refer过程中有一个关键步骤,即在监听到服务提供者url时触发RegistryDirectory.notify()方法。
  • RegistryDirectory.notify()方法调用refreshInvoker()方法将服务提供者urls转换为对应的远程invoker,最终调用到DubboProtocol.refer()方法生成对应的DubboInvoker
  • DubboInvoker的构造方法中有一项入参ExchangeClient[] clients,即对应本文要讲的网络客户端Client。DubboInvoker就是通过调用client.request()方法完成网络通信的请求发送和响应接收功能。
  • Client的具体生成过程就是通过DubboProtocolinitClient(URL url)方法创建了一个HeaderExchangeClient
  • 本章我们就来介绍HeaderExchangeClient设计架构功能实现

一、入口流程

服务引用过程中,RegistryProtocol会调用到DubboProtocolrefer()方法,用于创建一个DubboInvoker完成客户端的启动并和服务提供方建连。

    public <T> Invoker<T> refer(Class<T> serviceType, URL url) throws RpcException {
        // create rpc invoker.
        DubboInvoker<T> invoker = new DubboInvoker<T>(serviceType, url, getClients(url), invokers);
        invokers.add(invoker);
        return invoker;
    }

其中DubboProtocolgetClients()方法完成了Client的创建过程:

    private ExchangeClient[] getClients(URL url) {
        //...判断是否共享连接...

        ExchangeClient[] clients = new ExchangeClient[connections];
        for (int i = 0; i < clients.length; i++) {
            if (service_share_connect) {
                clients[i] = getSharedClient(url);
            } else {
                //关键代码,生成Client
                clients[i] = initClient(url);
            }
        }
        return clients;
    }
    /**
     * 创建新连接.
     */
    private ExchangeClient initClient(URL url) {

        // ...省略部分非关键代码...

        ExchangeClient client;
        try {
            //设置连接应该是lazy的 
            if (url.getParameter(Constants.LAZY_CONNECT_KEY, false)) {
                client = new LazyConnectExchangeClient(url, requestHandler);
            } else {
                //关键代码:通过Exchangers创建HeaderExchangeClient
                client = Exchangers.connect(url, requestHandler);
            }
        } catch (RemotingException e) {
            throw new RpcException("Fail to create remoting client for service(" + url
                    + "): " + e.getMessage(), e);
        }
        return client;
    }

二、Client端网络层结构

Client端网络层类图关系说明

2.1 网络传输层

  • ChannelHandler为网络事件处理器接口,定义了Server端监听到各种类型的网络事件时的处理方法(connected、disconnected、sent、received、caught),Netty中也有类似定义。
  • EndPoint为网络端点的抽象接口,定义了获取网络端点地址、连接、及最原始的发送消息的方法。
  • Channel为网络通道的抽象接口,继承了EndPoint的功能,并扩展了绑定获取属性和判断通道是否连接的方法。
  • Client为网络客户端的抽象接口,继承了Channel的功能,并扩展了重连方法reconnect()
  • Transporter为网络传输层的抽象接口,核心作用就是提供了创建ServerClient两个核心接口实现类的方法。

2.2 信息交换层

  • ExchangeHandler,在ChannelHandler接口基础上,添加了 响应请求的方法。
  • ExchangeChannel,在Channel接口的基础上,扩展了请求响应模式的功能,并能获取绑定在通道上的网络事件监听器。
  • ExchangeClient,在Client接口基础上,继承了ExchangeChannel接口,将Channel扩展为ExchangeChannel。
  • Exchanger为信息交换层的抽象接口,核心作用就是提供了创建ExchangeServerExchangeClient两个核心接口实现类的方法。

三 HeaderExchangeClient & NettyClient实现详解

Client实现层次结构图

3.1 网络层

AbstractPeer类(网络事件处理器和网络节点的通用实现):

  • 定义了属性ChannelHandlerURL,作为构造方法入参注入;
  • 实现了ChannelHandlerEndPoint接口,ChannelHandler接口的相关方法依赖其channelHandler属性完成实现;

AbstractEndPoint类(加入编解码功能):

  • 定义了构造方法,入参包含属性ChannelHandlerURL
  • 定义了属性Codec2,用于编解码,通过SPI动态注入;
  • 定义了timeout/connectTimeout相关超时属性,由URL解析赋值;
  • 对外暴露了获取Codec2和超时相关属性的方法,供上层依赖调用;

AbastractClient类(网络客户端通用抽象,实现了openconnectdisConnectclosesend的公共流程,并提供了doOpendoConnectdoDisconnectdoClosegetChannel的扩展):

  • 定义了构造方法,入参包含属性ChannelHandlerURL,并触发doOpen()connect()方法;
  • 重写AbstractPeerclose()方法,加入了disconnect()doClose()扩展方法的触发逻辑;
  • 定义并实现connect()方法,完成建连功能。内部逻辑为启动“心跳检测定时任务”并触发doConnect()扩展方法;
  • 定义并实现disconnect()方法,完成断连功能。内部逻辑为停止“心跳检测定时任务”、通过getChannel()获取连接并关闭、并触发doDisconnect()扩展方法;
  • 实现了Client接口的reconnect()方法,实际调用disconnect() + connect()
  • 实现了EndPoint接口的send()方法,实际调用getChannel().send()完成;
  • 实现了Channel接口的相关方法,实际依赖getChannel()取得的channel完成;
  • 提供了对ChannelHandlerwrap()方法,后续单独展开讲解;

NettyClient类(网络客户端Netty实现类,实现了doOpendoConnectdoDisconnectdoClosegetChannel这五个关键扩展方法):

  • 实现了doOpen()扩展方法,new出来Netty的ClientBootstrap并初始化参数设置;
  • 实现了doConnect()扩展方法,使用ClientBootstrap完成服务端的廉价和事件监听,其网络事件处理器为本身this的包装;
  • 实现了doDisconnect()扩展方法,从NettyChannelchannelMap中移除当前的断连channel
  • 实现了doClose()扩展方法,内部无实际逻辑;
  • 实现了getChannel()扩展方法,由NettyChannel类将客户端的Netty原生Channel包装后放入channelMap并返回;
    protected void doOpen() throws Throwable {
        NettyHelper.setNettyLoggerFactory();
        bootstrap = new ClientBootstrap(channelFactory);
        // config
        // @see org.jboss.netty.channel.socket.SocketChannelConfig
        bootstrap.setOption("keepAlive", true);
        bootstrap.setOption("tcpNoDelay", true);
        bootstrap.setOption("connectTimeoutMillis", getTimeout());
        final NettyHandler nettyHandler = new NettyHandler(getUrl(), this);
        bootstrap.setPipelineFactory(new ChannelPipelineFactory() {
            public ChannelPipeline getPipeline() {
                NettyCodecAdapter adapter = new NettyCodecAdapter(getCodec(), getUrl(), NettyClient.this);
                ChannelPipeline pipeline = Channels.pipeline();
                pipeline.addLast("decoder", adapter.getDecoder());
                pipeline.addLast("encoder", adapter.getEncoder());
                pipeline.addLast("handler", nettyHandler);
                return pipeline;
            }
        });
    }
    protected void doConnect() throws Throwable {
        long start = System.currentTimeMillis();
        ChannelFuture future = bootstrap.connect(getConnectAddress());
        try {
            boolean ret = future.awaitUninterruptibly(getConnectTimeout(), TimeUnit.MILLISECONDS);

            if (ret && future.isSuccess()) {
                Channel newChannel = future.getChannel();
                newChannel.setInterestOps(Channel.OP_READ_WRITE);
                try {
                    // 关闭旧的连接
                    Channel oldChannel = NettyClient.this.channel; // copy reference
                    if (oldChannel != null) {
                        try {
                            if (logger.isInfoEnabled()) {
                                logger.info("Close old netty channel " + oldChannel + " on create new netty channel " + newChannel);
                            }
                            oldChannel.close();
                        } finally {
                            NettyChannel.removeChannelIfDisconnected(oldChannel);
                        }
                    }
                } finally {
                    if (NettyClient.this.isClosed()) {
                        try {
                            if (logger.isInfoEnabled()) {
                                logger.info("Close new netty channel " + newChannel + ", because the client closed.");
                            }
                            newChannel.close();
                        } finally {
                            NettyClient.this.channel = null;
                            NettyChannel.removeChannelIfDisconnected(newChannel);
                        }
                    } else {
                        NettyClient.this.channel = newChannel;
                    }
                }
            } else if (future.getCause() != null) {
                throw new RemotingException(this, "client(url: " + getUrl() + ") failed to connect to server "
                        + getRemoteAddress() + ", error message is:" + future.getCause().getMessage(), future.getCause());
            } else {
                throw new RemotingException(this, "client(url: " + getUrl() + ") failed to connect to server "
                        + getRemoteAddress() + " client-side timeout "
                        + getConnectTimeout() + "ms (elapsed: " + (System.currentTimeMillis() - start) + "ms) from netty client "
                        + NetUtils.getLocalHost() + " using dubbo version " + Version.getVersion());
            }
        } finally {
            if (!isConnected()) {
                future.cancel();
            }
        }
    }

NettyChannel类(内部含有一个netty.Channel,实现了EndPoint接口的send()方法):

  • 内部包含了netty的原始通道netty.Channel,该属性由NettyClient.doConnect()执行完成时产生;
  • send()方法底层最终使用netty原生通道完成数据的发送;
    public void send(Object message, boolean sent) throws RemotingException {
        super.send(message, sent);

        boolean success = true;
        int timeout = 0;
        try {
            //关键代码,使用netty的原始channel完成数据发送
            ChannelFuture future = channel.write(message);
            if (sent) {
                timeout = getUrl().getPositiveParameter(Constants.TIMEOUT_KEY, Constants.DEFAULT_TIMEOUT);
                success = future.await(timeout);
            }
            Throwable cause = future.getCause();
            if (cause != null) {
                throw cause;
            }
        } catch (Throwable e) {
            throw new RemotingException(this, "Failed to send message " + message + " to " + getRemoteAddress() + ", cause: " + e.getMessage(), e);
        }

        if (!success) {
            throw new RemotingException(this, "Failed to send message " + message + " to " + getRemoteAddress()
                    + "in timeout(" + timeout + "ms) limit");
        }
    }

3.2 发送请求数据(网络层)

当“服务引用方客户端”需要向“服务提供方服务端”发送请求时,会通过交换层最终调用NettyClient.send(Object message)方法:

  • NettyClient.send(Object message):依赖getChannel()方法获取到NettyChannel对象,然后调用它的send(Object message)方法;
  • NettyChannel:由NettyClient.getChannel()方法中构建生成,入参包括URLnetty.ChannelChannelHandler,均由NettyClient传入。NettyChannel.send()方法最终调用其内部netty.Channel完成请求数据的发送;

3.3 交换层

HeaderExchangeClient类(交换层客户端,将网络层的Channel扩展为交换层的ExchangeChannel、通过exchangeChannel实现了具有请求响应功能的request()方法,并加入心跳检测功能):

  • 定义了构造方法,入参包含属性Client,用于实现客户端网络层功能;
  • 定义了属性定时任务线程池scheduled,用于执行“定时心跳收发及心跳超时监测”任务;
  • 定义了hearbeat / heartbeatTieout相关心跳属性,由URL解析赋值;
  • 构造方法中启动“定时心跳收发及心跳超时监测”任务,doClose()方法中关闭任务,任务逻辑为超时时“Server断连、Client断连重连”;
  • Client扩展为交换层ExchangeChannel,并通过ExchangeChannel实现了request()方法,具体实现后续另辟章节;
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,214评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,307评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,543评论 0 341
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,221评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,224评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,007评论 1 284
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,313评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,956评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,441评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,925评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,018评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,685评论 4 322
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,234评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,240评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,464评论 1 261
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,467评论 2 352
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,762评论 2 345

推荐阅读更多精彩内容

  • 引子: 在 dubbo剖析:一 服务发布 中,我们讲到了 RegistryProtocol.export...
    益文的圈阅读 1,857评论 0 7
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,599评论 18 139
  • 大三了,时间总是令人若即若离,貌似天长日久,其实也不过是转瞬千年。 日子匆匆,慢慢地渐渐地又见生活的分岔口。曾经很...
    木白木木哥阅读 166评论 0 0
  • 我是日记星球267号星宝宝,我正在参加日记星球第十三期21天蜕变之旅,这是我的第122篇原创日记。 真快,今天8号...
    张小姐4134阅读 414评论 4 6
  • 老师告诉我们遇到老师要问老师好。 可是没有教我们看到清洁阿姨保安叔叔他们也向他们问好。
    爱元若哥哥阅读 54评论 0 1