【Netty】 ByteBuf的常用API总结

NettyBoy

已于 2023-09-28 10:32:52 修改

阅读量373

点赞数 1

分类专栏： JAVA语言文章标签： java 开发语言

于 2023-09-27 18:06:36 首次发布

本文链接：https://blog.csdn.net/smallbirdnq/article/details/133351948

版权

JAVA语言专栏收录该内容

10 篇文章 0 订阅

订阅专栏

一、ByteBuf介绍

二、ByteBuf创建

1.池化创建 ByteBufAllocator

2.Unpooled （非池化）创建ByteBuf

3.ByteBufUtil 操作ByteBuf

本篇主要介绍ByteBuf的常用操作API，Netty性能的卓越表现离不开ByteBuf的巧妙设计，它提供了一系列的缓冲区读写方法，另外为了方便起见还特定义了ByteBufUtil，提供了比较丰富的操作ByteBuf方法。

一、ByteBuf介绍

为了提高性能，Netty重新设计了字节缓冲区ByteBuf，类似Java Nio的ByteBuffer，但工作方式略有区别，比后者更加灵活、高效。

ByteBuf有几个重要属性：

capacity：容量；
0：缓冲区开始位置；
readIndex：下一个读位置；
writeIndex：下一个写位置；
一个ByteBuf对象即可像byte数组一样工作，又可以像IO字节流一样工作。当前的可读数据区是[readIndex,writeIndex)；可写区是[writeIndex,capacity)；而[0,readIndex)区间的字节是可废弃数据(Discardable)，如下图所示：

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

基本的操作包括

1.从ByteBuf中读取数据，从readerIndex开始向后读取需要的字节数，readerIndex随之改变；

2.向ByteBuf中写数据，从writeIndex开始向后写数据，同时writeIndex随之改变；

3.删除ByteBuf已读数据，从[0,readerIndex)为已读完的数据，为了节省空间需要释放内存，释放示意图如下：


 *  BEFORE discardReadBytes()
 *
 *      +-------------------+------------------+------------------+
 *      | discardable bytes |  readable bytes  |  writable bytes  |
 *      +-------------------+------------------+------------------+
 *      |                   |                  |                  |
 *      0      <=      readerIndex   <=   writerIndex    <=    capacity
 *
 *
 *  AFTER discardReadBytes()
 *
 *      +------------------+--------------------------------------+
 *      |  readable bytes  |    writable bytes (got more space)   |
 *      +------------------+--------------------------------------+
 *      |                  |                                      |
 * readerIndex (0) <= writerIndex (decreased)        <=        capacity

4.清空ByteBuf数据，不需要清空数据，通过移动两个指针readerIndex和writeIndex，指向0即可。


 *  BEFORE clear()
 *
 *      +-------------------+------------------+------------------+
 *      | discardable bytes |  readable bytes  |  writable bytes  |
 *      +-------------------+------------------+------------------+
 *      |                   |                  |                  |
 *      0      <=      readerIndex   <=   writerIndex    <=    capacity
 *
 *
 *  AFTER clear()
 *
 *      +---------------------------------------------------------+
 *      |             writable bytes (got more space)             |
 *      +---------------------------------------------------------+
 *      |                                                         |
 *      0 = readerIndex = writerIndex            <=            capacity

二、ByteBuf创建

1.池化创建 ByteBufAllocator

即PooledByteBufAllocator

获取ByteBufAllocator，通过以下两种方式获取

//方法1
Channel channel = ...;
ByteBufAllocator allocator = channel.alloc();  
//方法2
ChannelHandlerContext ctx = ...;
ByteBufAllocator allocator2 = ctx.alloc();

ByteBufAllocator中创建byteBuf的方法如下

方法名称	方法描述
buffer() buffer(int) buffer(int, int)	Return a ByteBuf with heap-based or direct data storage
heapBuffer() heapBuffer(int) heapBuffer(int, int)	Return a ByteBuf with heap-based storage.
directBuffer() directBuffer(int) directBuffer(int, int)	Return a ByteBuf with direct storage.
compositeBuffer() compositeBuffer(int) heapCompositeBuffer() heapCompositeBuffer(int) directCompositeBuffer() directCompositeBuffer(int)	Return a CompositeByteBuf that can be expanded by adding heapbased or direct buffers.
ioBuffer()	Return a ByteBuf that will be used for I/O operations on a socket.

2.Unpooled （非池化）创建ByteBuf

即UnPooledByteBufAllocator

当未引用 ByteBufAllocator 时，上面的方法无法访问到 ByteBuf。对于这个用例 Netty 提供一个实用工具类称为 Unpooled,，它提供了静态辅助方法来创建非池化的 ByteBuf 实例,方法如下：

方法名称	方法描述
buffer() buffer(int) buffer(int, int)	Returns an unpooled ByteBuf with heap-based storage
directBuffer() directBuffer(int) directBuffer(int, int)	Returns an unpooled ByteBuf with direct storage
wrappedBuffer()	Returns a ByteBuf, which wraps the given data.
copiedBuffer()	Returns a ByteBuf, which copies the given data