Netty入门

Netty 是一个异步的、基于事件驱动的网络应用框架,用于快速开发可维护、高性能的网络服务器和客户端

Netty 的地位

Netty 在 Java 网络应用框架中的地位就好比:Spring 框架在 JavaEE 开发中的地位

以下的框架都使用了 Netty,因为它们有网络通信需求!

  • Cassandra - nosql 数据库
  • Spark - 大数据分布式计算框架
  • Hadoop - 大数据分布式存储框架
  • RocketMQ - ali 开源的消息队列
  • ElasticSearch - 搜索引擎
  • gRPC - rpc 框架
  • Dubbo - rpc 框架
  • Spring 5.x - flux api 完全抛弃了 tomcat ,使用 netty 作为服务器端
  • Zookeeper - 分布式协调框架

Netty 的优势

  • Netty vs NIO,

    • NIO 工作量大,bug 多
    • 需要自己构建协议
    • 解决 TCP 传输问题,如粘包、半包
    • epoll 空轮询导致 CPU 100%
    • 对 API 进行增强,使之更易用,如 FastThreadLocal => ThreadLocal,ByteBuf => ByteBuffer
  • Netty vs 其它网络应用框架

    • Mina 由 apache 维护,将来 3.x 版本可能会有较大重构,破坏 API 向下兼容性,Netty 的开发迭代更迅速,API 更简洁、文档更优秀
    • 久经考验,16年,Netty 版本
      • 2.x 2004
      • 3.x 2008
      • 4.x 2013
      • 5.x 已废弃(没有明显的性能提升,维护成本高)

Hello World

目标

开发一个简单的服务器端和客户端

  • 客户端向服务器端发送 hello, world
  • 服务器仅接收,不返回

加入依赖

1
2
3
4
5
<dependency>
<groupId>io.netty</groupId>
<artifactId>netty-all</artifactId>
<version>4.1.39.Final</version>
</dependency>

服务器端

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
public class HelloServer {
public static void main(String[] args) {
// 1. 启动器,负责组装 netty 组件,启动服务器
new ServerBootstrap()
// 2. ParentEventLoop、ChildEventLoop(Selector,Thread) 相当于 多线程,Parent处理连接事件,Child处理读写事件
.group(new NioEventLoopGroup())
// 3. 选择服务器通道 ServerSocketChannel 的实现
.channel(NioServerSocketChannel.class)
// 4. Child 处理器,负责处理对应事件
.childHandler(new ChannelInitializer<NioSocketChannel>() {
// 5. 初始化 channel
@Override
protected void initChannel(NioSocketChannel channel) throws Exception {
// 6. 添加具体的处理器
channel.pipeline().addLast(new StringDecoder()); // 字符串解码器
channel.pipeline().addLast(new ChannelInboundHandlerAdapter(){ // 自定义 handler 处理上一个处理器处理后的结果
// 处理通道读事件
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
super.channelRead(ctx, msg);
System.out.println(msg); // 打印传输内容
}
});
}
})
// 7.设置监听端口
.bind(8080);
}
}

客户端

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
public class HelloClient {
public static void main(String[] args) throws InterruptedException {
// 1. 启动类
new Bootstrap()
// 2. 添加 EventLoop
.group(new NioEventLoopGroup())
// 3. 选择客户端 channel 实现
.channel(NioSocketChannel.class)
// 4. 添加处理器
.handler(new ChannelInitializer<NioSocketChannel>() {
// 连接建立后初始化
@Override
protected void initChannel(NioSocketChannel channel) throws Exception {
channel.pipeline().addLast(new StringEncoder());
}
})
// 5. 设置连接地址端口
.connect(new InetSocketAddress("localhost",8080))
.sync() // 阻塞方法,直到连接建立
.channel() // 代表连接对象
// 6. 向服务器发送数据
.writeAndFlush("hello,world"); // 写入数据并清空缓冲区
}
}

流程梳理

Netty大致流程梳理

💡 提示

  • 把 channel 理解为数据的通道
  • 把 msg 理解为流动的数据,最开始输入是 ByteBuf,但经过 pipeline(管道,类似于流水线) 的加工,会变成其它类型对象,最后输出又变成 ByteBuf
  • 把 handler 理解为数据的处理工序

    • 工序有多道,合在一起就是 pipeline,pipeline 负责发布事件(读、读取完成…)传播给每个 handler, handler 对自己感兴趣的事件进行处理(重写了相应事件处理方法)
    • handler 分 Inbound 入站和 Outbound 出站两类
  • 把 eventLoop 理解为处理数据的工人

    • 工人可以管理多个 channel 的 io 操作,并且一旦工人负责了某个 channel,就要负责到底(绑定),避免多工人负责同一个channel时数据的不一致
    • 工人既可以执行 io 操作,也可以进行任务处理,每位工人有任务队列,队列里可以堆放多个 channel 的待处理任务,任务分为普通任务、定时任务
    • 工人按照 pipeline 顺序,依次按照 handler 的规划(代码)处理数据,可以为每道工序指定不同的工人

组件

EventLoop

事件循环对象

EventLoop 本质是一个单线程执行器(同时维护了一个 Selector),里面有 run 方法处理 Channel 上源源不断的 io 事件。

它的继承关系比较复杂

  • 一条线是继承自 j.u.c.ScheduledExecutorService 因此包含了线程池中所有的方法
  • 另一条线是继承自 netty 自己的 OrderedEventExecutor,

    • 提供了 boolean inEventLoop(Thread thread) 方法判断一个线程是否属于此 EventLoop
    • 提供了 parent 方法来看看自己属于哪个 EventLoopGroup

事件循环组

EventLoopGroup 是一组 EventLoop,Channel 一般会调用 EventLoopGroup 的 register 方法来绑定其中一个 EventLoop,后续这个 Channel 上的 io 事件都由此 EventLoop 来处理(保证了 io 事件处理时的线程安全)

  • 继承自 netty 自己的 EventExecutorGroup

    • 实现了 Iterable 接口提供遍历 EventLoop 的能力
    • 另有 next 方法获取集合中下一个 EventLoop

以一个简单的实现为例:

1
2
3
4
5
// 内部创建了两个 EventLoop, 每个 EventLoop 维护一个线程
DefaultEventLoopGroup group = new DefaultEventLoopGroup(2);
System.out.println(group.next());
System.out.println(group.next());
System.out.println(group.next());

输出

1
2
3
io.netty.channel.DefaultEventLoop@60f82f98
io.netty.channel.DefaultEventLoop@35f983a6
io.netty.channel.DefaultEventLoop@60f82f98

也可以使用 for 循环

1
2
3
4
DefaultEventLoopGroup group = new DefaultEventLoopGroup(2);
for (EventExecutor eventLoop : group) {
System.out.println(eventLoop);
}

输出

1
2
io.netty.channel.DefaultEventLoop@60f82f98
io.netty.channel.DefaultEventLoop@35f983a6

💡 优雅关闭

优雅关闭 shutdownGracefully 方法。该方法会首先切换 EventLoopGroup 到关闭状态从而拒绝新的任务的加入,然后在任务队列的任务都处理完成后,停止线程的运行。从而确保整体应用是在正常有序的状态下退出的。

处理 io 事件

服务端

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
public class EventLoopServer {

private static final Logger log = LoggerFactory.getLogger(EventLoopServer.class);

public static void main(String[] args) throws InterruptedException {
new ServerBootstrap()
// 参数1:boss 只负责 ServerSocketChannel 的 accept 事件,不需要指定线程数,因为只有一个服务端与之进行绑定
// 参数2:worker 只负责 SocketChannel 的 读写事件
.group(new NioEventLoopGroup(),new NioEventLoopGroup(2))
.channel(NioServerSocketChannel.class)
.childHandler(new ChannelInitializer<NioSocketChannel>() {
@Override
protected void initChannel(NioSocketChannel channel) throws Exception {
channel.pipeline().addLast(new ChannelInboundHandlerAdapter(){
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
ByteBuf byteBuf = (ByteBuf) msg;
log.debug(byteBuf.toString(StandardCharsets.UTF_8));
}
});
}
})
.bind(8080)
.sync();
}
}

客户端

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
public class EventLoopClient {
public static void main(String[] args) throws InterruptedException {
// 1. 启动类
Channel channel = new Bootstrap()
// 2. 添加 EventLoop
.group(new NioEventLoopGroup())
// 3. 选择客户端 channel 实现
.channel(NioSocketChannel.class)
// 4. 添加处理器
.handler(new ChannelInitializer<NioSocketChannel>() {
// 连接建立后初始化
@Override
protected void initChannel(NioSocketChannel channel) throws Exception {
channel.pipeline().addLast(new StringEncoder());
}
})
// 5. 设置连接地址端口
.connect(new InetSocketAddress("localhost", 8080))
.sync() // 阻塞方法,直到连接建立
.channel();// 代表连接对象

System.out.println(channel);
System.out.println();
}
}

输出

处理IO事件

两个 worker 轮流处理 SocketChannel,但 worker 与 SockerChannel 之间进行了绑定

eventloop1

分工细化

服务端

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
public class EventLoopServer {

private static final Logger log = LoggerFactory.getLogger(EventLoopServer.class);

public static void main(String[] args) throws InterruptedException {

// 创建一个独立的 EventLoopGroup ,用于处理一些耗时的任务,避免耗时过长,阻塞 io 线程,导致业务停滞
DefaultEventLoopGroup group = new DefaultEventLoopGroup();

new ServerBootstrap()
// 参数1:boss 只负责 ServerSocketChannel 的 accept 事件,不需要指定线程数,因为只有一个服务端与之进行绑定
// 参数2:worker 只负责 SocketChannel 的 读写事件
.group(new NioEventLoopGroup(),new NioEventLoopGroup(2))
.channel(NioServerSocketChannel.class)
.childHandler(new ChannelInitializer<NioSocketChannel>() {
@Override
protected void initChannel(NioSocketChannel channel) throws Exception {
channel.pipeline().addLast("nio handler",new ChannelInboundHandlerAdapter(){
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
ByteBuf byteBuf = (ByteBuf) msg;
log.debug(byteBuf.toString(StandardCharsets.UTF_8));
ctx.fireChannelRead(msg); // 将消息传递给下一个 handler
}
}).addLast(group,"default handler",new ChannelInboundHandlerAdapter() {
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
ByteBuf byteBuf = (ByteBuf) msg;
log.debug(byteBuf.toString(StandardCharsets.UTF_8));
}
});
}
})
.bind(8080)
.sync();
}
}

客户端代码不变

输出

分工细化

nio worker 和 非 nio worker 也分别绑定了 channel(nio handler 由 nio worker 执行,而default handler 由 非 nio worker 执行)

eventloop2

💡 handler 执行中如何换人?

关键代码 io.netty.channel.AbstractChannelHandlerContext#invokeChannelRead()

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
static void invokeChannelRead(final AbstractChannelHandlerContext next, Object msg) {
final Object m = next.pipeline.touch(ObjectUtil.checkNotNull(msg, "msg"), next);
// 下一个 handler 的事件循环是否与当前的事件循环是同一个线程
EventExecutor executor = next.executor();

// 是,直接调用
if (executor.inEventLoop()) {
next.invokeChannelRead(m);
}
// 不是,将要执行的代码作为任务提交给下一个事件循环处理(换人)
else {
executor.execute(new Runnable() {
@Override
public void run() {
next.invokeChannelRead(m);
}
});
}
}
  • 如果两个 handler 绑定的是同一个线程,那么就直接调用
  • 否则,把要调用的代码封装为一个任务对象,由下一个 handler 的线程来调用

处理任务

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
public class TestEventLoop {

private static final Logger log = LoggerFactory.getLogger(TestEventLoop.class);

public static void main(String[] args) {
// 1. 创建事件循环组
NioEventLoopGroup eventLoopGroup = new NioEventLoopGroup(); // io 事件、普通任务、定时任务
// 默认线程数 = 核心数 * 2
// DefaultEventLoopGroup defaultEventLoopGroup = new DefaultEventLoopGroup(); // 普通任务、定时任务
// 2. 获取下一个事件循环对象
System.out.println(eventLoopGroup.next());
System.out.println(eventLoopGroup.next());
System.out.println(eventLoopGroup.next());

// 3. 执行普通任务,用于实现异步任务
eventLoopGroup.next().execute(() -> {
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
log.debug("execute ok");
});

// 4. 执行定时任务,用于实现心跳检测
eventLoopGroup.next().scheduleAtFixedRate(() -> {
log.debug("ok");
},0,1, TimeUnit.SECONDS);

// 参数1: Runnable 任务对象
// 参数2 l = 0 : 初始延迟时间, 0 表示立刻执行
// 参数3 l1 = 1 : 间隔时间
// 参数4 时间单位
// 立刻开始 每间隔 1s 执行一次 debug 输出 ok 的操作

log.debug("main thread..");
}
}

输出

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
io.netty.channel.nio.NioEventLoop@58a90037
io.netty.channel.nio.NioEventLoop@74294adb
io.netty.channel.nio.NioEventLoop@70a9f84e
23:43:37 [DEBUG] [main] c.n.d.n.TestEventLoop - main thread..
23:43:37 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestEventLoop - ok
23:43:38 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestEventLoop - ok
23:43:38 [DEBUG] [nioEventLoopGroup-2-1] c.n.d.n.TestEventLoop - execute ok
23:43:39 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestEventLoop - ok
23:43:40 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestEventLoop - ok
23:43:41 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestEventLoop - ok
23:43:42 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestEventLoop - ok
23:43:43 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestEventLoop - ok
23:43:44 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestEventLoop - ok
23:43:45 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestEventLoop - ok
23:43:46 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestEventLoop - ok
23:43:47 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestEventLoop - ok
23:43:48 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestEventLoop - ok
23:43:49 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestEventLoop - ok
23:43:50 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestEventLoop - ok

Channel

channel 的主要作用

  • close() 可以用来关闭 channel
  • closeFuture() 用来处理 channel 的关闭

    • sync 方法作用是同步等待 channel 关闭
    • 而 addListener 方法是异步等待 channel 关闭
  • pipeline() 方法添加处理器

  • write() 方法将数据写入
  • writeAndFlush() 方法将数据写入并刷出

ChannelFuture

将之前的客户端代码拆开

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
public class EventLoopClient {
public static void main(String[] args) throws InterruptedException {
// 1. 启动类
ChannelFuture channelFuture = new Bootstrap()
// 2. 添加 EventLoop
.group(new NioEventLoopGroup())
// 3. 选择客户端 channel 实现
.channel(NioSocketChannel.class)
// 4. 添加处理器
.handler(new ChannelInitializer<NioSocketChannel>() {
// 连接建立后初始化
@Override
protected void initChannel(NioSocketChannel channel) throws Exception {
channel.pipeline().addLast(new StringEncoder());
}
})
// 5. 连接服务器地址端口
// 异步非阻塞,main 线程发起调用,真正执行 connect 的是 nio 线程
.connect(new InetSocketAddress("localhost", 8080)); // 1s 后才建立好连接

channelFuture.sync(); // 阻塞方法,直到连接建立
// 无阻塞向下执行获取 channel ,拿到的是 没有建立好连接的 channel ,无法进行读写操作
Channel channel = channelFuture.channel();// 代表连接对象

channel.writeAndFlush("hello,world");
}
}

注意:connect 方法是异步的,意味着不等连接建立,方法执行就返回了。因此 channelFuture 对象中不能【立刻】获得到正确的 Channel 对象

不阻塞时,只有 channel 对象

ChannelFuture1

阻塞时,得到 channel 对象以及连接后客户端和服务端的地址端口

ChannelFuture2

两种处理方式

使用 sync 方法同步处理结果,main 线程阻塞等待处理结果

1
2
3
4
5
6
7
// 5.1 使用 sync 方法同步处理结果,main 线程阻塞等待处理结果
channelFuture.sync(); // 阻塞方法,直到连接建立

// 无阻塞向下执行获取 channel ,拿到的是 没有建立好连接的 channel ,无法进行读写操作
Channel channel = channelFuture.channel();// 代表连接对象
log.debug("{}",channel);
channel.writeAndFlush("hello,world");

ChannelFuture&sync

使用 addListener(回调对象) 异步处理结果,不再是 main 线程处理

1
2
3
4
5
6
7
8
9
// 5.2 使用 addListener(回调对象) 异步处理结果,不再是 main 线程处理
channelFuture.addListener(new ChannelFutureListener() {
@Override
public void operationComplete(ChannelFuture channelFuture) throws Exception {
Channel channel = channelFuture.channel();
log.debug("{}",channel);
channel.writeAndFlush("hello,world");
}
});

ChannelFuture&addListener

CloseFuture

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
public class CloseFutureClient {

private static final Logger log = LoggerFactory.getLogger(CloseFutureClient.class);

public static void main(String[] args) throws InterruptedException {
ChannelFuture channelFuture = new Bootstrap()
.group(new NioEventLoopGroup())
.channel(NioSocketChannel.class)
.handler(new ChannelInitializer<NioSocketChannel>() {
@Override
protected void initChannel(NioSocketChannel channel) throws Exception {
channel.pipeline().addLast(new LoggingHandler(LogLevel.DEBUG));
channel.pipeline().addLast(new StringEncoder());
}
})
.connect(new InetSocketAddress("localhost", 8080));

Channel channel = channelFuture.sync().channel();

new Thread(()->{
Scanner sc = new Scanner(System.in);
while (true) {
String s = sc.nextLine();

if ("q".equals(s)) {
channel.close(); // close 异步操作,交给其他线程处理,可能存在延迟关闭
// log.debug("处理关闭之后的操作"); // 由于不是阻塞方法,当前一条语句执行完之后,立刻打印日志,所以不能在这里处理关闭后的操作
break;
}

channel.writeAndFlush(s);
}
},"input").start();

// 获取 CloseFuture 对象
ChannelFuture closeFuture = channel.closeFuture();
log.debug("waiting close ...");
// 1. 同步处理关闭
// closeFuture.sync();
// log.debug("处理关闭之后的操作");
// eventLoopGroup.shutdownGracefully();

// 2. 异步处理关闭
closeFuture.addListener(new ChannelFutureListener() {
@Override
public void operationComplete(ChannelFuture channelFuture) throws Exception {
log.debug("处理关闭之后的操作");
eventLoopGroup.shutdownGracefully(); // 拒绝之后的所有请求,等待正在执行的请求完成之后关闭线程
}
});
}
}

使用 sync 方法同步处理关闭,main 线程阻塞等待关闭处理

CloseFuture&sync

使用 addListener(回调对象) 异步处理关闭,不再是 main 线程处理

CloseFuture&addListener

💡 异步提升的是什么

  • 单线程没法异步提高效率,必须配合多线程、多核 cpu 才能发挥异步的优势
  • 但由于线程上下文切换成本变高,异步并没有缩短响应时间,反而有所增加,有所提高的是 单位时间内能够处理请求的数量 即吞吐量。
  • 合理进行任务拆分,也是利用异步的关键

  • 异步 future 使用主要是将任务进行划子任务,子任务间可以进行并行操作,提高效率。

  • 将任务划分为子任务进行处理 和 每个任务使用一个线程相比,前者并发与任务数无关只与子任务划分数相关。

Future & Promise

在异步处理时,经常用到这两个接口

首先要说明 netty 中的 Future 与 jdk 中的 Future 同名,但是是两个接口,netty 的 Future 继承自 jdk 的 Future,而 Promise 又对 netty Future 进行了扩展

  • jdk Future 只能同步等待任务结束(或成功、或失败)才能得到结果
  • netty Future 可以同步等待任务结束得到结果,也可以异步方式得到结果,但都是要等任务结束
  • netty Promise 不仅有 netty Future 的功能,而且脱离了任务独立存在,只作为两个线程间传递结果的容器
功能/名称 JDK Future Netty Future Netty Promise
cancel 取消任务 - -
isCanceled 任务是否取消 - -
isDone 任务是否完成,不能区分成功失败 - -
get 获取任务结果,阻塞等待 - -
getNow - 获取任务结果,非阻塞,还未产生结果时返回 null -
await - 等待任务结束,如果任务失败,不会抛异常,而是通过 isSuccess 判断 -
sync - 等待任务结束,如果任务失败,抛出异常 -
isSuccess - 判断任务是否成功 -
cause - 获取失败信息,非阻塞,如果没有失败,返回null -
addListener - 添加回调,异步接收结果 -
setSuccess - - 设置成功结果
setFailure - - 设置失败结果

JDK Future

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
public class TestJdkFuture {

private static final Logger log = LoggerFactory.getLogger(TestJdkFuture.class);

public static void main(String[] args) throws ExecutionException, InterruptedException {
// 1. 创建线程池
ExecutorService service = Executors.newFixedThreadPool(2);
// 2. 提交任务
Future<Integer> future = service.submit(new Callable<Integer>() {
@Override
public Integer call() throws Exception {
log.debug("执行任务...");
Thread.sleep(1000);
return 50;
}
});

log.debug("等待结果...");
// 3. main 线程通过 future.get() 同步方法,阻塞等待,获取结果
log.debug("结果为{}",future.get());
}
}

输出

1
2
3
22:15:19 [DEBUG] [main] c.n.d.n.TestJdkFuture - 等待结果...
22:15:19 [DEBUG] [pool-1-thread-1] c.n.d.n.TestJdkFuture - 执行任务...
22:15:20 [DEBUG] [main] c.n.d.n.TestJdkFuture - 结果为50

Netty Future

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
public class TestNettyFuture {

private static final Logger log = LoggerFactory.getLogger(TestNettyFuture.class);

public static void main(String[] args) throws ExecutionException, InterruptedException {
NioEventLoopGroup group = new NioEventLoopGroup();

EventLoop eventLoop = group.next();

Future<Integer> future = eventLoop.submit(new Callable<Integer>() {
@Override
public Integer call() throws Exception {
log.debug("执行任务...");
Thread.sleep(1000);
return 50;
}
});

log.debug("等待结果...");
// 3. main 线程通过 future.get() 同步方法,阻塞等待,获取结果
log.debug("结果为{}",future.get());

// 4. main 线程通过 future.addListener 回调对象,让执行线程处理结果
future.addListener(new GenericFutureListener<Future<? super Integer>>() {
@Override
public void operationComplete(Future<? super Integer> future) throws Exception {
log.debug("接收结果:{}",future.getNow());
}
});
}
}

输出

1
2
3
4
22:17:48 [DEBUG] [main] c.n.d.n.TestNettyFuture - 等待结果...
22:17:48 [DEBUG] [nioEventLoopGroup-2-1] c.n.d.n.TestNettyFuture - 执行任务...
22:17:49 [DEBUG] [main] c.n.d.n.TestNettyFuture - 结果为50
22:17:49 [DEBUG] [nioEventLoopGroup-2-1] c.n.d.n.TestNettyFuture - 接收结果:50

Netty Promise

同步处理任务成功
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
public class TestNettyPromise {

private static final Logger log = LoggerFactory.getLogger(TestNettyPromise.class);

public static void main(String[] args) throws ExecutionException, InterruptedException {
// 1. 创建 EventLoop
EventLoop eventLoop = new NioEventLoopGroup().next();
// 2. 主动创建 promise,结果的容器,相当于线程之间传输数据的通道?一种通信方式?
DefaultPromise<Integer> promise = new DefaultPromise<>(eventLoop);

new Thread(()->{
// 3. 任意一个线程执行完成后向 promise 填充结果
log.debug("执行任务...");
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
promise.setSuccess(50);
}).start();

log.debug("等待结果...");

log.debug("结果为{}",promise.getNow()); // 此时线程还未执行完成,结果为null

// 4. main 线程使用 promise.get() 同步接收结果
log.debug("结果为{}",promise.get());
}
}

输出

1
2
3
4
22:32:52 [DEBUG] [main] c.n.d.n.TestNettyPromise - 等待结果...
22:32:52 [DEBUG] [Thread-0] c.n.d.n.TestNettyPromise - 执行任务...
22:32:52 [DEBUG] [main] c.n.d.n.TestNettyPromise - 结果为null
22:32:53 [DEBUG] [main] c.n.d.n.TestNettyPromise - 结果为50
异步处理任务成功
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
public class TestNettyPromise {

private static final Logger log = LoggerFactory.getLogger(TestNettyPromise.class);

public static void main(String[] args) throws ExecutionException, InterruptedException {
// 1. 创建 EventLoop
EventLoop eventLoop = new NioEventLoopGroup().next();
// 2. 主动创建 promise,结果的容器,相当于线程之间传输数据的通道?一种通信方式?
DefaultPromise<Integer> promise = new DefaultPromise<>(eventLoop);

new Thread(()->{
// 3. 任意一个线程执行完成后向 promise 填充结果
log.debug("执行任务...");
try {
Thread.sleep(1000);
} catch (InterruptedException e) {
e.printStackTrace();
}
promise.setSuccess(50);
}).start();

log.debug("等待结果...");

// 4. main 线程通过 promise.addListener 回调对象,让执行线程处理结果
promise.addListener(new GenericFutureListener<Future<? super Integer>>() {
@Override
public void operationComplete(Future<? super Integer> future) throws Exception {
// 这里的 future 就是上面的 promise
log.debug("接收结果:{}",future.getNow());
}
});
}
}

输出

1
2
3
22:37:15 [DEBUG] [main] c.n.d.n.TestNettyPromise - 等待结果...
22:37:15 [DEBUG] [Thread-0] c.n.d.n.TestNettyPromise - 执行任务...
22:37:16 [DEBUG] [nioEventLoopGroup-2-1] c.n.d.n.TestNettyPromise - 接收结果:50
同步处理任务失败 - sync & get
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
public class TestNettyPromise {

private static final Logger log = LoggerFactory.getLogger(TestNettyPromise.class);

public static void main(String[] args) throws ExecutionException, InterruptedException {
// 1. 创建 EventLoop
EventLoop eventLoop = new NioEventLoopGroup().next();
// 2. 主动创建 promise,结果的容器,相当于线程之间传输数据的通道?一种通信方式?
DefaultPromise<Integer> promise = new DefaultPromise<>(eventLoop);

new Thread(()->{
// 3. 任意一个线程执行完成后向 promise 填充结果
log.debug("执行任务...");
try {
int i = 1/0;
Thread.sleep(1000);
promise.setSuccess(50);
} catch (Exception e) {
e.printStackTrace();
promise.setFailure(e);
}
}).start();

log.debug("等待结果...");

log.debug("结果为{}",promise.getNow()); // 此时线程还未执行完成,结果为null

// 4. main 线程使用 promise.get() 同步接收结果
log.debug("结果为{}",promise.get()); // sync() 也会出现异常,只是 get 会再用 ExecutionException 包一层异常
}
}

输出

1
2
3
4
5
6
7
8
9
10
11
12
22:41:23 [DEBUG] [Thread-0] c.n.d.n.TestNettyPromise - 执行任务...
22:41:23 [DEBUG] [main] c.n.d.n.TestNettyPromise - 等待结果...
22:41:23 [DEBUG] [main] c.n.d.n.TestNettyPromise - 结果为null
java.lang.ArithmeticException: / by zero
at com.netty.demo03.netty02.TestNettyPromise.lambda$main$0(TestNettyPromise.java:30)
at java.base/java.lang.Thread.run(Thread.java:833)
Exception in thread "main" java.util.concurrent.ExecutionException: java.lang.ArithmeticException: / by zero
at io.netty.util.concurrent.AbstractFuture.get(AbstractFuture.java:41)
at com.netty.demo03.netty02.TestNettyPromise.main(TestNettyPromise.java:44)
Caused by: java.lang.ArithmeticException: / by zero
at com.netty.demo03.netty02.TestNettyPromise.lambda$main$0(TestNettyPromise.java:30)
at java.base/java.lang.Thread.run(Thread.java:833)

首先在 创建的线程 Thread 中发现了异常,然后又通过 promise.getNow() 传播到了 main 线程,于是先打印了主线程的异常,再向下打印了 Thread 的异常。

同步处理任务失败 - await
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
public class TestNettyPromise {

private static final Logger log = LoggerFactory.getLogger(TestNettyPromise.class);

public static void main(String[] args) throws ExecutionException, InterruptedException {
// 1. 创建 EventLoop
EventLoop eventLoop = new NioEventLoopGroup().next();
// 2. 主动创建 promise,结果的容器,相当于线程之间传输数据的通道?一种通信方式?
DefaultPromise<Integer> promise = new DefaultPromise<>(eventLoop);

new Thread(()->{
// 3. 任意一个线程执行完成后向 promise 填充结果
log.debug("执行任务...");
try {
int i = 1/0;
Thread.sleep(1000);
promise.setSuccess(50);
} catch (Exception e) {
e.printStackTrace();
promise.setFailure(e);
}
}).start();

log.debug("等待结果...");

log.debug("结果为{}",promise.getNow()); // 此时线程还未执行完成,结果为null

promise.await(); // 与 sync 和 get 区别在于,不会抛异常

// 4. 判断 promise 任务是否成功,如果是就返回结果,否则返回错误信息
log.debug("result {}", (promise.isSuccess() ? promise.getNow() : promise.cause()).toString());
}
}

输出

1
2
3
4
5
6
7
22:51:07 [DEBUG] [Thread-0] c.n.d.n.TestNettyPromise - 执行任务...
22:51:07 [DEBUG] [main] c.n.d.n.TestNettyPromise - 等待结果...
22:51:07 [DEBUG] [main] c.n.d.n.TestNettyPromise - 结果为null
22:51:07 [DEBUG] [main] c.n.d.n.TestNettyPromise - result java.lang.ArithmeticException: / by zero
java.lang.ArithmeticException: / by zero
at com.netty.demo03.netty02.TestNettyPromise.lambda$main$0(TestNettyPromise.java:30)
at java.base/java.lang.Thread.run(Thread.java:833)
异步处理任务失败
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
public class TestNettyPromise {

private static final Logger log = LoggerFactory.getLogger(TestNettyPromise.class);

public static void main(String[] args) throws ExecutionException, InterruptedException {
// 1. 创建 EventLoop
EventLoop eventLoop = new NioEventLoopGroup().next();
// 2. 主动创建 promise,结果的容器,相当于线程之间传输数据的通道?一种通信方式?
DefaultPromise<Integer> promise = new DefaultPromise<>(eventLoop);

new Thread(()->{
// 3. 任意一个线程执行完成后向 promise 填充结果
log.debug("执行任务...");
try {
int i = 1/0;
Thread.sleep(1000);
promise.setSuccess(50);
} catch (Exception e) {
e.printStackTrace();
promise.setFailure(e);
}
}).start();

log.debug("等待结果...");

log.debug("结果为{}",promise.getNow()); // 此时线程还未执行完成,结果为null


// 4. 判断 promise 任务是否成功,如果是就返回结果,否则返回错误信息
promise.addListener(new GenericFutureListener<Future<? super Integer>>() {
@Override
public void operationComplete(Future<? super Integer> future) throws Exception {
log.debug("result {}", (promise.isSuccess() ? promise.getNow() : promise.cause()).toString());
}
});
}
}

输出

1
2
3
4
5
6
7
22:55:43 [DEBUG] [main] c.n.d.n.TestNettyPromise - 等待结果...
22:55:43 [DEBUG] [Thread-0] c.n.d.n.TestNettyPromise - 执行任务...
22:55:43 [DEBUG] [main] c.n.d.n.TestNettyPromise - 结果为null
22:55:43 [DEBUG] [nioEventLoopGroup-2-1] c.n.d.n.TestNettyPromise - result java.lang.ArithmeticException: / by zero
java.lang.ArithmeticException: / by zero
at com.netty.demo03.netty02.TestNettyPromise.lambda$main$0(TestNettyPromise.java:32)
at java.base/java.lang.Thread.run(Thread.java:833)
await 死锁检查
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
public class TestNettyPromise {

private static final Logger log = LoggerFactory.getLogger(TestNettyPromise.class);

public static void main(String[] args) throws ExecutionException, InterruptedException {
DefaultEventLoop eventExecutors = new DefaultEventLoop();
DefaultPromise<Integer> promise = new DefaultPromise<>(eventExecutors);

eventExecutors.submit(()->{
System.out.println("1");
try {
promise.await();
// 注意不能仅捕获 InterruptedException 异常
// 否则 死锁检查抛出的 BlockingOperationException 会继续向上传播
// 而提交的任务会被包装为 PromiseTask,它的 run 方法中会 catch 所有异常然后设置为 Promise 的失败结果而不会抛出
} catch (Exception e) {
e.printStackTrace();
}
System.out.println("2");
});
eventExecutors.submit(()->{
System.out.println("3");
try {
promise.await();
} catch (Exception e) {
e.printStackTrace();
}
System.out.println("4");
});
}
}

输出

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
1
2
3
4
io.netty.util.concurrent.BlockingOperationException: DefaultPromise@7ebd0226(incomplete)
at io.netty.util.concurrent.DefaultPromise.checkDeadLock(DefaultPromise.java:384)
at io.netty.util.concurrent.DefaultPromise.await(DefaultPromise.java:212)
at com.netty.demo03.netty02.TestNettyPromise.lambda$main$0(TestNettyPromise.java:30)
at io.netty.util.concurrent.PromiseTask$RunnableAdapter.call(PromiseTask.java:38)
at io.netty.util.concurrent.PromiseTask.run(PromiseTask.java:73)
at io.netty.channel.DefaultEventLoop.run(DefaultEventLoop.java:54)
at io.netty.util.concurrent.SingleThreadEventExecutor$5.run(SingleThreadEventExecutor.java:918)
at io.netty.util.internal.ThreadExecutorMap$2.run(ThreadExecutorMap.java:74)
at io.netty.util.concurrent.FastThreadLocalRunnable.run(FastThreadLocalRunnable.java:30)
at java.base/java.lang.Thread.run(Thread.java:833)
io.netty.util.concurrent.BlockingOperationException: DefaultPromise@7ebd0226(incomplete)
at io.netty.util.concurrent.DefaultPromise.checkDeadLock(DefaultPromise.java:384)
at io.netty.util.concurrent.DefaultPromise.await(DefaultPromise.java:212)
at com.netty.demo03.netty02.TestNettyPromise.lambda$main$1(TestNettyPromise.java:42)
at io.netty.util.concurrent.PromiseTask$RunnableAdapter.call(PromiseTask.java:38)
at io.netty.util.concurrent.PromiseTask.run(PromiseTask.java:73)
at io.netty.channel.DefaultEventLoop.run(DefaultEventLoop.java:54)
at io.netty.util.concurrent.SingleThreadEventExecutor$5.run(SingleThreadEventExecutor.java:918)
at io.netty.util.internal.ThreadExecutorMap$2.run(ThreadExecutorMap.java:74)
at io.netty.util.concurrent.FastThreadLocalRunnable.run(FastThreadLocalRunnable.java:30)
at java.base/java.lang.Thread.run(Thread.java:833)

Handler & Pipeline

ChannelHandler 用来处理 Channel 上的各种事件,分为入站、出站两种。所有 ChannelHandler 被连成一串,就是 Pipeline

  • 入站处理器通常是 ChannelInboundHandlerAdapter 的子类,主要用来读取客户端数据,写回结果
  • 出站处理器通常是 ChannelOutboundHandlerAdapter 的子类,主要对写回结果进行加工

打个比喻,每个 Channel 是一个产品的加工车间,Pipeline 是车间中的流水线,ChannelHandler 就是流水线上的各道工序,而后面要讲的 ByteBuf 是原材料,经过很多工序的加工:先经过一道道入站工序,再经过一道道出站工序最终变成产品

服务端

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
public class TestPipeline {

private static final Logger log = LoggerFactory.getLogger(TestPipeline.class);

public static void main(String[] args) {
new ServerBootstrap()
.group(new NioEventLoopGroup())
.channel(NioServerSocketChannel.class)
.childHandler(new ChannelInitializer<NioSocketChannel>() {
@Override
protected void initChannel(NioSocketChannel channel) throws Exception {
// 1. 通过 channel 拿到 pipeline
ChannelPipeline pipeline = channel.pipeline();
// 2. 添加处理器,自带head,tail处理器 head -> h1 -> h2 -> h3 -> h4 -> h5 -> h6 -> tail,双向链表
pipeline.addLast("h1",new ChannelInboundHandlerAdapter(){
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
log.debug("1");
ByteBuf byteBuf = (ByteBuf) msg;
String name = byteBuf.toString(StandardCharsets.UTF_8); // 获取 name
super.channelRead(ctx, name); // 1 传递给下一个 handler
}
});
pipeline.addLast("h2",new ChannelInboundHandlerAdapter(){
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
log.debug("2");
Student student = new Student(msg.toString()); // 构造 student
super.channelRead(ctx, student); // 2
}
});
pipeline.addLast("h4", new ChannelOutboundHandlerAdapter(){
@Override
public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
log.debug("4");
super.write(ctx, msg, promise); // 4
}
});
pipeline.addLast("h3",new ChannelInboundHandlerAdapter(){
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
log.debug("3");
log.debug("class: {} result: {}",msg.getClass(),msg);
// super.channelRead(ctx, msg); // 3
ctx.writeAndFlush(ctx.alloc().buffer().writeBytes("hello,world".getBytes())); // 从当前处理器向前触发
// channel.writeAndFlush(ctx.alloc().buffer().writeBytes("hello,world".getBytes())); // 跳到 tail 处理器向前触发
// 出站处理器需要写出才能执行
}
});
pipeline.addLast("h5", new ChannelOutboundHandlerAdapter(){
@Override
public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
log.debug("5");
super.write(ctx, msg, promise); // 5
}
});
pipeline.addLast("h6", new ChannelOutboundHandlerAdapter(){
@Override
public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
log.debug("6");
super.write(ctx, msg, promise); // 6
}
});
}
})
.bind(8080);
}

static class Student {
private String name;

public Student() {
}

public Student(String name) {
this.name = name;
}

public String getName() {
return name;
}

public void setName(String name) {
this.name = name;
}

@Override
public String toString() {
return "Student{" +
"name='" + name + '\'' +
'}';
}
}
}

ChannelHandlerContext ctx.writeAndFlush

1
2
3
4
5
17:06:40 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestPipeline - 1
17:06:40 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestPipeline - 2
17:06:40 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestPipeline - 3
17:06:40 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestPipeline - class: class com.netty.demo03.netty03.TestPipeline$Student result: Student{name='hello'}
17:06:40 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestPipeline - 4

NioSocketChannel channel.writeAndFlush

1
2
3
4
5
6
7
17:08:38 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestPipeline - 1
17:08:38 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestPipeline - 2
17:08:38 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestPipeline - 3
17:08:38 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestPipeline - class: class com.netty.demo03.netty03.TestPipeline$Student result: Student{name='hello'}
17:08:38 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestPipeline - 6
17:08:38 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestPipeline - 5
17:08:38 [DEBUG] [nioEventLoopGroup-2-2] c.n.d.n.TestPipeline - 4

可以看到,ChannelInboundHandlerAdapter 是按照 addLast 的顺序执行的,而 ChannelOutboundHandlerAdapter 是按照 addLast 的逆序执行的。ChannelPipeline 的实现是一个 ChannelHandlerContext(包装了 ChannelHandler) 组成的双向链表

Handler&Pipeline1

  • 入站处理器中,ctx.fireChannelRead(msg) 是 调用下一个入站处理器

    • 如果注释掉 1 处代码,则仅会打印 1
    • 如果注释掉 2 处代码,则仅会打印 1 2
  • 3 处的 channel.writeAndFlush() 会 从尾部开始触发 后续出站处理器的执行

    • 如果注释掉 3 处代码,则仅会打印 1 2 3
  • 类似的,出站处理器中,ctx.write(msg, promise) 的调用也会 触发上一个出站处理器

    • 如果注释掉 6 处代码,则仅会打印 1 2 3 6
  • channel.writeAndFlush() vs ctx.write(msg)

    • 都是触发出站处理器的执行
    • ctx.channel().write(msg) 从尾部开始查找出站处理器
    • ctx.write(msg) 是从当前节点找上一个出站处理器
    • 6 处的 ctx.write(msg, promise) 如果改为 ctx.channel().write(msg) 会打印 1 2 3 6 6 6… 因为 ctx.channel().write() 是从尾部开始查找,结果又是节点6 自己

服务端 pipeline 触发的原始流程,图中数字代表了处理步骤的先后次序

Handler&Pipeline

ByteBuf

是对字节数据的封装,NIO 中 ByteBuffer 的增强。

创建

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
public class TestByteBuf {

private static final Logger log = LoggerFactory.getLogger(TestByteBuf.class);

public static void main(String[] args) {

ByteBuf byteBuf = ByteBufAllocator.DEFAULT.buffer(); // 默认容量 256,动态扩容
log(byteBuf);
StringBuilder sb = new StringBuilder();

for (int i = 0; i < 32; i++) {
sb.append("a");
}

byteBuf.writeBytes(sb.toString().getBytes());

log(byteBuf);
}

private static void log(ByteBuf buffer) {
int length = buffer.readableBytes();
int rows = length / 16 + (length % 15 == 0 ? 0 : 1) + 4;
StringBuilder buf = new StringBuilder(rows * 80 * 2)
.append("read index:").append(buffer.readerIndex())
.append(" write index:").append(buffer.writerIndex())
.append(" capacity:").append(buffer.capacity())
.append(NEWLINE);
appendPrettyHexDump(buf, buffer);
log.debug("{}",buf);
}
}

上面代码创建了一个默认的 ByteBuf(池化基于直接内存的 ByteBuf),默认容量是 256

输出

1
2
3
4
5
6
7
8
9
19:27:20 [DEBUG] [main] c.n.d.N.TestByteBuf - read index:0 write index:0 capacity:256

19:27:20 [DEBUG] [main] c.n.d.N.TestByteBuf - read index:0 write index:32 capacity:256
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 61 61 61 61 61 61 61 61 61 61 61 61 61 61 61 61 |aaaaaaaaaaaaaaaa|
|00000010| 61 61 61 61 61 61 61 61 61 61 61 61 61 61 61 61 |aaaaaaaaaaaaaaaa|
+--------+-------------------------------------------------+----------------+

直接内存 vs 堆内存

可以使用下面的代码来创建池化基于 Java 堆的 ByteBuf

1
ByteBuf buffer = ByteBufAllocator.DEFAULT.heapBuffer(10);

也可以使用下面的代码来创建池化基于直接内存的 ByteBuf

1
ByteBuf buffer = ByteBufAllocator.DEFAULT.directBuffer(10);
  • 直接内存创建和销毁的代价昂贵,但读写性能高(少一次内存复制),适合配合池化功能一起用
  • 直接内存对 GC 压力小,因为这部分内存不受 JVM 垃圾回收的管理,但也要注意及时主动释放

池化 vs 非池化

池化的最大意义在于可以重用 ByteBuf,优点有

  • 没有池化,则每次都得创建新的 ByteBuf 实例,这个操作对直接内存代价昂贵,就算是堆内存,也会增加 GC 压力
  • 有了池化,则可以重用池中 ByteBuf 实例,并且采用了与 jemalloc 类似的内存分配算法提升分配效率
  • 高并发时,池化功能更节约内存,减少内存溢出的可能

池化功能是否开启,可以通过下面的系统环境变量来设置

1
-Dio.netty.allocator.type={unpooled|pooled}
  • 4.1 以后,非 Android 平台默认启用池化实现,Android 平台启用非池化实现
  • 4.1 之前,池化功能还不成熟,默认是非池化实现

组成

ByteBuf 由四部分组成

ByteBuf组成

最开始读写指针都在 0 位置

写入

方法列表,省略一些不重要的方法

方法签名 含义 备注
writeBoolean(boolean value) 写入 boolean 值 用一字节 01\ 00 代表 true\ false
writeByte(int value) 写入 byte 值
writeShort(int value) 写入 short 值
writeInt(int value) 写入 int 值 Big Endian,即 0x250,写入后 00 00 02 50
writeIntLE(int value) 写入 int 值 Little Endian,即 0x250,写入后 50 02 00 00
writeLong(long value) 写入 long 值
writeChar(int value) 写入 char 值
writeFloat(float value) 写入 float 值
writeDouble(double value) 写入 double 值
writeBytes(ByteBuf src) 写入 netty 的 ByteBuf
writeBytes(byte[] src) 写入 byte[]
writeBytes(ByteBuffer src) 写入 nio 的 ByteBuffer
int writeCharSequence(CharSequence sequence, Charset charset) 写入字符串

注意

  • 这些方法的未指明返回值的,其返回值都是 ByteBuf,意味着可以链式调用
  • 网络传输,默认习惯是 Big Endian 大端模式,数据的高字节位保存在内存的低地址中,而数据的低字节位保存在内存的高地址中

先写入 4 个字节

1
2
buffer.writeBytes(new byte[]{1, 2, 3, 4});
log(buffer);

结果是

1
2
3
4
5
6
read index:0 write index:4 capacity:10
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 01 02 03 04 |.... |
+--------+-------------------------------------------------+----------------+

再写入一个 int 整数,也是 4 个字节

1
2
buffer.writeInt(5);
log(buffer);

结果是

1
2
3
4
5
6
read index:0 write index:8 capacity:10
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 01 02 03 04 00 00 00 05 |........ |
+--------+-------------------------------------------------+----------------+

还有一类方法是 set 开头的一系列方法,通过索引也可以写入数据,但不会改变写指针位置

扩容

再写入一个 int 整数时,容量不够了(初始容量是 10),这时会引发扩容

1
2
buffer.writeInt(6);
log(buffer);

扩容规则是

  • 如果写入后数据大小未超过 512,则选择下一个 16 的整数倍,例如写入后大小为 12 ,则扩容后 capacity 是 16
  • 如果写入后数据大小超过 512,则选择下一个 2^n,例如写入后大小为 513,则扩容后 capacity 是 210=1024(29=512 已经不够了)
  • 扩容不能超过 max capacity 会报错

结果是

1
2
3
4
5
6
read index:0 write index:12 capacity:16
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 01 02 03 04 00 00 00 05 00 00 00 06 |............ |
+--------+-------------------------------------------------+----------------+

读取

例如读了 4 次,每次一个字节

1
2
3
4
5
System.out.println(buffer.readByte());
System.out.println(buffer.readByte());
System.out.println(buffer.readByte());
System.out.println(buffer.readByte());
log(buffer);

读过的内容,就属于废弃部分了,再读只能读那些尚未读取的部分

1
2
3
4
5
6
7
8
9
10
1
2
3
4
read index:4 write index:12 capacity:16
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 00 00 00 05 00 00 00 06 |........ |
+--------+-------------------------------------------------+----------------+

如果需要重复读取 int 整数 5,怎么办?

可以在 read 前先做个标记 mark

1
2
3
buffer.markReaderIndex();
System.out.println(buffer.readInt());
log(buffer);

结果

1
2
3
4
5
6
7
5
read index:8 write index:12 capacity:16
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 00 00 00 06 |.... |
+--------+-------------------------------------------------+----------------+

这时要重复读取的话,重置到标记位置 reset

1
2
buffer.resetReaderIndex();
log(buffer);

输出

1
2
3
4
5
6
read index:4 write index:12 capacity:16
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 00 00 00 05 00 00 00 06 |........ |
+--------+-------------------------------------------------+----------------+

还有种办法是采用 get 开头的一系列方法,通过索引读取数据,这些方法不会改变 read index 读指针位置

retain & release

由于 Netty 中有堆外内存的 ByteBuf 实现,堆外内存最好是手动来释放,而不是等 GC 垃圾回收。

  • UnpooledHeapByteBuf 使用的是 JVM 内存,只需等 GC 回收内存即可
  • UnpooledDirectByteBuf 使用的就是直接内存了,需要特殊的方法来回收内存
  • PooledByteBuf 和它的子类使用了池化机制,需要更复杂的规则来回收内存

回收内存的源码实现,请关注下面方法的不同实现

1
protected abstract void deallocate()

Netty 这里采用了引用计数法来控制回收内存,每个 ByteBuf 都实现了 ReferenceCounted 接口

  • 每个 ByteBuf 对象的初始计数为 1
  • 调用 release 方法计数减 1,如果计数为 0,ByteBuf 内存被回收
  • 调用 retain 方法计数加 1,表示调用者没用完之前,其它 handler 即使调用了 release 也不会造成回收
  • 当计数为 0 时,底层内存会被回收,这时即使 ByteBuf 对象还在,其各个方法均无法正常使用

谁来负责 release 呢?

不是我们想象的(一般情况下)

1
2
3
4
5
6
ByteBuf buf = ...
try {
...
} finally {
buf.release();
}

请思考,因为 pipeline 的存在,一般需要将 ByteBuf 传递给下一个 ChannelHandler,如果在 finally 中 release 了,就失去了传递性(当然,如果在这个 ChannelHandler 内这个 ByteBuf 已完成了它的使命,那么便无须再传递)

基本规则是,谁是最后使用者,谁负责 release,详细分析如下

  • 起点,对于 NIO 实现来讲,在 io.netty.channel.nio.AbstractNioByteChannel.NioByteUnsafe#read 方法中首次创建 ByteBuf 放入 pipeline(line 163 pipeline.fireChannelRead(byteBuf))
  • 入站 ByteBuf 处理原则

    • 对原始 ByteBuf 不做处理,调用 ctx.fireChannelRead(msg) 向后传递,这时无须 release
    • 将原始 ByteBuf 转换为其它类型的 Java 对象,这时 ByteBuf 就没用了,必须 release
    • 如果不调用 ctx.fireChannelRead(msg) 向后传递,那么也必须 release
    • 注意各种异常,如果 ByteBuf 没有成功传递到下一个 ChannelHandler,必须 release
    • 假设消息一直向后传,那么 TailContext 会负责释放未处理消息(原始的 ByteBuf)
  • 出站 ByteBuf 处理原则

    • 出站消息最终都会转为 ByteBuf 输出,一直向前传,由 HeadContext flush 后 release
  • 异常处理原则

    • 有时候不清楚 ByteBuf 被引用了多少次,但又必须彻底释放,可以循环调用 release 直到返回 true

Command + O 类搜索框

TailContext 释放未处理消息逻辑

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
// 实现 ChannelInboundHandler 用于处理入站最后的收尾工作,引用计数法回收内存
final class TailContext extends AbstractChannelHandlerContext implements ChannelInboundHandler

public void channelRead(ChannelHandlerContext ctx, Object msg) {
DefaultChannelPipeline.this.onUnhandledInboundMessage(ctx, msg);
}

// io.netty.channel.DefaultChannelPipeline#onUnhandledInboundMessage(java.lang.Object)
protected void onUnhandledInboundMessage(Object msg) {
try {
logger.debug(
"Discarded inbound message {} that reached at the tail of the pipeline. " +
"Please check your pipeline configuration.", msg);
} finally {
ReferenceCountUtil.release(msg);
}
}

具体代码

1
2
3
4
5
6
7
// io.netty.util.ReferenceCountUtil#release(java.lang.Object)
public static boolean release(Object msg) {
if (msg instanceof ReferenceCounted) {
return ((ReferenceCounted) msg).release();
}
return false;
}

HeadContext 释放未处理消息逻辑

1
2
3
// 实现 ChannelInboundHandler 用于处理入站开始工作
// 实现 ChannelOutboundHandler 用于处理出站最后的收尾工作,引用计数法回收内存
final class HeadContext extends AbstractChannelHandlerContext implements ChannelOutboundHandler, ChannelInboundHandler

slice

【零拷贝】的体现之一,对原始 ByteBuf 进行切片成多个 ByteBuf,切片后的 ByteBuf 并没有发生内存复制,还是使用原始 ByteBuf 的内存,切片后的 ByteBuf 维护独立的 read,write 指针

slice

例,原始 ByteBuf 进行一些初始操作

1
2
3
4
ByteBuf origin = ByteBufAllocator.DEFAULT.buffer(10);
origin.writeBytes(new byte[]{1, 2, 3, 4});
origin.readByte();
System.out.println(ByteBufUtil.prettyHexDump(origin));

输出

1
2
3
4
5
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 02 03 04 |... |
+--------+-------------------------------------------------+----------------+

这时调用 slice 进行切片,无参 slice 是从原始 ByteBuf 的 read index 到 write index 之间的内容进行切片,切片后的 max capacity 被固定为这个区间的大小,因此不能追加 write

1
2
3
ByteBuf slice = origin.slice();
System.out.println(ByteBufUtil.prettyHexDump(slice));
// slice.writeByte(5); 如果执行,会报 IndexOutOfBoundsException 异常

输出

1
2
3
4
5
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 02 03 04 |... |
+--------+-------------------------------------------------+----------------+

如果原始 ByteBuf 再次读操作(又读了一个字节)

1
2
origin.readByte();
System.out.println(ByteBufUtil.prettyHexDump(origin));

输出

1
2
3
4
5
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 03 04 |.. |
+--------+-------------------------------------------------+----------------+

这时的 slice 不受影响,因为它有独立的读写指针

System.out.println(ByteBufUtil.prettyHexDump(slice));

输出

1
2
3
4
5
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 02 03 04 |... |
+--------+-------------------------------------------------+----------------+

如果 slice 的内容发生了更改

1
2
slice.setByte(2, 5);
System.out.println(ByteBufUtil.prettyHexDump(slice));

输出

1
2
3
4
5
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 02 03 05 |... |
+--------+-------------------------------------------------+----------------+

这时,原始 ByteBuf 也会受影响,因为底层都是同一块内存

System.out.println(ByteBufUtil.prettyHexDump(origin));

输出

1
2
3
4
5
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 03 05 |.. |
+--------+-------------------------------------------------+----------------+
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
public class TestSlice {

public static void main(String[] args) {
ByteBuf byteBuf = ByteBufAllocator.DEFAULT.buffer(10);
byteBuf.writeBytes(new byte[]{'a','b','c','d','e','f','g','h','i','j'});
log(byteBuf);

// 在切片过程中没有发生数据复制
ByteBuf slice1 = byteBuf.slice(0, 5);
ByteBuf slice2 = byteBuf.slice(5, 5);

log(slice1);
log(slice2);

System.out.println("==============================");
slice1.setByte(0,'b');
log(byteBuf);
log(slice1);
}
}

输出

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
20:45:35 [DEBUG] [main] c.n.d.N.TestByteBuf - read index:0 write index:10 capacity:10
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 61 62 63 64 65 66 67 68 69 6a |abcdefghij |
+--------+-------------------------------------------------+----------------+
20:45:35 [DEBUG] [main] c.n.d.N.TestByteBuf - read index:0 write index:5 capacity:5
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 61 62 63 64 65 |abcde |
+--------+-------------------------------------------------+----------------+
20:45:35 [DEBUG] [main] c.n.d.N.TestByteBuf - read index:0 write index:5 capacity:5
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 66 67 68 69 6a |fghij |
+--------+-------------------------------------------------+----------------+
===============
20:45:35 [DEBUG] [main] c.n.d.N.TestByteBuf - read index:0 write index:10 capacity:10
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 62 62 63 64 65 66 67 68 69 6a |bbcdefghij |
+--------+-------------------------------------------------+----------------+
20:45:35 [DEBUG] [main] c.n.d.N.TestByteBuf - read index:0 write index:5 capacity:5
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 62 62 63 64 65 |bbcde |
+--------+-------------------------------------------------+----------------+

duplicate

【零拷贝】的体现之一,就好比截取了原始 ByteBuf 所有内容,并且没有 max capacity 的限制,也是与原始 ByteBuf 使用同一块底层内存,只是读写指针是独立的

duplicate

copy

会将底层内存数据进行深拷贝,因此无论读写,都与原始 ByteBuf 无关

CompositeByteBuf

【零拷贝】的体现之一,可以将多个 ByteBuf 合并为一个逻辑上的 ByteBuf,避免拷贝

有两个 ByteBuf 如下

1
2
3
4
5
6
ByteBuf buf1 = ByteBufAllocator.DEFAULT.buffer(5);
buf1.writeBytes(new byte[]{1, 2, 3, 4, 5});
ByteBuf buf2 = ByteBufAllocator.DEFAULT.buffer(5);
buf2.writeBytes(new byte[]{6, 7, 8, 9, 10});
System.out.println(ByteBufUtil.prettyHexDump(buf1));
System.out.println(ByteBufUtil.prettyHexDump(buf2));

输出

1
2
3
4
5
6
7
8
9
10
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 01 02 03 04 05 |..... |
+--------+-------------------------------------------------+----------------+
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 06 07 08 09 0a |..... |
+--------+-------------------------------------------------+----------------+

现在需要一个新的 ByteBuf,内容来自于刚才的 buf1 和 buf2,如何实现?

方法1:

1
2
3
4
5
ByteBuf buf3 = ByteBufAllocator.DEFAULT
.buffer(buf1.readableBytes()+buf2.readableBytes());
buf3.writeBytes(buf1);
buf3.writeBytes(buf2);
System.out.println(ByteBufUtil.prettyHexDump(buf3));

结果

1
2
3
4
5
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 01 02 03 04 05 06 07 08 09 0a |.......... |
+--------+-------------------------------------------------+----------------+

这种方法好不好?回答是不太好,因为进行了数据的内存复制操作

方法2:

1
2
3
CompositeByteBuf buf3 = ByteBufAllocator.DEFAULT.compositeBuffer();
// true 表示增加新的 ByteBuf 自动递增 write index, 否则 write index 会始终为 0
buf3.addComponents(true, buf1, buf2);

结果是一样的

1
2
3
4
5
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 01 02 03 04 05 06 07 08 09 0a |.......... |
+--------+-------------------------------------------------+----------------+

CompositeByteBuf 是一个组合的 ByteBuf,它内部维护了一个 Component 数组,每个 Component 管理一个 ByteBuf,记录了这个 ByteBuf 相对于整体偏移量等信息,代表着整体中某一段的数据。

  • 优点,对外是一个虚拟视图,组合这些 ByteBuf 不会产生内存复制
  • 缺点,复杂了很多,读写指针需要重新计算,多次操作会带来性能的损耗

Unpooled

Unpooled 是一个工具类,类如其名,提供了非池化的 ByteBuf 创建、组合、复制等操作

这里仅介绍其跟【零拷贝】相关的 wrappedBuffer 方法,可以用来包装 ByteBuf

1
2
3
4
5
6
7
8
ByteBuf buf1 = ByteBufAllocator.DEFAULT.buffer(5);
buf1.writeBytes(new byte[]{1, 2, 3, 4, 5});
ByteBuf buf2 = ByteBufAllocator.DEFAULT.buffer(5);
buf2.writeBytes(new byte[]{6, 7, 8, 9, 10});

// 当包装 ByteBuf 个数超过一个时, 底层使用了 CompositeByteBuf
ByteBuf buf3 = Unpooled.wrappedBuffer(buf1, buf2);
System.out.println(ByteBufUtil.prettyHexDump(buf3));

输出

1
2
3
4
5
         +-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 01 02 03 04 05 06 07 08 09 0a |.......... |
+--------+-------------------------------------------------+----------------+

也可以用来包装普通字节数组,底层也不会有拷贝操作

1
2
3
ByteBuf buf4 = Unpooled.wrappedBuffer(new byte[]{1, 2, 3}, new byte[]{4, 5, 6});
System.out.println(buf4.getClass());
System.out.println(ByteBufUtil.prettyHexDump(buf4));

输出

1
2
3
4
5
6
class io.netty.buffer.CompositeByteBuf
+-------------------------------------------------+
| 0 1 2 3 4 5 6 7 8 9 a b c d e f |
+--------+-------------------------------------------------+----------------+
|00000000| 01 02 03 04 05 06 |...... |
+--------+-------------------------------------------------+----------------+

💡 ByteBuf 优势

  • 池化 - 可以重用池中 ByteBuf 实例,更节约内存,减少内存溢出的可能
  • 读写指针分离,不需要像 ByteBuffer 一样切换读写模式
  • 可以自动扩容
  • 支持链式调用,使用更流畅
  • 很多地方体现零拷贝,例如 slice、duplicate、CompositeByteBuf

双向通信

练习

实现一个 echo server

编写 server

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
new ServerBootstrap()
.group(new NioEventLoopGroup())
.channel(NioServerSocketChannel.class)
.childHandler(new ChannelInitializer<NioSocketChannel>() {
@Override
protected void initChannel(NioSocketChannel ch) {
ch.pipeline().addLast(new ChannelInboundHandlerAdapter(){
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) {
ByteBuf buffer = (ByteBuf) msg;
System.out.println(buffer.toString(Charset.defaultCharset()));

// 建议使用 ctx.alloc() 创建 ByteBuf
ByteBuf response = ctx.alloc().buffer();
response.writeBytes(buffer);
ctx.writeAndFlush(response);

// 思考:需要释放 buffer 吗
// 思考:需要释放 response 吗
}
});
}
}).bind(8080);

编写 client

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
NioEventLoopGroup group = new NioEventLoopGroup();
Channel channel = new Bootstrap()
.group(group)
.channel(NioSocketChannel.class)
.handler(new ChannelInitializer<NioSocketChannel>() {
@Override
protected void initChannel(NioSocketChannel ch) throws Exception {
ch.pipeline().addLast(new StringEncoder());
ch.pipeline().addLast(new ChannelInboundHandlerAdapter() {
@Override
public void channelRead(ChannelHandlerContext ctx, Object msg) {
ByteBuf buffer = (ByteBuf) msg;
System.out.println(buffer.toString(Charset.defaultCharset()));

// 思考:需要释放 buffer 吗
}
});
}
}).connect("127.0.0.1", 8080).sync().channel();

channel.closeFuture().addListener(future -> {
group.shutdownGracefully();
});

new Thread(() -> {
Scanner scanner = new Scanner(System.in);
while (true) {
String line = scanner.nextLine();
if ("q".equals(line)) {
channel.close();
break;
}
channel.writeAndFlush(line);
}
}).start();

💡 读和写的误解

我最初在认识上有这样的误区,认为只有在 netty,nio 这样的多路复用 IO 模型时,读写才不会相互阻塞,才可以实现高效的双向通信,但实际上,Java Socket 是全双工的:在任意时刻,线路上存在A 到 B 和 B 到 A 的双向信号传输。即使是阻塞 IO,读和写是可以同时进行的,只要分别采用读线程和写线程即可,读不会阻塞写、写也不会阻塞读

例如

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
public class TestServer {
public static void main(String[] args) throws IOException {
ServerSocket ss = new ServerSocket(8888);
Socket s = ss.accept();

new Thread(() -> {
try {
BufferedReader reader = new BufferedReader(new InputStreamReader(s.getInputStream()));
while (true) {
System.out.println(reader.readLine());
}
} catch (IOException e) {
e.printStackTrace();
}
}).start();

new Thread(() -> {
try {
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(s.getOutputStream()));
// 例如在这个位置加入 thread 级别断点,可以发现即使不写入数据,也不妨碍前面线程读取客户端数据
for (int i = 0; i < 100; i++) {
writer.write(String.valueOf(i));
writer.newLine();
writer.flush();
}
} catch (IOException e) {
e.printStackTrace();
}
}).start();
}
}

客户端

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
public class TestClient {
public static void main(String[] args) throws IOException {
Socket s = new Socket("localhost", 8888);

new Thread(() -> {
try {
BufferedReader reader = new BufferedReader(new InputStreamReader(s.getInputStream()));
while (true) {
System.out.println(reader.readLine());
}
} catch (IOException e) {
e.printStackTrace();
}
}).start();

new Thread(() -> {
try {
BufferedWriter writer = new BufferedWriter(new OutputStreamWriter(s.getOutputStream()));
for (int i = 0; i < 100; i++) {
writer.write(String.valueOf(i));
writer.newLine();
writer.flush();
}
} catch (IOException e) {
e.printStackTrace();
}
}).start();
}
}