Netty源码之Pipeline、ChannelHandler、ChannelHandlerContext

在Netty上,PipelineChannelHandler串联在一起来组织处理逻辑。比如实现协议栈HTTP,HTTP2。而ChannelHandlerContext可以认为是Pipeline用于串联ChannelHandler的纽带。开发者的业务逻辑基本上是在ChannelHandler实现的,理解这三者以及三者之间的关联是使用Netty构建模块化、可复用程序的关键。

ChannelHandler

ChannelHandler class hierarchy

上图是ChannelHandler的类结构图,在此总结下ChannelHandler的功能。

  • 响应ChannelHandler状态变化
  • 响应与其关联的Channel生命周期内的状态变化以及处理接收的数据
  • 处理与其关联的Channel上的 Outbound 操作
    下面针对这三个方面详细说明。

Channel的生命周期

Channel的生命周期

ChannelInboundHandler

ChannelInboundHandler的方法与其紧密对应。

  • channelRegistered Channel 注册到其EventLoop上,此时就可以处理I/O了。
  • channelActive 对于 NioSocketChannel其active状态是如下定义:
 public boolean isActive() {
        SocketChannel ch = javaChannel();
        return ch.isOpen() && ch.isConnected();
    }

对于NioServerSocketChannel

@Override
    public boolean isActive() {
        return javaChannel().socket().isBound();
    }
  • channelRead Channel读取数据后触发
  • channelReadComplete 一次读取周期完成,从下面的读取逻辑可以看出,channelReadComplete的在Channel读缓冲区读取完时触发。
 try {
                do {
                    //RecvByteBufAllocator 默认使用AdaptiveRecvByteBufAllocator,其根据上一次读取的字节数动态调整本次读取字节数
                    byteBuf = allocHandle.allocate(allocator);
                    allocHandle.lastBytesRead(doReadBytes(byteBuf));
                    if (allocHandle.lastBytesRead() <= 0) {
                        // nothing was read. release the buffer.
                        byteBuf.release();
                        byteBuf = null;
                        close = allocHandle.lastBytesRead() < 0;
                        break;
                    }

                    allocHandle.incMessagesRead(1);
                    readPending = false;
                    pipeline.fireChannelRead(byteBuf);
                    byteBuf = null;
                    /**
                     * 继续读取的逻辑:
                     * config.isAutoRead() &&
                     attemptedBytesRead == lastBytesRead &&
                     totalMessages < maxMessagePerRead(默认为1) &&
                     totalBytesRead < Integer.MAX_VALUE;
                     * */
                } while (allocHandle.continueReading());

                allocHandle.readComplete();
                pipeline.fireChannelReadComplete();
  • channelWritabilityChanged 当Channel的可写状态发生变化时触发。当channel不可写时用户可以用此来控制数据发送不至于太快,当Channel可写时用户可以继续发送数据。Channel的可写性可以由用户来进行设置。可以把此理解为用户空间的写缓存,和socket的系统缓存无关。
Channel.config().setWriteHighWaterMark() 
Channel.config().setWriteLowWaterMark().

ChannelOutboundHandler

ChannelOutboundHandler 给用户机会来进一步处理用户在Channel上的操作。一些比较典型的应用场景是filter掉一些操作,即根据需求拒绝一些操作;Socket面向字节流,在实现具体 的协议比如Http时,可以让用户只处理自己关心的数据,OutboundHandler可以把这些数据封装成协议需要的数据,然后交给socket发送。

method 描述
bind(ChannelHandlerContext,SocketAddress,ChannelPromise)
connect(ChannelHandlerContext,SocketAddress,SocketAddress,ChannelPromise)
disconnect(ChannelHandlerContext,ChannelPromise)
close(ChannelHandlerContext,ChannelPromise)
deregister(ChannelHandlerContext,ChannelPromise)
flush(ChannelHandlerContext)
write(ChannelHandlerContext,ChannelPromise) 。。。。

ChannelPipeline

ChannelPipeline

上图基本上可以概括Socket 和 ChannelPipeline以及ChannelHandlerChannelPipeline之间的关系。

  • ChannelPipelineChannelHandler串联在一起来拦截处理Channel产生的inboundoutbound事件,这些ChannelHandler构成了应用程序的数据和事件处理逻辑。
  • 每个Channel会与唯一一个ChannelPipeline实例进行绑定。
  • inbound事件的流向Head -> Tail,
  • outbound事件的流向是Tail->Head,这有点像网络协议栈,而且Netty本身实现的协议比如Http,Http2都是基于ChannelHandler,在其上实现数据的解码与编码。我的理解是ChannelPipeline把用户的逻辑同socket关联起来,我觉着其上面最适合实现的逻辑应该是协议的实现,至于用户的业务逻辑不应该在ChannelHandler上实现。

ChannelPipeline提供的method

ChannelPipeline提供了大量的方法,可以分为三类,


ChannelPipeline的类图
  • 触发outbound事件的方法;
ChannelOutboundInvoker
  • 触发inbound事件的方法
ChannelInboundInvoker
  • Pipeline上Handler以及Context进行管理的方法
ChannelPipeline

ChannelHandlerContext

ChannelPipeline并不是直接把ChannelHandler串联起来的,而是通过ChannelHandlerContext。可以认为ChannelPipeline是双向链表, 而链表上的节点就是ChannelHandlerContext。因此,handler的处理完后的事件实际是通过ChannelHandlerContext传递给下一个Handler的。

ChannelHandlerContext的类图

上图是ChannelHandlerContext的类图,从这里可以看出其提供的方法同ChannelPipeline类似,但是与前者不同的是,前者触发的事件被整个Pipeline处理,而Context触发的事件仅从下一个handler开始处理。如下图所示:

总结

  • 每个ChannelHandler实例唯一关联一个ChannelHandlerContext实例
  • ChannelPipeline通过ChannelHandlerContextChannelHandler串联成一个双向链表结构,用来处理Channel产生的inboundOutbound事件。这种处理方式和网络协议栈的实现方式很像,因此我觉着特别适合基于Netty实现各种应用协议。而Pipeline就是协议的编码和解码的实现逻辑。
  • 个人见解,ChannelHandler的实现最好只与协议的编码和解码有关,与具体业务相关的逻辑不是很适合在其上进行实现。
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 216,591评论 6 501
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,448评论 3 392
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 162,823评论 0 353
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,204评论 1 292
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,228评论 6 388
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,190评论 1 299
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,078评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,923评论 0 274
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,334评论 1 310
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,550评论 2 333
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,727评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,428评论 5 343
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,022评论 3 326
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,672评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,826评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,734评论 2 368
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,619评论 2 354

推荐阅读更多精彩内容