本文来说下netty中的核心知识ChannelHandler 与 ChannelPipeline 详解

概述

我们在上一篇文章中研究的 bytebuf 是一个容器用来“包装”数据。在本章我们将探讨这些容器如何通过应用程序来移动，传入和传出，以及他们的内容是如何处理的。

本章主要内容

• Channel
• ChannelHandler
• ChannePipeline
• ChannelHandlerContext

ChannelHandler 家族

Channel生命周期

在 Channel 的生命周期中，它的状态与 ChannelHandler 是密切相关的，下列是 Channel 组件的四个状态：

Channel 的生命周期如下图所示，当这些状态发生改变时，将会生成对应的事件，ChannelPipeline 中的ChannelHandler 就可以及时做出处理：

ChannelHandler 生命周期

ChannelHandler 接口定义了其生命周期中的操作，当ChanelHandler被添加到ChannelPipeline 或从ChannelPipeline中移除时，会调用这些操作，ChannelHandler的生命周期如下：

ChannelHanler子接口

Netty 提供2个重要的 ChannelHandler 子接口：

• ChannelInboundHandler - 处理进站数据，并且所有状态都更改
• ChannelOutboundHandler - 处理出站数据，允许拦截各种操作

ChannelInboundHandler接口

ChannelInboundHandler会在接受数据或者其对应的Channel状态发生改变时调用其生命周期的方法， ChannelInboundHandler的生命周期和Channel的生命周期其实是密切相关的。 以下是ChannelInboundHandler的生命周期方法：

这里有一个细节一定需要注意：当我们实现ChannelInboundHandler的channelRead方法时，请一定要记住 使用ReferenceCountUtil的release方法释放ByteBuf，这样可以减少内存的消耗，所以我们可以实现一个 ChannelHandler来完成对ByteBuf的释放，就像下面这样：

由于手工管理资源会很繁琐,您可以通过使用 SimpleChannelInboundHandler 简化问题，因为SimpleChannelInboundHandler已经帮我们 把与业务无关的逻辑在ChannelRead方法实现了，我们只需要实现它的channelRead0方法来完成我们的逻辑就够了：

@ChannelHandler.Sharable
// 继承 SimpleChannelInboundHandler
public class SimpleDiscardHandler extends SimpleChannelInboundHandler<Object> {@Overridepublic void channelRead0(ChannelHandlerContext ctx, Object msg) {// 不需做特别的释放资源的动作}}

ChannelInitializer

回顾一下我们在第一个 Netty 应用章节的服务端代码：

public final class HelloServer {......private void start() throws InterruptedException {// 1.bossGroup 线程用于接收连接，workerGroup 线程用于具体的处理EventLoopGroup bossGroup = new NioEventLoopGroup(1);EventLoopGroup workerGroup = new NioEventLoopGroup();try {// 2.创建服务端启动引导/辅助类：ServerBootstrapServerBootstrap b = new ServerBootstrap();// 3.给引导类配置两大线程组,确定了线程模型b.group(bossGroup, workerGroup)// (非必备)打印日志.handler(new LoggingHandler(LogLevel.INFO))// 4.指定 IO 模型为 NIO.channel(NioServerSocketChannel.class).childHandler(new ChannelInitializer<SocketChannel>() {@Overridepublic void initChannel(SocketChannel ch) {ChannelPipeline p = ch.pipeline();// 5.可以自定义客户端消息的业务处理逻辑p.addLast(new HelloServerHandler());}});......}}......}

其中加入 ServerBootstrap 中处理的 channel 是一个 ChannelInitializer ，这是怎么回事呢，不是应该相应的ChannelHandler 吗？我们来看一下Channelnitializer源代码：

public abstract class ChannelInitializer<C extends Channel> extends ChannelInboundHandlerAdapter {private static final InternalLogger logger = InternalLoggerFactory.getInstance(ChannelInitializer.class);/*** 这个方法会在Channle被注册时候调用，在方法返回之后，这个实例会在Channel对应的ChannelPipeline中删除** @param ch            the {@link Channel} which was registered.* @throws Exception    is thrown if an error occurs. In that case the {@link Channel} will be closed.*/protected abstract void initChannel(C ch) throws Exception;@SuppressWarnings("unchecked")@Overridepublic final void channelRegistered(ChannelHandlerContext ctx)throws Exception {boolean removed = false;boolean success = false;try {initChannel((C) ctx.channel());ctx.pipeline().remove(this);removed = true;ctx.fireChannelRegistered();success = true;} catch (Throwable t) {logger.warn("Failed to initialize a channel. Closing: " + ctx.channel(), t);} finally {if (!removed) {ctx.pipeline().remove(this);}if (!success) {ctx.close();}}}
}

从上面可以看出ChannelInitializer其实也是一个ChannelHandler，只是ChannelInitializer的主要任务不是对IO进行处理，而更多的负责对注册到EventGroup的Channel进行 init 处理，其中大多是进行加入 Handler 的处理

ChannelOutboundHandler接口

出站数据将由ChannelOutboundHandler处理，它的方法将被Channel，ChannelPipeline以及ChannelHandlerContext调用 （Channel，ChannelPipeline，ChannelHandlerContext都拥有write操作），以下是ChannelOutboundHandler的主要方法：

几乎所有的方法都将 ChannelPromise 作为参数, 一旦请求结束要通过 ChannelPipeline 转发的时候，必须通知此参数。

ChannelPromise vs. ChannelFuture：

ChannelPromise 是 特殊的 ChannelFuture （ChannelPromise 扩展了 ChannelFuture）。任何时候调用例如 Channel.write(…) 一个新的 ChannelPromise将会创建并且通过 ChannelPipeline传递。这次写操作本身将会返回 ChannelFuture， 这样只允许你得到一次操作完成的通知。Netty 本身使用 ChannelPromise 作为返回的 ChannelFuture 的通知，事实上在大多数时候就是 ChannelPromise 自身。

资源管理

当我们使用ChannelInboundHandler的read或ChannelOutboundHandler的write操作时，我们都需要保证 没有任何资源泄露并尽可能的减少资源耗费。之前已经介绍过了ReferenceCount引用计数用于处理池化的 ByteBuf资源。 为了帮助我们诊断潜在的的资源泄露问题，Netty提供了ResourceLeakDetector，它将 对我们的Netty程序的已分配的缓冲区做大约 1% 的采样用以检测内存泄露，Netty 目前定义了4种泄露检测级别，如下

我们可以通过 JVM 启动参数来设置leakDetector的级别：

java -Dio.netty.leakDetectionLevel=ADVANCED

ChannelPipeline

在 Netty 组件中也介绍过了，ChannelPipeline是一系列ChannelHandler组成的拦截链，每一个新创建的Channel 都会被分配一个新的ChannelPipeline，Channel和ChannelPipeline之间的关联是持久的，无需我们干涉它们 之间的关系。

ChannelPipeline相对论

Netty 总是将ChannelPipeline的入站口作为头部，出站口作为尾部，当我们通过ChannelPipeline的add方法 将入站处理器和出站处理器混合添加到ChannelPipeline后，ChannelHandler的顺序如下：

一个入站事件将从ChannelPipeline的头部（左侧）向尾部（右侧）开始传播，出站事件的传播则是与入站的传播方向相反。当ChannelPipeline在ChannelHandler之间传播事件的时候，它会判断下一个ChannelHandler的类型是否与当前ChannelHandler的类型相同（通过 ChannelHandlerContext），如果相同则说明它们是一个方向的事件， 如果不同则跳过该ChannelHandler并前进到下一个ChannelHandler，直到它找到相同类型的ChannelHandler。

修改ChannelPipeline

ChannelPipeline可以通过添加，删除和修改ChannelHandler来修改它自身的布局，这是它最基本的能力， 一下列举了ChannelPipeline的一些修改方法：

ChannelHandler的执行和阻塞

通常ChannelPipeline中的每个ChannelHandler都是通过它（ChannelPipeline）的EventLoop线程来处理 传递给他的数据的，所以我们不能去阻塞这个线程，否则会对整体的 IO 操作产生负面影响。 但有时候不得已 需要使用阻塞的 API 来完成逻辑处理，对于这种情况，ChannelPipeline的某些方法支持接受一个EventLoopGroup 类型的参数，我们可以通过自定义EventLoopGroup的方式，使ChannelHandler在我们的EventLoopGroup内处理数据。 这样一来，就可以避免阻塞线程的影响了。

触发事件

ChannelPipeline的API不仅有对ChannelHandler的增删改操作，还有对入站和出站操作的附加方法，如ChannelPipeline的入站方法：

ChannelPipeline的出站方法：

ChannelHandlerContext

ChannelHandlerContext代表的是ChannelHandler和ChannelPipeline之间的关联，每当有ChannelHandler 添加到ChannelPipeline中时，都会创建ChannelHandlerContext。ChannelHandlerContext的主要功能是 管理它所关联的ChannelHandler与同一个ChannelPipeline中的其他ChannelHandler之间的交互：

ChannelHandlerContext的大部分方法和Channel和ChannelPipeline相似，但有一个重要的区别是： 调用Channel或ChannelPipeline的方法其影响是会沿着整个 ChannelPipeline 进行传播：

//使用Chanel write
Channel channel = ctx.channel();
ctx.write(xxx);//使用Pipeline write
ChannelPipeline pipeline = ctx.pipeline();
pipeline.write(xxx);

而调用 ChannelHandlerContext 的方法则是从其关联的 ChannelHandler 开始，并且只会传播给位于该ChannelPipeline中的下一个能够处理该事件的 ChannelHandler：

//使用ChannelContext write
ChannelHandlerContext ctx = context;
ctx.write(xxx);

下面是一些比较重要的方法，有些和ChannelPipeline功能相似的方法就不再罗列了，各位同学可以直接查看原API。

ChannelHandlerContext 的高级用法

有时候我们需要在多个ChannelPipeline之间共享一个ChannelHandler，以此实现跨管道处理（获取）数据 的功能，此时的ChannelHandler属于多个ChannelPipeline，且会绑定到不同的ChannelHandlerContext上。

在多个ChannelPipeline之间共享ChannelHandler我们需要使用 @Sharable 注解，这代表着它是一个共享的 ChannelHandler，如果一个ChannelHandler没有使用@Sharable注解却被用于多个ChannelPipeline，那么 将会触发异常。 还有非常重要的一点：一个ChannelHandler被用于多个ChannelPipeline肯定涉及到多线程 数据共享的问题，因此我们需要保证ChannelHandler的方法同步。 下面是一个很好的例子：

@ChannelHandler.Sharable    
public class UnsafeSharableChannelHandler extends ChannelInboundHandlerAdapter{private int count;@Overridepublic void channelRead(ChannelHandlerContext ctx,Object msg){count++;System.out.println("count : " + count);ctx.fireChannelRead(msg);}
}

上面这个ChannelHandler标识了@Sharable注解，这代表它需要被用于多个ChannelPipeline之间

这段代码的问题是它持有状态: 一个实例变量 count 保持了方法调用的计数。将这个类的一个实例添加到 ChannelPipeline 并发访问通道时很可能产生错误。一个简单的解决方法就是给修改了count的变量的方法 channelRead 加synchronized关键字，确保即使在多个ChannelPipeline之间共享， ChannelHandler也能保证数据一致。

本文小结

本文详细介绍了netty中有关ChannelHandler 与 ChannelPipeline的知识与内容。