Netty in Action — Chapter 6

ChannelHandler

The Channel lifecycle

接口Channel定义了一些简单但是有用的状态模型

状态 描述
ChannelUnregistered Channel已经创建,但是还没有注册到EventLoop上
ChannelRegistered Channel已经注册到EventLoop
ChannelActive Channel已经激活了(已经连接到远程端),现在它已经准备好接受和发送信息
ChannelInactive Channel没有连接到远程端

The ChannelHandler lifecycle

接口ChannelHandler定义了操作的生命周期,这些操作将会在ChannelHandler加入或者移除ChannelPipeline的时候被调用,每一个方法接收一个ChannelHandlerContext的入参

类型 描述
handlerAdded 当一个ChannelHandler被载入ChannelPipeline的时候触发
handlerRemoved 当一个ChannelHandler从ChannelPipeline中移除的时候触发
exceptionCaught 在处理过程中ChannelPipeline发生了异常

Netty定义了ChannelHandler两个比较重要的子接口

  • ChannelInboundHandler------处理输入数据和所有的状态改变
  • ChannelOutboundHandler--------处理输出数据,运行拦截一切的操作

Interface ChannelInboundHandler

类型 描述
channelRegistered Invoked when a Channel is registered to its EventLoop and is able to handle I/O.
channelUnregistered Invoked when a Channel is deregistered from its EventLoop and can’t handle any I/O.
channelActive Invoked when a Channel is active; the Channel is connected/ bound and ready.
... ...

ChannelInboundHandler的实现重写了channelRead(),就要负责通过ReferenceCountUtil.release()显示的释放ByteBuf实例占用的内存
可以选择继承SimpleChannelInboundHandler类,该类会自动释放内存,因此注意不要将后续要用到的引用存入message

Interface ChannelOutboundHandler

ChannelOutboundHandler的方法可以被Channel, ChannelPipelineChannelHandlerContext调用;ChannelOutboundHandler的一个强大的功能是可以根据请求延迟一个操作或一个事件,这使得它可以以复杂的逻辑来处理请求。
ChannelOutboundHandler的很多方法用ChannelPromise作为参数来通知操作的完成,ChannelPromise作为ChannelFuture的子类来定义了一些写的方法,例如setSuccesssetFailure方法,这样可以使ChannelFuture看起来immutable

ChannelHandler adapters

ChannelHandlerAdapter class hierarchy

ChannelHandlerAdapter还提供一个特殊的方法isSharable的方法,如果该接口的具体实现以“Sharable”注解的话,那么将会返回true,这就表示这个实现可以被加入到多个不同的ChannelPipeline中去

Resource management

当你通过调用ChannelInboundHandler.channelRead()或者ChannelOutboundHandler.write()这些方法来操作数据的时候,你都需要保证没有资源泄漏。
为了帮助你诊断这些潜在的问题,Netty提供了一个叫做ResourceLeakDetector的类,这个类将会对你的引用中1%的buffer分配进行取样来分析你的内存泄漏。

等级 描述
DISABLED 禁止使用内存检测,只有经过全面的测试才能使用
SIMPLE 使用默认的1%的测试样例来记录任何的使用泄漏的情况,使用这种默认的级别对于大多数的案例来说是一个不错的选择
ADVANCED 报告发现泄漏的情况且找出该信息所在的位置,依旧使用默认的测试样例比例
PARANOID 与ADVANCED一样,除了它将所有的buffer作为测试样例,这对性能有很大的负担,这应该用在测试debug阶段

泄漏检查等级可以在下面的java系统的变量中设置:

java -Dio.netty.leakDetectionLevel=ADVANCED

Interface ChannelPipeline

可以将ChannelPipeline想象为由多个ChannelHandler链接而成的一种结构,由ChannelHandlerContext负责ChannelHandler和它所属的ChannelPipeline的进行交互。

Modifying a ChannelPipeline

一个ChannelHandler可以实时的通过移除,增加或者替换其他的ChannelHandler来修改一个ChannelPipeline的布局,通过以下方法:

  • addFirst()
  • addBefore()
  • addAfter()
  • addLast()
  • replace()

正常情况下,每一个在ChannelPipeline中的ChannelHandler都是通过它的EventLoop线程来处理通过它的事件的,这是非常重要的,因为它不会阻塞当前线程

Interface ChannelHandlerContext

一个ChannelHandlerContext代表了一个ChannelHandler和ChannelPipeline之间的关系,ChannelHandlerContext创建于ChannelHandler被载入到ChannelPipeline的时候,ChannelHandlerContext主要功能是管理在同一ChannelPipeline中各个ChannelHandler的交互

ChannelHandlerContext有很多方法,其中的一些方法也出现在ChannelChannelPipeline中,但是相同的方法却有一些不同的效果,如果你在Channel或者在ChannelPipeline实例中实现这些方法,它们会传播到整个管道,同样的方法如果被ChannelHandlerContext执行的时候,那么它会在当前关联的ChannelHandler中开始执行,然后只会传播到管道中符合条件(符合方向的有兴趣的)的下一个ChannelHandler处理
当使用ChannelHandlerContext时,应该注意:

  1. ChannelHandler关联的ChannelHandlerContext不会发生改变,因此缓存其引用时安全的
  2. 相比于其他类,ChannelHandlerContext的方法包含更短的事件流,可以提供更好的性能

Using ChannelHandlerContext

Channel, ChannelPipeline, ChannelHandler, ChannelHandlerContext的关系

我们可以从ChannelHandlerContext对象中获取ChannelChannelPipe,然后通过他们的write()方法在pipe中产生一个输入流,这个输入流贯穿整个pipe
如果项从某一个ChannelHandler处开始一个事件流,可以使用前一个ChannelHandlerChannelHandlerContextwrite()方法:

ChannelHandlerContext ctx = ..;
// write() sends the buffer to the next ChannelHandler
ctx.write(Unpooled.copiedBuffer("Netty in Action", CharsetUtil.UTF_8));

Advanced uses of ChannelHandler and ChannelHandlerContext

  • ChannelHandlerContext对象可以返回绑定的ChannelPipe对象,这意味着我们可以动态的添加一些ChannelHandler到这个ChannelPipe对象中,从而支持动态的协议更改
  • 通过缓存ChannelHandlerContext对象的引用,可以稍后在ChannelHandler方法外,甚至不同线程中使用
  • ChannelHandler如果需要被多个ChannelPipe共享,必须加上@Sharable的注释,且是无状态的,保证线程安全

Exception handling

Handling inbound exceptions

在输入事件处理过程中一个异常抛出时,这个异常将会在触发该异常的ChannelInboundHandler的地方开始在ChannelPipeline传播,为了处理这样的异常,你需要在你的ChannelPipeline实现中重写如下的方法:

public class InboundExceptionHandler extends ChannelInboundHandlerAdapter {
    @Override
    public void exceptionCaught(ChannelHandlerContext ctx,
    Throwable cause) {
        cause.printStackTrace();
        ctx.close();
    }
}

注意:

  • 默认的ChannelHandlerexceptionCaught的实现会把异常传给管道中的下一个处理器
  • 如果一个异常到达了一个管道的结尾,它将被记录为未被处理
  • 来定义自定义的处理,你重写了exceptionCaught方法,这将是你自己的决定你是否决定将其接着传播到下游处理器

Handling outbound exceptions

在输入事件的处理中,需要根据返回的ChannelFuture来判断是正常完成任务还是抛出异常;ChannelOutboundHandler也会传递一个ChannelPromise实例,作为ChannelFuture的子类,它也可以被监听器管控来获取异步通知,但是ChannelPromise为实时通知提供可写的方法:

ChannelPromise setSuccess();
ChannelPromise setFailure(Throwable cause);

通过在ChannelFutureChannelPromise添加ChannelFutureListener监听器来自定义处理异常;
如果ChannelOutboundHandler本身抛出异常,将会通知其相关联的ChannelPromise来处理

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 202,723评论 5 476
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,080评论 2 379
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 149,604评论 0 335
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,440评论 1 273
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,431评论 5 364
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,499评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,893评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,541评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,751评论 1 296
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,547评论 2 319
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,619评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,320评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,890评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,896评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,137评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,796评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,335评论 2 342

推荐阅读更多精彩内容