您所在的位置：程序员俱乐部 > 编程开发 > JAVA > 深入研究Netty框架之ByteBuf功能原理及源码分析

深入研究Netty框架之ByteBuf功能原理及源码分析

2019/7/18 19:10:01 yuqingshui 程序员俱乐部我要评论(0)

摘要：ByteBuf功能原理ByteBuf是一个byte数组的缓冲区，通过两个位置指针完成缓冲区的读写操作，读操作使用readerIndex，写操作使用writeIndex。readerIndex和writeIndex初始取值均为0，写入数据，writeIndex增加；读取数据则readerIndex增加。0~readerIndex之间的数据是已经读取的，调用discardReadBytes()可释放这部分空间，其作用类似于JDKByteBuffer的compact()方法
标签：功能源码 net 分析研究

ByteBuf功能原理

ByteBuf是一个byte数组的缓冲区，通过两个位置指针完成缓冲区的读写操作，读操作使用readerIndex，写操作使用writeIndex。

readerIndex和writeIndex初始取值均为0，写入数据，writeIndex增加；读取数据则readerIndex增加。0~readerIndex之间的数据是已经读取的，调用discardReadBytes()可释放这部分空间，其作用类似于JDK　ByteBuffer的compact()方法；readerIndex~writeIndex之间的数据是可读取的，等价于ByteBuffer position和limit之间的数据；writeIndex和capacity之间的空间是可写入的，等价于ByteBuffer?limit和capacity之间的可用空间；调用clear()可重置readerIndex和writeIndex为0，但该操作不会清理buffer中的内容。

初始分配的ByteBuf：

+-------------------------------------------------------+
|                writable bytes                         |
+-------------------------------------------------------+
|                                                       |
0 = readerIndex = writerIndex                       capacity

写入N个字节后的ByteBuf：

+-------------------------------------+------------------+
|       readable bytes                |  writable bytes  |
|       (CONTENT)                     |                  |
+-------------------------------------+------------------+
|                                     |                  |
0 = readerIndex                N = writerIndex    <=  capacity

读取M（<=N）个字节后的ByteBuf：

+-------------------+------------------+------------------+
| discardable bytes |  readable bytes  |  writable bytes  |
|                   |     (CONTENT)    |                  |
+-------------------+------------------+------------------+
|                   |                  |                  |
0          M  = readerIndex  <=    N = writerIndex  <= capacity

调用discardReadBytes()方法之后的ByteBuf：

+-------------------+---------------------+
|   readable bytes  |  writable bytes     |
+-------------------+---------------------+
|                   |                     |
0 = readerIndex   N-M = writerIndex  <= capacity

调用clear()方法之后的ByteBuf：

+-------------------------------------------------------+
|                writable bytes                         |
+-------------------------------------------------------+
|                                                       |
0 = readerIndex = writerIndex                       capacity

ByteBuf 动态扩展

通常情况下，当对JDK?ByteBuffer进行put操作时，如果缓冲区可写空间不够，就会抛出BufferOverflowException异常。为了避免这个问题，在进行put操作时，需要对可写空间进行判断，如果剩余可写空间不足，需要创建一个新ByteBuffer，并将之前ByteBuffer的内容复制到新创建的ByteBuffer中，然后释放老的ByteBuffer。

class="hljs java" style="font-family: Menlo, Monaco, Consolas, 'Courier New', monospace; font-size: 13px; display: block; color: #333333; margin: 0px; padding: 0px; border-radius: 3px; overflow: visible; line-height: 1.6;">//needSize为需要写入的字节数
if(this.buffer.remaining()<needSize){
    int realAllocateSize=needSize>128 ? needSize:128;
    ByteBuffer newBuffer=ByteBuffer.allocate(this.buffer.capacity()+realAllocateSize);
    this.buffer.flip();
    newBuffer.put(this.buffer);
    this.buffer=newBuffer;
}

为防止ByteBuffer溢出，每次进行put操作都需要进行可写空间校验，这导致了代冗余。

为了解决这个问题，ByteBuf对write方法进行了封装，由write操作负责进行剩余可用空间的校验，当空间不足时，由ByteBuf自动进行动态扩展（不超过maxCapacity），使用者无需关心底层的校验和动态扩展细节。

源码如下：

    @Override
    function">public ByteBuf writeBytes(ByteBuf src, int srcIndex, int length) {
        ensureWritable(length);
        setBytes(writerIndex, src, srcIndex, length);
        writerIndex += length;
        return this;
    }

当执行writeBytes时，先调用ensureWritable(length)进行可写空间的校验。

    @Override
    public ByteBuf ensureWritable(int minWritableBytes) {
        if (minWritableBytes < 0) {
            throw new IllegalArgumentException(String.format(
                    "minWritableBytes: %d (expected: >= 0)", minWritableBytes));
        }

        if (minWritableBytes <= writableBytes()) {
            return this;
        }

        if (minWritableBytes > maxCapacity - writerIndex) {
            throw new IndexOutOfBoundsException(String.format(
                    "writerIndex(%d) + minWritableBytes(%d) exceeds maxCapacity(%d): %s",
                    writerIndex, minWritableBytes, maxCapacity, this));
        }

        // Normalize the current capacity to the power of 2.
        int newCapacity = calculateNewCapacity(writerIndex + minWritableBytes);

        // Adjust to the new capacity.
        capacity(newCapacity);
        return this;
    }

当需要写入的字节数大于缓冲区最大可写字节数时，ByteBuf自动进行动态扩展。calculateNewCapacity(writerIndex + minWritableBytes)方法用于计算缓冲区新的容量，capacity(newCapacity)则用于实现动态扩展，后面会详细介绍其源码。

ByteBuf 主要API

顺序读操作（read）

方法名称返回值功能说明抛出异常 readBoolean() boolean

从readerIndex开始读取1字节的数据

throws?IndexOutOfBoundsException

readableBytes<1

readByte() byte 从readerIndex开始读取1字节的数据

throws?IndexOutOfBoundsException

readableBytes<1

readUnsignedByte() short 从readerIndex开始读取1字节的数据（无符号字节值）