Netty 的 Handler 链调用机制

3,185 阅读3分钟

什么是 Handler

  • Netty是一款基于NIO的异步事件驱动网络应用框架,其核心概念之一就是Handler。而Handler是Netty中处理事件的核心组件,用于处理入站和出站的数据流,实现业务逻辑和网络协议的处理。

  • 在Netty中,Handler是一个接口,主要分为两种:ChannelInboundHandler(入站Handler)和ChannelOutBoundHandler(出站Handler),如下图所示。

    • ChannelInboundHandler :处理从网络通道中读取到的数据,包括解码、反序列化、消息分发等操作;
    • ChannelOutboundHandler:可以负责将处理结果编码、加密并通过网络通道发送出去等

image-20230322212239004.png

Handler 是怎么被组织起来的

  • 为了方便事件在各个Handler中处理与传递,在Netty中,每一个ChannelHandler被封装为一个ChannelHandlerContext

    • ChannelHandlerContext提供了对ChannelHandler的访问,以及它前后相邻的ChannelHandler的访问。在ChannelHandlerContext的抽象实现类AbstractChannelHandlerContext,可以很清楚的看到,它拥有nextprev两个属性,分别对应下一个和上一个ChannelHandlerContext
  • 在Netty中,一个完整的处理链路可以由多个ChannelHandlerContext组成,这些ChannelHandlerContext形成一个管道(Pipeline) ,通过管道串联起来,形成完整的数据处理流程。在数据流经过管道中的每个ChannelHandlerContext时,都可以对数据进行一些特定的处理。

Handler 链调用机制

简述

ChannelPipeline的源码中,我们可以看到这样的一段注释

image-20230323214556973.png 这可能容易让人产生认为Pipeline 中维护了两条链表,其中一条用于处理出站事件,另外一条处理入站事件。

实际上,Pipeline是维护了一条双向链表,当数据从入站方向流经处理程序链时,数据从双向链表的head 向后面遍历,依次将事件交由后面一个handler处理,当数据从出站方向流经处理程序链时,数据从双向链表的tail 向前面遍历,依次将事件交由下一个handler处理。

image-20230323233754401.png

ChannelPipeline 如何调度 handler

上面提到,Pipeline 中维护了一个由handler双向链表。那么,当事件进入pipeline 中时,ChannelPipeline 是如何调用这些 handler 的呢 ?

  1. 当一个请求进入时,pipeline 会首先调用 ChannelContextfireXXX() 方法(下面以 fireChannelRead() 为例),在 fireChannelRead()中,会调用 invokeChannelRead(head, msg) 并将包装着下一个要执行的 handlerChannelContext传入

事件第一个经过的一定是 head ,因此在下面的代码中,invokeChannelRead()传入的是 head

 @Override
 public final ChannelPipeline fireChannelRead(Object msg) {
     AbstractChannelHandlerContext.invokeChannelRead(head, msg);
     return this;
 }
  1. 进入invokeChannelRead(),后会调用handler真正的channelRead(this, msg)方法进行业务处理
 private void invokeChannelRead(Object msg) {
     if (invokeHandler()) {
         try {
             ((ChannelInboundHandler) handler()).channelRead(this, msg);
         } catch (Throwable t) {
             notifyHandlerException(t);
         }
     } else {
         fireChannelRead(msg);
     }
 }
  1. 进行业务处理之后,channelRead()会执行ctx.fireChannelRead(msg),通过这行代码将处理过的消息传递给下一个处理器进行处理
 @Override
 public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
     ctx.fireChannelRead(msg);
 }
  1. 从下面的代码可以看到,fireChannelRead() 方法与上面 1 中唯一不同的是,调用了findContextInbound()方法来寻找下一个 handler

    1. findContextInbound()中,我们可以发现,它使用了一个 do while 循环来寻找下一个 handler,这个循环当下一个 handler 的类型同为 inbound时,会被返回。因此,当事件入站时,每次进行事件处理的handler 都是 ChannelInboundHandler。(出站同理)
    2. 至此,fireChannelRead()调用当前AbstractChannelHandlerContextinvokeChannelRead() 回到 2
 @Override 
 public ChannelHandlerContext fireChannelRead(final Object msg) {
     invokeChannelRead(findContextInbound(), msg);
     return this;
 }
 ​
 private AbstractChannelHandlerContext findContextInbound() {
     AbstractChannelHandlerContext ctx = this;
     do {
         ctx = ctx.next;
     } while (!ctx.inbound);
     return ctx;
 }

从这点可以看出:一般情况下,我们需要在处理程序链中的每个handler调用 ctx.fireChannelRead(msg),以确保将事件传递给下一个处理程序。如果在handler中未调用 ctx.fireChannelRead(msg),则该事件将被截获并停留在当前handler中,不会传递到下一个处理程序。

事件出站的调度从双向链表的tail开始,调用机制与入站类似,这里不再赘述。