本文共 3765 字，大约阅读时间需要 12 分钟。

本文为在掘金netty课程学习，方便复习而整理的笔记，

1 ByteBuf结构

1. 已丢弃字节：这部分数据是无效的；
2. 可读字节：这部分数据是 ByteBuf 的主体数据，从 ByteBuf 里面读取的数据都来自这一部分；
3. 可写字节：所有写到 ByteBuf 的数据都会写到这一段；

最后一部分虚线表示的是该 ByteBuf 最多还能扩容多少容量

• readerIndex： 从 ByteBuf 中每读取一个字节，readerIndex 自增1，ByteBuf 里面总共有 writerIndex-readerIndex 个字节可读, 由此可以推论出当 readerIndex 与 writerIndex 相等的时候，ByteBuf 不可读

• writerIndex ：每写一个字节，writerIndex 自增1，直到增到 capacity，这个时候，表示 ByteBuf 已经不可写了

• maxCapacity：当向 ByteBuf 写数据的时候，如容量不足可进行扩容，直到 capacity = maxCapacity，超过 maxCapacity 就会报错

Netty 使用 ByteBuf 这个数据结构可以有效地区分可读数据和可写数据，读写之间相互没有冲突

2 ByteBuf 常用的 API

2.1 容量 API

capacity()表示 ByteBuf 底层占用了多少字节的内存（包括丢弃的字节、可读字节、可写字节）

maxCapacity()表示 ByteBuf 底层最大能够占用多少字节的内存当向 ByteBuf 中写数据的时候，如果发现容量不足，则进行扩容直到扩容到 maxCapacity，超过这个数，就抛异常

readableBytes() 与 isReadable()readableBytes() 表示 ByteBuf 当前可读的字节数，它的值等于 writerIndex-readerIndex如果两者相等，则不可读，此时 isReadable() 方法返回 false

writableBytes()、 isWritable() 与 maxWritableBytes()writableBytes() 表示 ByteBuf 当前可写的字节数，它的值等于 capacity-writerIndex如果两者相等，则表示不可写，isWritable() 返回 false但是这个时候，并不代表不能往 ByteBuf 中写数据了，如果发现往 ByteBuf 中写数据写不进去的话，Netty 会自动扩容 ByteBuf，直到扩容到底层的内存大小为 maxCapacity而 maxWritableBytes() 就表示可写的最大字节数，它的值等于 maxCapacity-writerIndex

2.2 读写指针相关的 API

readerIndex() 与 readerIndex(int)前者表示返回当前的读指针 readerIndex, 后者表示设置读指针

writeIndex() 与 writeIndex(int)前者表示返回当前的写指针 writerIndex, 后者表示设置写指针

markReaderIndex() 与 resetReaderIndex()前者表示把当前的读指针保存起来后者表示把当前的读指针恢复到之前保存的值

下面两段代码是等价的：

// 代码片段1int readerIndex = buffer.readerIndex();// .. 其他操作buffer.readerIndex(readerIndex);--------------------------------------------------------------// 代码片段二buffer.markReaderIndex();// .. 其他操作buffer.resetReaderIndex();

推荐代码二这种方式，不需要自己定义变量，无论 buffer 当作参数传递到哪里，调用 resetReaderIndex() 都可以恢复到之前的状态，在解析自定义协议的数据包的时候非常常见

markWriterIndex() 与 resetWriterIndex()这一对 API 的作用与上述一对 API 类似，这里不再 赘述

2.3 读写 API

本质上，关于 ByteBuf 的读写都可以看作从指针开始的地方开始读写数据

writeBytes(byte[] src) 与 buffer.readBytes(byte[] dst)writeBytes() 表示把字节数组 src 里面的数据全部写到 ByteBufreadBytes() 指的是把 ByteBuf 里面的数据全部读取到 dst，这里 dst 字节数组的大小通常等于 readableBytes()而 src 字节数组大小的长度通常小于等于 writableBytes()

writeByte(byte b) 与 buffer.readByte()writeByte() 表示往 ByteBuf 中写一个字节而 buffer.readByte() 表示从 ByteBuf 中读取一个字节类似的 API 还有 writeBoolean()writeChar()writeShort()writeInt()writeLong()writeFloat()writeDouble() readBoolean()readChar()readShort()readInt()readLong()readFloat()readDouble() .......与读写 API 类似的 API 还有 getBytes、getByte() 与 setBytes()、setByte() 系列唯一的区别就是 get/set 不会改变读写指针而 read/write 会改变读写指针，这点在解析数据的时候千万要注意

release() 与 retain()由于 Netty 使用了堆外内存，而堆外内存是不被 jvm 直接管理的,也就是说申请到的内存无法被垃圾回收器直接回收，所以需要我们手动回收.有点类似于c语言里面，申请到的内存必须手工释放，否则会造成内存泄漏.Netty 的 ByteBuf 是通过引用计数的方式管理的如果一个 ByteBuf 没有地方被引用到，需要回收底层内存默认情况下，当创建完一个 ByteBuf，它的引用为1然后每次调用 retain() 方法， 它的引用就加一release() 方法原理是将引用计数减一减完之后如果发现引用计数为0，则直接回收 ByteBuf 底层的内存。

slice()、duplicate()、copy()这三个方法通常情况会放到一起比较，这三者的返回值都是一个新的 ByteBuf 对象slice() 方法从原始 ByteBuf 中截取一段，这段数据是从 readerIndex 到 writeIndex同时，返回的新的 ByteBuf 的最大容量 maxCapacity 为原始 ByteBuf 的 readableBytes()duplicate() 方法把整个 ByteBuf 都截取出来，包括所有的数据，指针信息slice() 方法与 duplicate() 方法的相同点是：底层内存以及引用计数与原始的 ByteBuf 共享也就是说经过 slice() 或者 duplicate() 返回的 ByteBuf 调用 write 系列方法都会影响到原始的 ByteBuf但是它们都维持着与原始 ByteBuf 相同的内存引用计数和不同的读写指针 slice() 方法与 duplicate() 不同点就是：slice() 只截取从 readerIndex 到 writerIndex 之间的数据它返回的 ByteBuf 的最大容量被限制到 原始 ByteBuf 的 readableBytes()而 duplicate() 是把整个 ByteBuf 都与原始的 ByteBuf 共享 slice() 方法与 duplicate() 方法不会拷贝数据它们只是通过改变读写指针来改变读写的行为而最后一个方法 copy() 会直接从原始的 ByteBuf 中拷贝所有的信息包括读写指针以及底层对应的数据因此，往 copy() 返回的 ByteBuf 中写数据不会影响到原始的 ByteBuf slice() 和 duplicate() 不会改变 ByteBuf 的引用计数所以原始的 ByteBuf 调用 release() 之后发现引用计数为零，就开始释放内存,调用这两个方法返回的 ByteBuf 也会被释放这个时候如果再对它们进行读写，就会报错因此，我们可以通过调用一次 retain() 方法 来增加引用表示它们对应的底层的内存多了一次引用，引用计数为2在释放内存的时候，需要调用两次 release() 方法，将引用计数降到零，才会释放内存这三个方法均维护着自己的读写指针，与原始的 ByteBuf 的读写指针无关，相互之间不受影响

待续

转载地址：https://blog.csdn.net/weixin_40597409/article/details/122906240 如侵犯您的版权，请留言回复原文章的地址，我们会给您删除此文章，给您带来不便请您谅解！