Netty学习之ChannelHandler&ChannelPipeline

Netty学习之ChannelHandler&ChannelPipeline

前言

ChannelHandler

Channel生命周期

• ChannelUnregistered，Channel被创建，但是还没有注册到EventLoop中
• ChannelRegisted，Channel注册到EventLoop中
• ChannelActive，Channel激活(连接到远程端口)，能够发送以及接受消息
• ChannelInActive，Channel没有连接到远程端口

生命周期流程

ChannelRegisted --> ChannelActive --> ChannelInactive --> ChannelUnregistered

ChannelHandler生命周期

• handlerAdded，当ChannelHandler添加到ChannelPipeline时调用
• handlerRemoved，当ChannelHandler从ChannelPipline中移除时调用
• exceptionCaught，在ChannelPipline处理时发生异常时调用

注意上面每个方法都接收一个ChannelHandlerContext作为参数

ChannelHandler有重要的两个子接口

• ChannelInboundHandler，处理输入的数据并且处理各种状态转变
• ChannelOutboundHandler，处理输出的数据并且拦截各种操作

ChannelInboundHandler生命周期

• channelRegistered，当Channel注册到对应的EventLoop并且能够处理I/O时调用
• channelUnregistered，当channel从EventLoop中移除并且不能处理任何I/O时调用
• channelActive，当channel激活时调用，此时channel已经连接并且准备好
• channelInactive，当通道断开连接时调用
• channelReadComplete，读操作在Channel中已经完成时调用(读取完成)
• channelRead，数据从channel中读取时调用(开始读取)
• channelWritabilityChanged，写状态改变时调用
• userEventTriggered，当因为管线中传递对象时ChannelInboundHanlder.fireUserEventTriggered()被调用时调用

当覆盖ChannelInboundHandler的channelRead方法时，需要手动释放对应的内存，可以通过ReferenceCountUtil.release(msg)方法进行释放操作

更简单的方式是通过SimpleChannelInboundHandler，然后覆盖其channelRead0()方法，该方法会自动释放资源，所以，不能存储稍后会使用到的数据，因为这些数据都会失效，通过源码就可以发现，该方法被channelRead()调用，并且channelRead0()方法被调用后，会释放所占用内存。

public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
    boolean release = true;
    try {
        if (acceptInboundMessage(msg)) {
            @SuppressWarnings("unchecked")
            I imsg = (I) msg;
            // 这里调用channelRead0
            channelRead0(ctx, imsg);
        } else {
            release = false;
            ctx.fireChannelRead(msg);
        }
    } finally {
        if (autoRelease && release) {
            // 释放空间
            ReferenceCountUtil.release(msg);
        }
    }
}

ChannelOutboundHandler

ChannelOutboundHandler的方法由Channel、ChannelPipeline、ChannelHandlerContext调用

主要的操作方法有write()、flush()

大部分的方法都会带一个ChannelPromise参数，当操作完成时可以收到通知，该接口是ChannelFuture的子接口。

在Netty中，同时还提供了ChannelInboundHandlerAdapter、ChannelOutboundHanlderAdapter类，一般只需要继承这两个类，然后覆盖想要实现逻辑的方法即可。

资源管理

在使用ChannelInboundHanlder#channelRead()或者ChannelOutboundHandler#write()时，需要保证没有资源泄露，Netty使用引用技术来处理缓存的ByteBuf，所以使用完ByteBuf之后更改引用是非常重要的。

Netty提供了一个ResouceLeakDetecor工具类用于检测是否发生内存泄露，如果发生泄露，则会打印对应的日志信息。有四个不同的级别

• DISABLED，关闭泄露检查
• SIMPLE，默认级别，样本率为1%
• ADVANCED，报告内存泄露以及对应的信息
• PARANOID，每个类均采样，会严重影响性能

如果一个消息已经被消费或者被丢弃，并且不再在管道中传递给下一个接受者，则需要手动调用ReferenceCountUtil.release(msg)将其释放，如果消息到达传输层，当消息被写出或者通道关闭后，会自动进行释放。

ChannelPipeline

每个新的Channel都会绑定一个新的ChannelPipeline，并且是永久性的，Channel不能绑定新的ChannelPipeline，也不能从当前Channel中解绑(开发者无需关心绑定以及解绑)

ChannelHandlerContext使得一个ChannelHanlder能够与ChannelPipeline以及其他的ChannelHandler进行通信

由于ChannelPipeline传播事件，它会检测在管线中的下一个ChannelHandler是否匹配移动的方法，如果不匹配，则跳过该ChannleHandler，并且处理下一个，直到找到一个匹配的ChannelHandler。

ChannelPipeline中提供了众多的方法用于操作ChannelHandler，如addFirst、addLast、remove等。同时，还提供了众多的方法用于调用下一个ChannelInboundHandler方法的方法，如fireChannelRead()、fireExceptionCaught()等，调用下一个ChannelOutboundHandler方法的方法，如flush()、write()、writeAndFlush()等。

ChannelHandlerContext

ChannelHandlerContext表示ChannelHandler和ChannelPipeline之间的连接，当一个ChannelHandler被添加到ChannelPipeline时会被创建。

ChannelPipeline的主要作用是管理其所关联的ChannelHandler与其他在ChannelPipeline中的ChannelHandler的交互

如果调用Channel或者ChannelPipeline中的某些方法，对应的操作会在整个ChannelPipeline中传输，而通过ChannelHandlerContext调用，只传输给下一个能够处理该事件的ChannelHandler

异常处理

如果是ChannelInboundHandler中出现异常，会逐步进行传递，所以，一般在最后一个channelHandler中覆盖caughtException()，实现对应的异常处理逻辑

如果是在ChannelOutboundHandler中出现异常，可以有一下机制

• 每一个outbound操作会返回一个ChannelFuture，注册了的ChannelFutureListener会收到对应的消息，即成功或者失败
• 几乎所有的channelOutboundHanlder会传递一个ChannelPromise实例，该实例是ChannelFuture的子类，ChannelPromise能够注册监听器用于异步通知，也可以直接通知操作，setSuccess()、setFailure()

总结

本小节我们主要详细学习了ChannelHandler以及ChannelPipeline，ChannelHandler是Netty应用中逻辑的存放地方，基本上我们主要交互的对象也是ChannelHandler，不同的ChannelHandler之间通过ChannelPipeline连接起来，构成一个Handler处理链，而ChannelHandler与ChannelPipeline之间则是通过ChannelHandlerContext进行连接，不同的对象用途不同，使用的时候需要注意。