第五章 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)访问字节元素不会改变过readerIndex 和writerIndex。

顺序访问索引

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

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中InputStream的mark(int readlimit)和reset()，这些方法用来标注当前的stream的索引到的具体位置，然后可以相对应的将stream重置到刚才标注的位置
通过调用clear()的方法将readerIndex和writeIndex两个索引下标全部置为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(默认使用)和UnpooledByteBufAllocator，PooledByteBufAllocator通过池化ByteBuf实例来提高分配效率，而UnpooledByteBufAllocator则每次返回一个新的ByteBuf实例
Unppoled：当没有ByteBufAllocator的引用时，可以使用Unppoled，该类提供了一个静态的工具方法来创造一个非池化的ByteBuf实例
ByteBufUtil：ByteBufUtil提供了很多静态的工具方法来管控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

Netty in Action — Chapter 5