【netty】 ByteBuf的常用API总结

最新推荐文章于 2025-04-19 11:00:00 发布
最新推荐文章于 2025-04-19 11:00:00 发布
阅读量565 收藏 1
点赞数
分类专栏： 网络编程
博客围绕Netty中ByteBuf展开，介绍了其创建方式，包括池化创建ByteBufAllocator、Unpooled非池化缓存及ByteBufUtil创建；还阐述了读、写操作，读操作分get和read，get不改变读索引，read会改变；此外，还涉及索引管理、查找、副本等内容。

摘要生成于 C知道 ，由 DeepSeek-R1 满血版支持， 前往体验 >

https://blog.youkuaiyun.com/qq_26680031/article/details/79118878

一、创建

1、池化创建 ByteBufAllocator

获取ByteBufAllocator

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

 

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 （非池化）缓存

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

Table 5.9 Unpooled helper class

名称

描述

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

在 非联网项目，该 Unpooled 类也使得它更容易使用的 ByteBuf API，获得一个高性能的可扩展缓冲 API，

3、ByteBufUtil创建 （ByteBufUtil中有很多操作buf的API）

 

二、读 get/read get不会改变读索引，read会改变读索引

getBoolean(int)

返回当前索引的 Boolean 值

getByte(int) getUnsignedByte(int)

返回当前索引的(无符号)字节

getMedium(int) getUnsignedMedium(int)

返回当前索引的 (无符号) 24-bit 中间值

getInt(int) getUnsignedInt(int)

返回当前索引的(无符号) 整型

getLong(int) getUnsignedLong(int)

返回当前索引的 (无符号) Long 型

getShort(int) getUnsignedShort(int)

返回当前索引的 (无符号) Short 型

getBytes(int, ...)

字节

 

方法名称

描述

readBoolean()　

　返回当前索引的Boolean值，读索引加一

readByte()　

readUnsignedByte()　

返回当前索引的(无符号)字节，读索引加一

readMedium()　

readUnsignedMedium()　

返回当前索引的 (无符号) 24-bit 中间值，读索引加3

readInt()　

readUnsignedInt()

　返回当前索引的(无符号) 整型，读索引加4

readLong()　

readUnsignedLong()　

　返回当前索引的 (无符号) Long 型，读索引加8

readShort()　

readUnsignedShort()　

返回当前索引的 (无符号) Short 型，读索引加2

readBytes(int,int, ...)

、放回当前位置到length

得一个字节数组，读索引加length

 

 

三、写操作 set/write

方法名称

描述

setBoolean(int, boolean)

在指定的索引位置设置 Boolean 值

setByte(int, int)

在指定的索引位置设置 byte 值

setMedium(int, int)

在指定的索引位置设置 24-bit 中间 值

setInt(int, int)

在指定的索引位置设置 int 值

setLong(int, long)

在指定的索引位置设置 long 值

setShort(int, int)

在指定的索引位置设置 short 值

 

方法名称

描述

writeBoolean(boolean)

在指定的索引位置设置 Boolean 值，写索引加一

writeByte(int)

在指定的索引位置设置 byte 值，写索引加一

writeMedium(int)

在指定的索引位置设置 24-bit 中间 值，写索引加3

writeInt(int)

在指定的索引位置设置 int 值，写索引加4

writeLong(long)

在指定的索引位置设置 long 值，写索引加8

writeShort(int)

在指定的索引位置设置 short 值，写索引加2

writeBytes(int，...）

　在当前索引写入一个Byte数组，写索引加数组长度

 

四、索引管理

markReaderIndex(),

 markWriterIndex()

标记读（写）索引

resetReaderIndex()

resetWriterIndex()

读（写）索引回到mark标记的索引值

readerIndex(int)

 writerIndex(int) 

将读（写）索引设置到指定位置

clear()

可以同时设置 readerIndex 和 writerIndex 为 0。这不会清除内存中的内容

 

五、查找

forEachByte（ByteBufProcessor.FIND_NUL）

查找byte,返回byte的索引

 

六、副本

duplicate()

slice()

slice(int, int)

readOnly(),

order(ByteOrder) 

所有这些都返回一个新的 ByteBuf 实例包括它自己的 reader, writer 和标记索引。然而，内部数据存储共享就像在一个 NIO 的 ByteBuffer

 copy()

 copy(int, int)

返回的 ByteBuf 有数据的独立副本。

 

七、其他

方法名称

描述

isReadable()

返回是否有字节可读

isWritable()

返回是否可以写

readableBytes()

返回可以读的字节长度

writablesBytes()

返回可以写的字节场地

capacity()

返回byteBuf的容量

maxCapacity()

返回byteBuf可以有的最大容量

hasArray()

如果byteBuf可以直接返回一个数组就返回true

(heap buf才会为true)

array()

hasArray返回true,该方法就会返回一个数组

Netty之ByteBuf相关API
zsj777的专栏
04-15 652
package com.example.demo.util; import io.netty.buffer.ByteBuf; import io.netty.buffer.ByteBufAllocator; public class ByteBufTest { public static void main(String[] args) { //初始容量9 最大容量100 ByteBuf buf = ByteBufAllocator.DEFAULT.buff.
Netty之ByteBuf详解与实战
HaSaKing的博客
02-26 2297
ByteBuf是Netty中处理字节数据的核心类，设计用来替代Java NIO中的ByteBuffer。与ByteBuffer相比，ByteBuf提供了更高的性能和更丰富的API。它支持引用计数、池化和零拷贝操作，使得数据处理更加高效。
【Netty篇】ByteBuf 详解 （下）
最新发布
qq_56158663的博客
04-19 1293
ByteBuf就是Netty世界里的数据搬运工、信息翻译官和临时存储中心！
【Netty】 ByteBuf的常用API总结
smallbirdnq的专栏
09-27 1048
为了提高性能，Netty重新设计了字节缓冲区ByteBuf，类似Java Nio的ByteBuffer，但工作方式略有区别，比后者更加灵活、高效。ByteBuf有几个重要属性：capacity：容量；0：缓冲区开始位置；readIndex：下一个读位置；writeIndex：下一个写位置；一个ByteBuf对象即可像byte数组一样工作，又可以像IO字节流一样工作。当前的可读数据区是[readIndex,writeIndex)；可写区是[writeIndex,capacity)；
Netty——ByteBuf的API
吴声子夜歌的博客
06-15 1278
ByteBuf 正如前面所提到的，网络数据的基本单位总是字节。Java NIO 提供了 ByteBuffer 作为它 的字节容器，但是这个类使用起来过于复杂，而且也有些繁琐。 Netty 的 ByteBuffer 替代品是 ByteBuf，一个强大的实现，既解决了 JDK API 的局限性， 又为网络应用程序的开发者提供了更好的 API。 Netty 的数据处理 API 通过两个组件暴露——abstract class ByteBuf 和 interface ByteBufHolder。 优点： 它可以被
Netty源码解析-ByteBuf基本API
恐龙弟旺仔的博客
12-23 1178
前言： Netty提供了自己的ByteBuffer操作类，名字叫做ByteBuf。相比较而言，ByteBuf的操作相对简单些，也提供了更多的方法来操作字节数组。 1.ByteBuf的基本参数 ByteBuf是一个基本接口，只提供方法，关于其基本参数我们可以参考其最重要的抽象实现类AbstractByteBuf public abstract class AbstractByteBuf extends ByteBuf { // 读索引（该值之前的数据都是已读过的，可读值范...
Netty学习——源码篇1 Netty之Bytebuf
geminigoth的博客
03-13 2215
弊端一：网络传输方式存在弊端。传统的RPC框架或者基于RMI等方式的远程服务调用都采用BIO，当客户端的并发压力或网络延时增大的时候，BIO会因频繁“wait”导致I/O线程经常出现阻塞的情况，由于线程本身无法高效的工作，I/O处理能力自然就会下降。下面通过BIO通信模型看一下BIO通信的弊端。
Netty实战（五）ByteBuf—Netty的数据容器
一起学习一起进步~
05-21 2169
我们前面说过，网络数据的基本单位总是字节。Java NIO 提供了 ByteBuffer 作为它的字节容器，但是这个类使用起来过于复杂，而且也有些繁琐。ByteBuffer 替代品是 ByteBuf，一个强大的实现，既解决了 JDK API 的局限性，又为网络应用程序的开发者提供了更好的 API。下面我们将会说明和 JDK 的 ByteBuffer 相比，ByteBuf 的卓越功能性和灵活性。
Netty学习十一：内存管理之ByteBuf
weixin_41402069的博客
07-12 1698
Netty学习系列
Netty-ByteBuf
追梦的小狼狗
07-18 742
ByteBuf 由于NIO编程的复杂性，ByteBuffer也有其局限性，主要缺点如下： ByteBuffer长度固定，一旦分配成功，容量无法动态扩展或者伸缩，当需要编码的POJO对象大于ByteBuffer容量，会出现越界 ByteBuffer只有一个标识位置的指针position，读写的时候需要不断地手工调用flip()和rewind()等，否则很容易导致程序失败 ByteBuffer的AP...
Netty - Bytebuf（1）
iteye_20566的博客
04-18 204
Netty - ByteBuf 1.1 原生的ByteBuffer Java NIO的ByteBuffer被称为字节缓冲区。此类针对字节缓冲区定义了以下六类操作： 读写单个字节的绝对和相对 get 和 put 方法； 将此缓冲区的连续字节序列传输到数组中的相对批量 get 方法； 将 byte 数组或其他字节缓冲区中的连续字节序列传输到此缓冲区的相对批量 put 方法； 读写其他基本...
ByteBuf API （秒懂）-图解Netty系列
架构师尼恩
11-18 3685
Netty ByteBuf（图解二）：API 图解 疯狂创客圈 Java 分布式聊天室【 亿级流量】实战系列之16 【 博客园 总入口 】 文章目录Netty ByteBuf（图解二）：API 图解源码工程写在前面ByteBuf 的四个逻辑部分ByteBuf 的三个指针ByteBuf 的三组方法第一组：容量系列第二组：写入系列第三组：读取系列ByteBuf 的引用计数ByteBuf 的浅层复...
Netty 学习之旅：ByteBuf 篇之 ByteBuf 内部结构与 API 学习
2401_86637394的博客
09-10 664
***//***//***//***//***//**does not.*//***//***//***//***//***//***//***//***/重点强调一下如下方法，其他的类似。将字节数组 src 全部写入到缓存区中，如果 src.length 大于 ByteBuf 可写区域的话，会抛出异常。
Netty in Action -ByteBuf
lzf的博客
05-27 628
Buffer（缓冲）正如我们先前所指出的，网络数据的基本单位永远是 byte(字节)。Java NIO 提供 ByteBuffer 作为字节的容器，但这个类是过于复杂，有点难以使用。Netty 中 ByteBuffer 替代是 ByteBuf，一个强大的实现，解决JDK 的 API 的限制，以及为网络应用程序开发者一个更好的工具。但 ByteBuf 并不仅仅暴露操作一个字节序列的方法;这也是专门的...
netty源码阅读之ByteBuf之ByteBuf分类
翻身咸鱼的博客
08-23 963
ByteBuf分类，从下面三个维度： 1、Pooled和Unpooled 2、Unsafe和非Unsafe 3、Heap和Direct     一、Pooled和Unpooled 这两个的区别是使用的内存是从预先分配好的内存还是未分配的内存取，第一个从预先分配好的内存去取一段连续的内存，第二种调用系统api直接去申请一块内存。 在分配bytebuf的时候，会有一个分配器： 分...
Bytebuf的读使用
guoqu1919的博客
07-26 2714
Bytebuf的使用 首先，bytebuf有两种索引，分别是读索引（reader）和写索引（writer）， 读索引<=写索引 reader是顺序读，表示从索引的位置按顺序往下读， 可以使用buf.readerindex(3)将读索引设置为3，然后接着顺序读。 同样可以使用get方法直接从指定位置顺序读： buf.getFloat(4)：从索引为4的位置读一个Float的数（Float为4个字节，相当于把索引4-8的字节以float的形式读出来） bytebuf同样存在一个计数器，每次操作都会使计数器
ByteBuff常用方法，使用
热门推荐
一点光辉的博客
07-04 1万+
ByteBuff常用方法，使用
Netty源码深度解析-ByteBuf（1） ByteBuf简介
王建新的博客
02-23 874
ByteBuf主要api有read/write，get/set，slice，duplicate，copy等系列方法。实现类上主要分为Unpooled和Pooled，并且支持分配HeapByteBuf及DirectByteBuf。
Netty常用API
03-27
### Netty 常用 API 列表及其使用方法 #### 1. **Channel** `Channel` 是 Netty 中的一个核心接口，表示一个网络连接。通过 `Channel` 可以读取和写入数据[^1]。 - **主要功能**: 提供对底层 I/O 操作的抽象。 - **常见实现类**: - `SocketChannel`: 表示 TCP 客户端连接。 - `ServerSocketChannel`: 表示 TCP 服务端监听器。 ```java // 获取 Channel 配置选项 channel.config().setOption(ChannelOption.SO_BACKLOG, 128); ``` --- #### 2. **ChannelHandler** `ChannelHandler` 是用于处理各种事件（如读、写、异常等）的组件。它是 Netty 处理业务逻辑的主要入口[^2]。 - **分类**: - `ChannelInboundHandler`: 负责处理入站事件。 - `ChannelOutboundHandler`: 负责处理出站事件。 - **常用子类**: - `SimpleChannelInboundHandler<T>`: 自动释放资源并简化了消息接收流程。 - `ChannelInitializer<Channel>`: 初始化管道时添加其他处理器。 ```java public class MyHandler extends SimpleChannelInboundHandler<String> { @Override protected void channelRead0(ChannelHandlerContext ctx, String msg) throws Exception { System.out.println("Received message: " + msg); } } ``` --- #### 3. **ChannelPipeline** `ChannelPipeline` 是一组按顺序排列的 `ChannelHandler` 实例集合。它负责管理这些处理器之间的交互[^4]。 - **作用**: 将不同的操作分配给特定的 `ChannelHandler` 来完成。 - **常用方法**: - `addLast(ChannelHandler handler)`：向管道末尾添加一个新的处理器。 - `remove(ChannelHandler handler)`：移除指定的处理器。 ```java pipeline.addLast(new LoggingHandler()); pipeline.addLast(new MyHandler()); ``` --- #### 4. **ChannelHandlerContext** `ChannelHandlerContext` 表示某个 `ChannelHandler` 在 `ChannelPipeline` 中的状态和上下文信息。 - **用途**: 提供访问当前 `ChannelHandler` 所属的 `Channel` 和 `ChannelPipeline` 的能力。 - **常用方法**: - `write(Object msg)`：将消息发送到下游。 - `fireChannelRead(Object msg)`：触发上游的读事件。 ```java ctx.writeAndFlush(msg); // 向下一个处理器传递消息 ``` --- #### 5. **EventLoopGroup** `EventLoopGroup` 是一组线程池，专门用来执行 I/O 操作的任务调度。 - **典型实现**: - `NioEventLoopGroup`: 基于 NIO 的多路复用机制。 - **配置实例**: ```java EventLoopGroup bossGroup = new NioEventLoopGroup(); // 接受新连接 EventLoopGroup workerGroup = new NioEventLoopGroup(); // 处理已建立的连接 try { ServerBootstrap b = new ServerBootstrap(); b.group(bossGroup, workerGroup).channel(NioServerSocketChannel.class) .childHandler(new MyInitializer()); } finally { bossGroup.shutdownGracefully(); workerGroup.shutdownGracefully(); } ``` --- #### 6. **ServerBootstrap / Bootstrap** 这两个类分别用于启动服务器和服务端/客户端程序。 - **区别**: - `ServerBootstrap`: 专为服务器设计。 - `Bootstrap`: 主要针对客户端场景。 - **初始化代码片段**: ```java ServerBootstrap bootstrap = new ServerBootstrap(); bootstrap.group(group) .channel(NioServerSocketChannel.class) .childHandler(new InitializerClass()); ``` --- #### 7. **Unpooled 类** 当不需要频繁创建缓冲区时，可以直接使用静态工具类 `Unpooled` 创建 ByteBuf 对象。 ```java ByteBuf buffer = Unpooled.buffer(1024); // 分配大小为 1024 字节的缓冲区 buffer.writeBytes("Hello".getBytes()); // 写入字节数组 ``` --- #### 8. **ChannelFuture** `ChannelFuture` 表示异步操作的结果。由于 Netty 是全异步框架，因此所有的 I/O 操作都会返回一个 Future 对象[^3]。 - **特点**: 支持回调函数注册。 - **示例**: ```java ChannelFuture future = channel.closeFuture(); // 注册关闭事件 future.addListener(f -> { if (f.isSuccess()) { System.out.println("Connection closed successfully."); } else { f.cause().printStackTrace(); } }); ``` --- #### 总结 上述列举的是 Netty 中最常使用的几个核心 API。它们共同构成了 Netty 的基础架构，开发者可以通过组合这些模块快速构建高性能的网络应用。 ---
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值