万字深度解析Dubbo-通信模块设计

通信模块介绍

Dubbo通信模块主要的目的就是解决客户端以服务端通信的问题，核心代码都在dubbo-remoting模块，该模块提供了多种客户端和服务端通信的功能。Dubbo的通信主要包括是三部分:Exchange、Transport和Serialize，对于序列化部分的设计在单独的模块中，我们再单独聊，这篇文章主要聊Exchange、Transport设计。

对于Dubbo来说没有自己的网络框架，使用现有第三方类库，因此需要设计一套标准API来兼容多种不同的通信框架，dubbo-remoting 模块的结构就是目前Dubbo兼容的所有的通信框架。

在整体模块设计上，dubbo-remoting-api是其他模块上层抽象，其他子模块都是依赖第三方NIO库实现 dubbo-remoting-api模块的。因此我们想要了解清楚dubbo-remoting设计必须要理解dubbo-remoting-api的设计。

对于dubbo-remoting-api大致可以分为四类，

  1. 核心API设计，主要是包括端口、编码、解码等等核心接口的抽象；
  2. buffer，主要是定义缓冲区相关的接口、抽象类以及实现类；
  3. exchange，抽Request和Response概念抽象以及扩展；
  4. transport，网络传输层的抽象，但它只负责消息的传输；

源码分析

核心API设计

Endpoint

Endpoint被翻译端点，这里可以理解为通信中对IP和Port的抽象，Client和Server端共同的抽象，两个端通过Endpoint建立TCP连接，进行通信。

对于该Endpoint接口定义了三类方法:

  1. get类方法，主要获取Endpoint的本地地址、关联的URL信息以及底层Channel关联的ChannelHandle，也就是获取建立连接需要的属性；
  2. send方法主要负责发送数据；
  3. close类方法，主要是用来关闭连接；

Channel

Channel可以理解为Client和Server端连接的通道，是NIO框架设计中不可缺少的概念，Channel继承Endpoint，因此拥有Endpoint的能力，对于Channel来说，可以给自身设计一些额外属性。

ChannelHandler

ChannelHandler可以理解为Channel的处理器，ChannelHandler 可以处理Channel的连接建立以及连接断开事件，还可以处理读取到的数据、发送的数据以及捕获到的异常。

Codec2

Codec2实现编码和解码，实现字节与消息体之间的转换，类似Netty中编码和解码。此外，Codec2接口被@SPI 接口修饰了，说明该接口是一个扩展接口，同时encode方法和 decode方法都被@Adaptive注解修饰，因此也会生成适配器类，可以根据URL中的codec值确定具体的扩展实现类，这里就体现SPI和URL灵活配置的特性。

@SPI
public interface Codec2 {

    @Adaptive({Constants.CODEC_KEY})
    void encode(Channel channel, ChannelBuffer buffer, Object message) throws IOException;

    @Adaptive({Constants.CODEC_KEY})
    Object decode(Channel channel, ChannelBuffer buffer) throws IOException;


    enum DecodeResult {
        NEED_MORE_INPUT, SKIP_SOME_INPUT
    }

}

此外还存在DecodeResult的枚举，该枚举是处理粘包和拆包使用的。

Client

Client继承了Endpoint、Channel等相关的接口，因此对于Client也具备收发消息能力，Client只可以关联一个 Channel。

RemotingServer

Server与Client不太一样地方就是可以接收多个Client发起的Channel连接，因此RemotingServer接口中存在获取多个Channel列表的接口。

Transporter

Transporter接口是Dubbo在Client和Server上又封装的一层，我们可以看到改接口被@SPI以及@Adaptive注解修饰，因此这个是个可扩展的接口，默认使用Netty的扩展，@Adaptive表示可以动态生成该适配的类，根据设置的值确定具体实现的类。

@SPI("netty")
public interface Transporter {

    @Adaptive({Constants.SERVER_KEY, Constants.TRANSPORTER_KEY})
    RemotingServer bind(URL url, ChannelHandler handler) throws RemotingException;

    @Adaptive({Constants.CLIENT_KEY, Constants.TRANSPORTER_KEY})
    Client connect(URL url, ChannelHandler handler) throws RemotingException;

}

Transporter的实现类有主要有以下几种，每个对应的具体的NIO的实现都在其各自的包中，这样可以通过灵活配置来进行切换不同的实现。

为了验证是否正确，我们简单再来看一下RemotingServer的实现，RemotingServer的实现中，包含每个具体NIO框架的实现，因此这里更加印证Transporter的的抽象，让我们可以通过Dubbo SPI修改具体Transporter扩展实现，从而切换到不同的Client和 RemotingServer实现，从而达到NIO库切换，这里我们无需修改任何代码，真正的做到开放-闭合的原则。

Transporters

Transporters该类是一种门面模式的设计，主要是解决和多个不同子模块直接进行交互的问题，通过该类设计，将公共的行为Transporter对象的创建以及ChannelHandler的处理，大家可以直接依赖Transporters类，这部分调用是在Dubbo协议初始化时候发起的，这部分我们到时候在细讲，这个章节暂时先不讲解。

但是这里需要在这个看一下关于ChannelHandler的处理，此处传入了多个ChannelHandler，将多个ChannelHandler包装成为ChannelHandlerDispatcher，ChannelHandlerDispatcher实现ChannelHandler，内部维护了一个 CopyOnWriteArraySet，对外提供操作ChannelHandler方法，此处主要是为了引出后续Handler的处理流程，后续一层处理模型的源头都在这里。

到这里我们大概对Dubbo的通讯模型有了一个轮廓，我们来进行一个简单的总结，可以参考下图:

  1. 上层通过会Transporters获取到具体的Transporter扩展实现，然后通过Transporter获取Client和 RemotingServer实现；
  2. Client与RemotingServer都是通过Channel进行交互，Channel使用ChannelHandler进行数据传输，此外通过Codec2进行编解码；

Buffer设计

image.png

接口设计

ChannelBuffer的设计类似于Netty的Buffer的设计，大致可以分为五类，对于具体的实现我们在后面AbstractChannelBuffer等实现类里面进行讲解。

接下来我们来看一下ChannelBufferFactory，该接口都是用来创建ChannelBuffer的，并且每个具体的实现都是单例的，可以理解为一个简单工厂的设计，可以有不同类型的ChannelBuffer的实现。

AbstractChannelBuffer

AbstractChannelBuffer维护两类索引，一类用于读写，另外一类用于读写标记；

关于读写类索引就是记录当前读到什么位置以及写到什么位置了，标记类索引就是为了做数据备份和回滚使用，为了对缓冲区重复利用。该类的方法都主要是利用四个属性来操作，用来检测是否有数据可读或者还是否有空间可写等方法，做一些前置条件的校验以及索引的设置，具体的实现都是需要子类来实现。

    @Override
    public void readBytes(byte[] dst, int dstIndex, int length) {
        //检查位置是否足够
        checkReadableBytes(length);
        //此处可以理解为将readerIndex后移length个字节读取到dst数组中
        //也就是数组dst的dstIndex~dstIndex+length位置
        getBytes(readerIndex, dst, dstIndex, length);
        //readerIndex后移length个字节
        readerIndex += length;
    }
    @Override
    public void readBytes(byte[] dst, int dstIndex, int length) {
        //检查位置是否足够
        checkReadableBytes(length);
        //此处可以理解为将readerIndex后移length个字节读取到dst数组中
        //也就是数组dst的dstIndex~dstIndex+length位置
        getBytes(readerIndex, dst, dstIndex, length);
        //readerIndex后移length个字节
        readerIndex += length;
    }
    @Override
    public void writeBytes(byte[] src, int srcIndex, int length) {
        //将src数组中srcIndex~srcIndex+length位置的数据写到当前的buffer中
        setBytes(writerIndex, src, srcIndex, length);
        //将当前的writerIndex后移length
        writerIndex += length;
    }

HeapChannelBuffer

HeapChannelBuffer是ChannelBuffer的一种具体的实现，该类是基于字节数组的ChannelBuffer实现，通过byte[]数组来进行数据的存储，setBytes和getBytes通过System.arraycopy来进行对数组的操作。

    //此缓冲区包装的基础堆字节数组
    protected final byte[] array;
    
    @Override
    public void getBytes(int index, byte[] dst, int dstIndex, int length) {
        System.arraycopy(array, index, dst, dstIndex, length);
    }

    @Override
    public void setBytes(int index, byte[] src, int srcIndex, int length) {
        System.arraycopy(src, srcIndex, array, index, length);
    }

对于HeapChannelBuffer的具体的工厂的实现是HeapChannelBufferFactory，该工厂是一个单例模式，HeapChannelBufferFactory通过ChannelBuffers工具类创建固定容量的HeapChannelBuffer，此外也可以通过拷贝的形式创建HeapChannelBuffer。

    @Override
    public ChannelBufferFactory factory() {
        return HeapChannelBufferFactory.getInstance();
    }

DynamicChannelBuffer

DynamicChannelBuffer可以理解为一个扩展类，也就是对装饰者模式，就是对ChannelBuffer的增加强，增加动态扩容的能力，关于该类默认的实现HeapChannelBufferFactory，我可以通过指定HeapChannelBufferFactory为对应的实现添加动态扩容的能力。

    //具体的ChannelBufferFactory的实现
    private final ChannelBufferFactory factory;

    //需要扩容的buffer
    private ChannelBuffer buffer;

    public DynamicChannelBuffer(int estimatedLength) {
        //默认实现
        this(estimatedLength, HeapChannelBufferFactory.getInstance());
    }

    //指定具体的实现
    public DynamicChannelBuffer(int estimatedLength, ChannelBufferFactory factory) {
        if (estimatedLength < 0) {
            throw new IllegalArgumentException("estimatedLength: " + estimatedLength);
        }
        if (factory == null) {
            throw new NullPointerException("factory");
        }
        this.factory = factory;
        buffer = factory.getBuffer(estimatedLength);
    }

关于如何实现ChannelBuffer的动态扩容，看懂Java ArryList扩容的，我相信一定能理解，也就是我们要控制写入时候的判断写入的空间是否足够就可以了。DynamicChannelBuffer通过ensureWritableBytes方法来实现扩容，我们来看下他是如何做的:

    @Override
    public void ensureWritableBytes(int minWritableBytes) {
        //如果写入字节数小于等于可写的字节数
        if (minWritableBytes <= writableBytes()) {
            return;
        }
        //新增容量
        int newCapacity;
        //缓存区字节数为0
        if (capacity() == 0) {
            //设置为1
            newCapacity = 1;
        } else {
            //新增容量为缓冲区字节数
            newCapacity = capacity();
        }
        //最小新增容量 = 当前写入字节数的索引+最小写入的字节数
        int minNewCapacity = writerIndex() + minWritableBytes;
        //如果新增容量小于最小新增容量
        while (newCapacity < minNewCapacity) {
            //新增容量左移1位，加倍
            newCapacity <<= 1;
        }
        //通过工厂类创建该容量
        ChannelBuffer newBuffer = factory().getBuffer(newCapacity);
        //从buffer中读取数据到newBuffer中
        newBuffer.writeBytes(buffer, 0, writerIndex());
        //替换原来的缓存区
        buffer = newBuffer;
    }

ByteBufferBackedChannelBuffer

ByteBufferBackedChannelBuffer该类是基于Java NIO的ByteBuffer实现的ChannelBuffer，都是通过操作ByteBuffer的API进行实现，这里我们就不展开了。

    //NIO ByteBuffer
    private final ByteBuffer buffer;

    //初始化容量
    private final int capacity;

    public ByteBufferBackedChannelBuffer(ByteBuffer buffer) {
        if (buffer == null) {
            throw new NullPointerException("buffer");
        }

        this.buffer = buffer.slice();
        capacity = buffer.remaining();
        writerIndex(capacity);
    }

    public ByteBufferBackedChannelBuffer(ByteBufferBackedChannelBuffer buffer) {
        this.buffer = buffer.buffer;
        capacity = buffer.capacity;
        setIndex(buffer.readerIndex(), buffer.writerIndex());
    }

ChannelBufferInputStream

ChannelBufferInputStream该类实现InputStream输入流的的方法，内部维护了ChannelBuffer、startIndex以及endIndex，该方法内部都是读取ChannelBuffer中的数据，startIndex和endIndex控制读取数据位置，这样就完成 InputStream的扩展实现。

    //ChannelBuffer
    private final ChannelBuffer buffer;
    //开始位置
    private final int startIndex;
    //结束位置
    private final int endIndex;

    @Override
    public int read() throws IOException {
        if (!buffer.readable()) {
            return -1;
        }
        return buffer.readByte() & 0xff;
    }

ChannelBufferOutputStream

ChannelBufferOutputStream该类实现OutputStream输出流，内部维护了ChannelBuffer、startIndex，该方法内部都是写入到ChannelBuffer中，startIndex是标记开始写入位置。 Buffer的整体的设计到此就介绍完成，通过ChannelBufferOutputStream、ChannelBufferInputStream控制数据的输入输出，内部通过ChannelBuffer存储数据，ChannelBuffer可以根据需要进行不同的实现。

Transport设计

Transport在核心API中介绍上层访问都是通过该接口访问的，接下来我们就来探秘下Transport层都做了哪些事情。

AbstractPeer

AbstractPeer该抽象类可以理解为服务器概念，继承了Endpoint、ChannelHandler接口，内部有四个核心的属性，URL代表自身服务的地址，closing、closed表示当前服务器状态，handler就是ChannelHandler，AbstractPeer内部实现了都是委托给ChannelHandler，这是一种典型的装饰器设计模式。

    //ChannelHandler
    private final ChannelHandler handler;

    //自身地址
    private volatile URL url;

    //服务器状态
    private volatile boolean closing;

    private volatile boolean closed;

    public AbstractPeer(URL url, ChannelHandler handler) {
        if (url == null) {
            throw new IllegalArgumentException("url == null");
        }
        if (handler == null) {
            throw new IllegalArgumentException("handler == null");
        }
        this.url = url;
        this.handler = handler;
    }

AbstractEndpoint

AbstractEndpoint继承AbstractPeer，可以理解为端口的抽象，内部增加Codec2和connectTimeout两个属性，在AbstractEndpoint在初始化的时候会将这两个字段初始化。

    private Codec2 codec;

    private int connectTimeout;

    public AbstractEndpoint(URL url, ChannelHandler handler) {
        //调用父类
        super(url, handler);
        //根据URL中的codec参数值，确定此处具体的Codec2实现类
        this.codec = getChannelCodec(url);
        //设置connectTimeout
        this.connectTimeout = url.getPositiveParameter(Constants.CONNECT_TIMEOUT_KEY, Constants.DEFAULT_CONNECT_TIMEOUT);
    }
    protected static Codec2 getChannelCodec(URL url) {
        //获取URL协议
        String codecName = url.getProtocol();
        //判断有没有该扩展名
        if (ExtensionLoader.getExtensionLoader(Codec2.class).hasExtension(codecName)) {
            //通过ExtensionLoader加载具体实现类
            return ExtensionLoader.getExtensionLoader(Codec2.class).getExtension(codecName);
        } else {
            //没有匹配到从扩展类进行加载
            return new CodecAdapter(ExtensionLoader.getExtensionLoader(Codec.class)
                    .getExtension(codecName));
        }
    }

此外该接口实现Resetable接口，该接口内部只有一个reset方法，该方法通过获取URL参数信息，重置了connectTimeout的信息以及Codec2的信息。

AbstractServer

AbstractServer是对服务端的抽象，该抽象类实现AbstractEndpoint和RemotingServer，该抽象类内部有五个核心属性，localAddress、bindAddress这两个属性都是在URL参数中获取，表示Server本地的地址以及绑定的地址，默认两个值是一致的，accepts表示是Server最大的连接次数，默认是0，表述没有限制，executorRepository、executor线程池相关的属性，executorRepository负责管理线程池，executor表示当前服务管理的线程池。

    //当前服务关联的线程池
    ExecutorService executor;
    //本机地址
    private InetSocketAddress localAddress;
    //绑定地址
    private InetSocketAddress bindAddress;
    //最大连接数
    private int accepts;
    //管理线程池
    private ExecutorRepository executorRepository = ExtensionLoader.getExtensionLoader(ExecutorRepository.class).getDefaultExtension();

AbstractServer初始化也就是在构造函数中完成初始化的，然后通过调用其抽象方法doOpen实现启动服务器。

    public AbstractServer(URL url, ChannelHandler handler) throws RemotingException {
        //调用父类
        super(url, handler);
        //从URL获取本地地址
        localAddress = getUrl().toInetSocketAddress();

        String bindIp = getUrl().getParameter(Constants.BIND_IP_KEY, getUrl().getHost());
        int bindPort = getUrl().getParameter(Constants.BIND_PORT_KEY, getUrl().getPort());
        if (url.getParameter(ANYHOST_KEY, false) || NetUtils.isInvalidLocalHost(bindIp)) {
            bindIp = ANYHOST_VALUE;
        }
        //绑定地址
        bindAddress = new InetSocketAddress(bindIp, bindPort);
        //连接数
        this.accepts = url.getParameter(ACCEPTS_KEY, DEFAULT_ACCEPTS);
        try {
            //调用该抽象方法启动服务
            doOpen();
            if (logger.isInfoEnabled()) {
                logger.info("Start " + getClass().getSimpleName() + " bind " + getBindAddress() + ", export " + getLocalAddress());
            }
        } catch (Throwable t) {
            throw new RemotingException(url.toInetSocketAddress(), null, "Failed to bind " + getClass().getSimpleName()
                    + " on " + getLocalAddress() + ", cause: " + t.getMessage(), t);
        }
        //创建该服务对应的线程池
        executor = executorRepository.createExecutorIfAbsent(url);
    }

AbstractClient

AbstractClient是对客户端的抽象，同样它的继承和AbstractServer也一样，只是在实现不同而已，接下来我们来看看AbstractClient的实现，该类内部有4个关键的字段，对于executor和executorRepository这两个字段与AbstractServer功能类似，这里重点来介绍connectLock和needReconnect，connectLock是当客户端进行连接、断开、重连等操作时，需要获取该锁进行同步操作，needReconnect 在客户端发送数据之前，会检查客户端的连接是否断开，如果断开了，则会根据needReconnect字段，决定是否重连。

AbstractClient整体的初始化是在构造函数实现的，我们可以看到AbstractClient 定义了 doOpen、doClose、doConnect和doDisConnect四个抽象方法给子类实现，整体的设计与AbstractServer类似。

    public AbstractClient(URL url, ChannelHandler handler) throws RemotingException {
        //调用父类构造方法
        super(url, handler);
        //从URL获取是否重连字段 默认是
        needReconnect = url.getParameter(Constants.SEND_RECONNECT_KEY, true);
        //初始化Executor
        initExecutor(url);

        try {
            //初始化具体的底层实现client
            doOpen();
        } catch (Throwable t) {
            //关闭
            close();
            throw new RemotingException(url.toInetSocketAddress(), null,
                    "Failed to start " + getClass().getSimpleName() + " " + NetUtils.getLocalAddress()
                            + " connect to the server " + getRemoteAddress() + ", cause: " + t.getMessage(), t);
        }

        try {
            //创建连接
            connect();
            if (logger.isInfoEnabled()) {
                logger.info("Start " + getClass().getSimpleName() + " " + NetUtils.getLocalAddress() + " connect to the server " + getRemoteAddress());
            }
        } catch (RemotingException t) {
            if (url.getParameter(Constants.CHECK_KEY, true)) {
                close();
                throw t;
            } else {
                logger.warn("Failed to start " + getClass().getSimpleName() + " " + NetUtils.getLocalAddress()
                        + " connect to the server " + getRemoteAddress() + " (check == false, ignore and retry later!), cause: " + t.getMessage(), t);
            }
        } catch (Throwable t) {
            close();
            throw new RemotingException(url.toInetSocketAddress(), null,
                    "Failed to start " + getClass().getSimpleName() + " " + NetUtils.getLocalAddress()
                            + " connect to the server " + getRemoteAddress() + ", cause: " + t.getMessage(), t);
        }
    }

AbstractChannel

AbstractChannel的设计也是类似模板类的设计，对于不同的NIO框架来说有不同的Channel的实现，因此对于Dubbo来说也必须去抽象该实现，具体的不同交由子类进行实现，子类做映射。该类内部只有有一个Send方法，为了判断当前的连接是否还在，没有实现具体的发送消息。

Netty4

NettyTransporter

NettyTransporter实现Transporter，当SPI机制触发的时候会自动加载实现NettyServer、NettyClient初始化创建。

NettyServer

接下来我们来看下Netty4中关于doOpen方法的实现，此处就是Netty Server启动的核心，也是Dubbo网络通信的服务端能力的提供者，就是Dubbo和Netty结合的核心。

    protected void doOpen() throws Throwable {
        //创建ServerBootstrap
        bootstrap = new ServerBootstrap();

        //创建boss EventLoopGroup
        bossGroup = NettyEventLoopFactory.eventLoopGroup(1, "NettyServerBoss");
        //创建worker EventLoopGroup
        workerGroup = NettyEventLoopFactory.eventLoopGroup(
                getUrl().getPositiveParameter(IO_THREADS_KEY, Constants.DEFAULT_IO_THREADS),
                "NettyServerWorker");
        //创建一个Netty的ChannelHandler
        final NettyServerHandler nettyServerHandler = new NettyServerHandler(getUrl(), this);
        //此处的Channel是Dubbo的Channel
        channels = nettyServerHandler.getChannels();
        //会话保持
        boolean keepalive = getUrl().getParameter(KEEP_ALIVE_KEY, Boolean.FALSE);

        bootstrap.group(bossGroup, workerGroup)
                .channel(NettyEventLoopFactory.serverSocketChannelClass())
                .option(ChannelOption.SO_REUSEADDR, Boolean.TRUE)
                .childOption(ChannelOption.TCP_NODELAY, Boolean.TRUE)
                .childOption(ChannelOption.SO_KEEPALIVE, keepalive)
                .childOption(ChannelOption.ALLOCATOR, PooledByteBufAllocator.DEFAULT)
                .childHandler(new ChannelInitializer<SocketChannel>() {
                    @Override
                    protected void initChannel(SocketChannel ch) throws Exception {
                        // FIXME: should we use getTimeout()?
                        //连接空闲超时时间
                        int idleTimeout = UrlUtils.getIdleTimeout(getUrl());
                        //创建Netty实现的decoder和encoder
                        NettyCodecAdapter adapter = new NettyCodecAdapter(getCodec(), getUrl(), NettyServer.this);
                        if (getUrl().getParameter(SSL_ENABLED_KEY, false)) {
                            //如果配置HTTPS 要实现SslHandler
                            ch.pipeline().addLast("negotiation",
                                    SslHandlerInitializer.sslServerHandler(getUrl(), nettyServerHandler));
                        }
                        ch.pipeline()
                                .addLast("decoder", adapter.getDecoder())
                                .addLast("encoder", adapter.getEncoder())
                                //心跳检查
                                .addLast("server-idle-handler", new IdleStateHandler(0, 0, idleTimeout, MILLISECONDS))
                                //注册nettyServerHandler
                                .addLast("handler", nettyServerHandler);
                    }
                });
        // bind
        ChannelFuture channelFuture = bootstrap.bind(getBindAddress());
        //等待绑定完成
        channelFuture.syncUninterruptibly();
        channel = channelFuture.channel();

    }

此处与Netty启动不同的地方在于替换了Channel的实现为Dubbo实现，然后通过doOpen完成Server启动，大家也可以借助下图来进行理解:

NettyCodecAdapter

NettyCodecAdapter该类是对编解码的实现，主要是将Netty规则替换为为Dubbo的规则，该类内部有5个核心的属性，其中encoder和decoder是NettyCodecAdapter内部类，

    //Netty Channel 编码
    private final ChannelHandler encoder = new InternalEncoder();

    //Netty Channel 解码
    private final ChannelHandler decoder = new InternalDecoder();

    //Dubbo 的编解码
    private final Codec2 codec;

    //URL参数
    private final URL url;

    //Dubbo ChannelHandler
    private final org.apache.dubbo.remoting.ChannelHandler handler;

encoder和decoder是对Netty中的ByteToMessageDecoder和MessageToByteEncoder的实现，也正是此处的实现将真正的编码委托给Codec2进行实现，

    private class InternalEncoder extends MessageToByteEncoder {

        @Override
        protected void encode(ChannelHandlerContext ctx, Object msg, ByteBuf out) throws Exception {
            //Netty对ChannelBuffer的实现 操作字节数组
            //将Netty  ByteBuf 包装为 Dubbo  ChannelBuffer
            ChannelBuffer buffer = new NettyBackedChannelBuffer(out);
            //获取关联的Channel
            Channel ch = ctx.channel();
            NettyChannel channel = NettyChannel.getOrAddChannel(ch, url, handler);
            //codec进行编码
            codec.encode(channel, buffer, msg);
        }
    }

    private class InternalDecoder extends ByteToMessageDecoder {

        @Override
        protected void decode(ChannelHandlerContext ctx, ByteBuf input, List<Object> out) throws Exception {
            //将Netty  ByteBuf 包装为 Dubbo  ChannelBuffer
            ChannelBuffer message = new NettyBackedChannelBuffer(input);
            //获取关联的Channel
            NettyChannel channel = NettyChannel.getOrAddChannel(ctx.channel(), url, handler);

            // decode object.
            do {
                //记录当前读到的位置
                int saveReaderIndex = message.readerIndex();
                //codec进行解码
                Object msg = codec.decode(channel, message);
                //判断消息长度是否足够
                if (msg == Codec2.DecodeResult.NEED_MORE_INPUT) {
                    //重置读取的位置
                    message.readerIndex(saveReaderIndex);
                    break;
                } else {
                    //边界值判断
                    if (saveReaderIndex == message.readerIndex()) {
                        throw new IOException("Decode without read data.");
                    }
                    //将消息传递给其他Handler
                    if (msg != null) {
                        out.add(msg);
                    }
                }
            } while (message.readable());
        }
    }

NettyServerHandler

NettyServerHandler该类继承了Netty的ChannelDuplexHandler，该类具备同时处理Inbound和Outbound的能力，我们来看下整体的继承结构，整体的继承结构确实也是一样的。

该类内部主要有3个核心字段，这里相对比较重要的是channels和handler，

channels字段缓存当前所有Server创建的Channel，所有的创建、断开连接的时候都会操作channels该对象，handler在内部所有的实现都是通过Dubbo ChannelHandler,这样就完成对Netty的替换；代码如下:

    @Override
    public void channelActive(ChannelHandlerContext ctx) throws Exception {
        NettyChannel channel = NettyChannel.getOrAddChannel(ctx.channel(), url, handler);
        if (channel != null) {
            //新建的链接 增加缓存
            channels.put(NetUtils.toAddressString((InetSocketAddress) ctx.channel().remoteAddress()), channel);
        }
        //使用Dubbo ChannelHandler建立连接
        handler.connected(channel);

        if (logger.isInfoEnabled()) {
            logger.info("The connection of " + channel.getRemoteAddress() + " -> " + channel.getLocalAddress() + " is established.");
        }
    }

    @Override
    public void channelInactive(ChannelHandlerContext ctx) throws Exception {
        NettyChannel channel = NettyChannel.getOrAddChannel(ctx.channel(), url, handler);
        try {
            //关闭连接 移除缓存
            channels.remove(NetUtils.toAddressString((InetSocketAddress) ctx.channel().remoteAddress()));
            //关闭释放Dubbo ChannelHandler
            handler.disconnected(channel);
        } finally {
            //NettyChannel也同时移除
            NettyChannel.removeChannel(ctx.channel());
        }

        if (logger.isInfoEnabled()) {
            logger.info("The connection of " + channel.getRemoteAddress() + " -> " + channel.getLocalAddress() + " is disconnected.");
        }
    }

在NettyServer创建的时候，有下图代码，这里的this指的就是NettyServer，在NettyServerHandler里面第二个参数是ChannelHandler，同时NettyServer又继承了实现ChannelHandler的AbstractPeer，因此NettyServerHandler在创建的时候就会将所有数据委托给ChannelHandler进行处理，此处体现多态的魅力。

到此相信你也对Netty Server以及Dubbo Server设计有了一个深入的了解，可以参考下图，上层是对Client、Channel等能力的抽象，这些抽象能力抽象接口实现，这样子该抽象方法子类又可以有不同的实现，这样子就完成上层能力的建设，下层又可以根据自身特点完成自己编解码以及服务的实现，做到了灵活多变，自由扩展。

NettyClient

NettyClient实现与NettyServer类似，都是初始化自身服务，这里我们来看下实现；

  @Override
    protected void doOpen() throws Throwable {
        //创建NettyClientHandler 做法与Server类似
        final NettyClientHandler nettyClientHandler = new NettyClientHandler(getUrl(), this);
        bootstrap = new Bootstrap();
        bootstrap.group(EVENT_LOOP_GROUP)
                .option(ChannelOption.SO_KEEPALIVE, true)
                .option(ChannelOption.TCP_NODELAY, true)
                .option(ChannelOption.ALLOCATOR, PooledByteBufAllocator.DEFAULT)
                //.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, getTimeout())
                .channel(socketChannelClass());
        //设置超时时间
        bootstrap.option(ChannelOption.CONNECT_TIMEOUT_MILLIS, Math.max(DEFAULT_CONNECT_TIMEOUT, getConnectTimeout()));
        bootstrap.handler(new ChannelInitializer<SocketChannel>() {

            @Override
            protected void initChannel(SocketChannel ch) throws Exception {
                //设置心跳的间隔
                int heartbeatInterval = UrlUtils.getHeartbeat(getUrl());

                if (getUrl().getParameter(SSL_ENABLED_KEY, false)) {
                    ch.pipeline().addLast("negotiation", SslHandlerInitializer.sslClientHandler(getUrl(), nettyClientHandler));
                }

                NettyCodecAdapter adapter = new NettyCodecAdapter(getCodec(), getUrl(), NettyClient.this);
                ch.pipeline()//.addLast("logging",new LoggingHandler(LogLevel.INFO))//for debug
                        //解密编码
                        .addLast("decoder", adapter.getDecoder())
                        .addLast("encoder", adapter.getEncoder())
                        //设置心跳
                        .addLast("client-idle-handler", new IdleStateHandler(heartbeatInterval, 0, 0, MILLISECONDS))
                        //注册nettyClientHandler
                        .addLast("handler", nettyClientHandler);
                //如果需要Socks5Proxy，需要添加Socks5ProxyHandler(略
                String socksProxyHost = ConfigUtils.getProperty(SOCKS_PROXY_HOST);
                if(socksProxyHost != null) {
                    int socksProxyPort = Integer.parseInt(ConfigUtils.getProperty(SOCKS_PROXY_PORT, DEFAULT_SOCKS_PROXY_PORT));
                    Socks5ProxyHandler socks5ProxyHandler = new Socks5ProxyHandler(new InetSocketAddress(socksProxyHost, socksProxyPort));
                    ch.pipeline().addFirst(socks5ProxyHandler);
                }
            }
        });
    }

形成通信的通道的图也是类似:

对于NettyClientHandler实现整体上与NettyServerHandler的设计思路类似，这里就不进行介绍了，

NettyChannel

NettyChannel是对AbstractChannel一种实现，有四个字段，

    //缓存Netty Channel 和 Dubbo Channel的对应关系
    private static final ConcurrentMap<Channel, NettyChannel> CHANNEL_MAP = new ConcurrentHashMap<Channel, NettyChannel>();
    //Netty Channel
    private final Channel channel;
    //Channnel附加的属性缓存
    private final Map<String, Object> attributes = new ConcurrentHashMap<String, Object>();
    //标识当前channel是否可用
    private final AtomicBoolean active = new AtomicBoolean(false);
    //炒作Channel也会操作缓存的内容
    static NettyChannel getOrAddChannel(Channel ch, URL url, ChannelHandler handler) {
        if (ch == null) {
            return null;
        }
        NettyChannel ret = CHANNEL_MAP.get(ch);
        if (ret == null) {
            NettyChannel nettyChannel = new NettyChannel(ch, url, handler);
            if (ch.isActive()) {
                nettyChannel.markActive(true);
                ret = CHANNEL_MAP.putIfAbsent(ch, nettyChannel);
            }
            if (ret == null) {
                ret = nettyChannel;
            }
        }
        return ret;
    }

    /**
     * Remove the inactive channel.
     *
     * @param ch netty channel
     */
    static void removeChannelIfDisconnected(Channel ch) {
        if (ch != null && !ch.isActive()) {
            NettyChannel nettyChannel = CHANNEL_MAP.remove(ch);
            if (nettyChannel != null) {
                nettyChannel.markActive(false);
            }
        }
    }

接下来就是核心send方法的实现，此处会关联Netty Channel，将数据发送出去，此处就是子类具体的实现。

    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.writeAndFlush(message);
            if (sent) {
                //等待发送结束
                timeout = getUrl().getPositiveParameter(TIMEOUT_KEY, DEFAULT_TIMEOUT);
                success = future.await(timeout);
            }
            //判断是否异常
            Throwable cause = future.cause();
            if (cause != null) {
                throw cause;
            }
        } catch (Throwable e) {
            //异常断开netty连接 移除缓存关系
            removeChannelIfDisconnected(channel);
            throw new RemotingException(this, "Failed to send message " + PayloadDropper.getRequestWithoutData(message) + " to " + getRemoteAddress() + ", cause: " + e.getMessage(), e);
        }
        if (!success) {
            throw new RemotingException(this, "Failed to send message " + PayloadDropper.getRequestWithoutData(message) + " to " + getRemoteAddress()
                    + "in timeout(" + timeout + "ms) limit");
        }
    }
#Java开发工程师实习##阿里巴巴面试#
全部评论

相关推荐

头像
昨天 10:07
山东大学 嵌入式软件工程师
【未来准备6】毕业论文摘要、绪论的研究内容、总结侧重点差异
毕业论文初稿接近尾声，现在就剩下标题里这仨部分没写了，像我的绪论是比较传统的“研究背景与意义&nbsp;--&nbsp;国内外研究现状&nbsp;--&nbsp;主要研究内容&nbsp;--&nbsp;章节安排”这样的结构，然后感觉这仨地方要写的点大差不差，但总不能Ctrl+C、Ctrl+V三遍吧，就展开研究了一下下……1，功能定位的差异化表达摘要可以理解为学术研究的&quot;精华萃取器&quot;，需在有限篇幅内构建独立完整的知识单元。它不仅服务于论文审稿人，更要满足后续论文送去知网、万方这些文献数据库的检索需求，本质上是一份具有自明性的研究快照。咱们需要像工匠一样打磨每个句子，确保读者不阅读全文即可把握论文的核心价值。绪论中的&quot;研究内容...
SAGIMA牛马咖啡 牛客激励计划 你们的毕业论文什么进度了
点赞 评论 收藏
分享
02-11 16:37
思特奇_招聘经理
思特奇合家欢精彩回顾第一弹｜思特奇人，争做奋斗者！质效双升，高效，高价值！
思特奇的大家庭跨越千山万水，将欢声笑语洒满了全国各地。回顾本次合家欢盛宴，不仅是对过去一年辛勤付出的肯定与庆祝，更是对每一位思特奇人奋斗者精神的提振与激励。在这里，每一位员工都是这个大家庭中不可或缺的一员，我们的每一次努力，都在为这个家的繁荣昌盛添砖加瓦。灯火辉煌处，是思特奇人最真挚的笑容；欢声笑语间，是家属们对奋斗者最深情的鼓励。在这个特别的夜晚，我们不仅见证了爱的传递，更共同绘制了一幅幅关于团结、梦想与奋斗的绚丽画卷。每一幅画面，都是一个温暖的故事，讲述着思特奇人在不同地域、不同岗位上，如何用汗水浇灌希望，以智慧点亮生活。每一站的相聚，都是对过去一年辛勤耕耘的最好回馈，也是对未来旅程的美好...
思特奇公司氛围 15人发布 投递思特奇等公司10个岗位 >
点赞 评论 收藏
分享
01-06 04:55
重庆邮电大学 Java
点赞 评论 收藏
分享
2024-12-23 23:42
东华大学 Java
点赞 评论 收藏
分享
02-12 14:25
沈阳化工大学 Java
快手日常支付（电商）一面
能实习多久实习拷打：实习主要做的内容介绍一下怎么获取的对应的部署数据问了具体的表设计，以及不同的表存储的什么数据为什么你这个SQL会更快呢（一点点扣，一点点介绍聊了20分钟）为什么不在代码中对数据处理，而是通过一条sql的形式处理的呢（首先保证原子性、其次逐条判断效率低）ON&nbsp;DUPLICATE&nbsp;KEY&nbsp;UPDATE会有什么缺点呢（在mysql中适用，但是SQlserver不适用，对于使用了索引的update操作就没必要使用）离职检测会在什么时候触发为什么不是在人员离职那一时刻处理呢算法：字符串相加八股文：线程池参数核心线程数和最大线程数还有队列长度怎么安排呢mysql默认的隔离级别举了两个在...
卡卡罗特w：这就是百度的title 吗，全是大厂面试
查看13道真题和解析
点赞 评论 收藏
分享
评论
2
2
分享

招聘动态

查看更多

26届实习生双选会报名开启

26届实习软件笔试必刷题单

全站热榜

更多

创作者周榜

更多
正在热议
更多
# 大疆今年的机械笔试难吗？ #
34442次浏览 405人参与
# 影石Insta360求职进展汇总 #
105887次浏览 936人参与
# 文科生还参加今年的春招吗 #
1692次浏览 20人参与
# 大疆的机械笔试比去年难吗 #
63316次浏览 575人参与
# 选择和努力，哪个更重要？ #
36407次浏览 394人参与
# 24届市场营销薪资爆料 #
9004次浏览 62人参与
# 一人推荐一个值得去的通信/硬件公司 #
160234次浏览 1729人参与
# 如果公司降薪，你会跳槽吗？ #
42540次浏览 319人参与
# 提前批的机械人，你们都有面试了吗 #
86146次浏览 929人参与
# 产品实习，你更倾向大公司or小公司 #
128687次浏览 1710人参与
# 产品薪资爆料 #
96688次浏览 814人参与
# 春招启动，你开始投递了吗？ #
44983次浏览 434人参与
# 秋招前后对offer的期望对比 #
221547次浏览 1648人参与
# 大学四年该怎么过，才不算浪费时间？ #
3292次浏览 32人参与
# 华为工作体验 #
149611次浏览 1052人参与
# 职场上哪些事情令人讨厌 #
12692次浏览 57人参与
# 机械人，你的第一份感谢信是谁给的 #
19861次浏览 257人参与
# 和牛牛一起刷真题 #
104914次浏览 2067人参与
# 你觉得机械有必要实习吗 #
33532次浏览 318人参与
# 2022毕业的你对23届的寄语 #
35053次浏览 533人参与
牛客网
牛客企业服务