Netty in Action — Chapter 5

第五章 ByteBuf

ByteBuf是Netty的数据容器

Netty对ByteBuffer提供了一个可选方案ByteBuf,一个很好的解决方案,解决了JDK原生的ByteBuffer的API使用不易的问题,同时ByteBuf为应用程序开发者提供了一系列的更好用的API

工作原理

ByteBuf有两个索引,一个用来读一个用来写,当你从ByteBuf中读取数据的时候,ByteBuf的readerIndex会随着被读取的字节的数量的增加而递增,与读相同,当你写一个字节的数据,那么ByteBuf的writerIndex也会递增加一。

ByteBuf

当你读取数据的时候,当readerIndex=writerIndex,你已经达到了可读的最大下标了,如果你接着尝试去读取更多的内容的时候,你会触发一个IndexOutOfBoundException的异常

ByteBuf methods whose names begin with read or write advance the corresponding index, whereas operations that begin with set and get do not. The latter methods operate on a relative index that’s passed as an argument to the method

The maximum capacity of a ByteBuf can be specified, The default limit is Integer.MAX_VALUE.

使用模式

Heap Buffers

ByteBuf模式存储数据的最常用的方式是将数据存储在JVM的堆空间


Backing Array

Direct Buffers

我们期望分配给创建的对象的内存都来自于堆,但这不是必须的。JDK1.4引入的ByteBuffer类提供一种通过原生方法分配内存的实现。

This aims to avoid copying the buffer’s contents to (or from) an
intermediate buffer before (or after) each invocation of a native I/O operation

Direct buffer data access

Composite Buffers

Composite Buffer是多种ByteBuf的聚合模式,这种模式下你可以根据需求添加或删除ByteBuf实例

A subclass of ByteBuf, CompositeByteBuf, which provides a virtual representation of multiple buffers as a single, merged buffer

ByteBuf字节层操作

随机访问索引

ByteBuf的索引跟Java原生数组索引一样嗾使[0, length()-1],使用buffer.getByte(i)访问字节元素不会改变过readerIndexwriterIndex

顺序访问索引

JDK的ByteBuffer只有一个索引,一次需要flip()来切换读和写模式。而ByteBuf有readerIndexwriterIndex

ByteBuf internal segmentation

字节内存区域

  • Discardable bytes指已经被读过的字节,通过调用discardReadBytes()可以将该字节区域转为Writable bytes
    ByteBuf after discarding read bytes

不建议为了增加可写区域而频繁的调用discardReadBytes(),因为这个方法需要Readable bytes移动到顶端,涉及内存复制操作。

  • Readable bytes中存储的是真正的数据,初始的大小为readerIndex=0
  • Writable bytes是一篇存储undefined contents的内存区域,默认初始大小是writerIndex = 0

索引管理

  • markReaderIndex()
  • markWriterIndex()
  • resetReaderIndex()
  • resetWriterIndex()
  • readerIndex(int)
  • writerIndex(int)
    以上方法类似与JDK中InputStreammark(int readlimit)reset(),这些方法用来标注当前的stream的索引到的具体位置,然后可以相对应的将stream重置到刚才标注的位置
    通过调用clear()的方法将readerIndexwriteIndex两个索引下标全部置为0,注意这将不会讲内存中内容给清除掉

Calling clear() is much less expensive than discardReadBytes() because it resets the indices without copying any memory

检索操作

ByteBufProcessor接口中定义了很多检索元素的方法,如forEachByte(ByteBufProcessor.FIND_NUL),可以使用:

ByteBuf buffer = ...;
int index = buffer.forEachByte(ByteBufProcessor.FIND_CR);

衍生缓冲区

可以通过以下方法获得衍生buffer:

  • duplicate()
  • slice()
  • slice(int, int)
  • Unpooled.unmodifiableBuffer(…)
  • order(ByteOrder)
  • readSlice(int)
    注意衍生buffer的内部存储与原buffer一致,而且在修改衍生buffer的值同时也在修改原buffer中的值;如果想要完全复制一个已经存在的buffer可以使用copy()copy(int, int)

读/写操作

  • get()set()方法将从给定的索引下标开始操作,但是操作过,对应的下标并不会改变
  • read()write()方法会从给定的索引下标开始操作,但也会根据操作对应的调整数据的值

ByteBufHolder接口

我们经常在ByteBuf中存储一些正常数据之外,我们有时候还需要增加一些各式各样的属性值,一个Http响应体就是一个很好的例子,除了按照字节传输过来的主体内容,还有状态码,cookie等信息
ByteBufHolder提供了这种对象需要在ByteBuf中存储其他信息的实现。ByteBufHolder还提供了Netty的一些高级特性,例如缓存池;ByteBufHolder提供一些获取底层数据和引用计数的方法如下:


ByteBufHolder operations

ByteBufHolder is a good choice if you want to implement a message object that stores its payload in a ByteBuf

管理ByteBuf实例

  • ByteBufAllocator:实现管理池,池中通过buffer()heapBuffer()compositeBuffer()ioBuffer()分配定义的ByteBuf实例。ByteBufAllocator的引用可以从一个Channel或者从ChannelHandlerContext中获取如:
    Channel channel = ...;
    ByteBufAllocator allocator = channel.alloc();
    ....
    ChannelHandlerContext ctx = ...;
    ByteBufAllocator allocator2 = ctx.alloc();
    
    Netty提供了ByteBufAllocator接口的两种具体实现:PooledByteBufAllocator(默认使用)UnpooledByteBufAllocatorPooledByteBufAllocator通过池化ByteBuf实例来提高分配效率,而UnpooledByteBufAllocator则每次返回一个新的ByteBuf实例
  • Unppoled:当没有ByteBufAllocator的引用时,可以使用Unppoled,该类提供了一个静态的工具方法来创造一个非池化的ByteBuf实例
  • ByteBufUtilByteBufUtil提供了很多静态的工具方法来管控ByteBuf,因为ByteBufUtil的API是通用的,与池无关的,这些方法可以被除了分配内存的类实现之外,还可以供其他的类使用。其中比较重要的两个方法
    • hexdump():将ByteBuf包含的内容打印成一个十六进制的字符。当定位问题和输出日记的时候,十六进制的表示比直接获取byte的值更加友好
    • equals():这个方法可以确认两个ByteBuf的实例是否相等

引用计数

引用计数是一门优化内存使用的技术,如果一个对象所持有的资源不再被任何对象引用的时候,将会释放这部分的资源。在Netty中实现ReferenceCounted接口的实例将维护一个引用计数,当计数为0,这个实例将由最后一次获取到该对象的对象负责释放。引用一个已经被释放的对象,会抛出IllegalReferenceCountException

总结

■ The use of distinct read and write indices to control data access
■ Different approaches to memory usage—backing arrays and direct buffers
■ The aggregate view of multiple ByteBufs using CompositeByteBuf
■ Data-access methods: searching, slicing, and copying
■ The read, write, get, and set APIs
■ ByteBufAllocator pooling and reference counting

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,681评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,710评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,623评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,202评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,232评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,368评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,795评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,461评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,647评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,476评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,525评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,226评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,785评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,857评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,090评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,647评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,215评论 2 341

推荐阅读更多精彩内容