netty中ChannelHandler执行顺序案例详解

悠悠 2021-07-20 22:29 336阅读 0赞

## 一、netty的Pipeline模型 ##

netty的Pipeline模型用的是责任链设计模式，当boss线程监控到绑定端口上有accept事件，此时会为该socket连接实例化Pipeline，并将InboundHandler和OutboundHandler按序加载到Pipeline中，然后将该socket连接（也就是Channel对象）挂载到selector上。一个selector对应一个线程，该线程会轮询所有挂载在他身上的socket连接有没有read或write事件，然后通过线程池去执行Pipeline的业务流。selector如何查询哪些socket连接有read或write事件，主要取决于调用操作系统的哪种IO多路复用内核，如果是select（注意，此处的select是指操作系统内核的select IO多路复用，不是netty的seletor对象），那么将会遍历所有socket连接，依次询问是否有read或write事件，最终操作系统内核将所有IO事件的socket连接返回给netty进程，当有很多socket连接时，这种方式将会大大降低性能，因为存在大量socket连接的遍历和内核内存的拷贝。如果是epoll，性能将会大幅提升，因为他基于完成端口事件，已经维护好有IO事件的socket连接列表，selector直接取走，无需遍历，也少掉内核内存拷贝带来的性能损耗。

Pipeline的责任链是通过ChannelHandlerContext对象串联的，ChannelHandlerContext对象里封装了ChannelHandler对象，通过prev和next节点实现双向链表。Pipeline的首尾节点分别是head和tail，当selector轮询到socket有read事件时，将会触发Pipeline责任链，从head开始调起第一个InboundHandler的ChannelRead事件，接着通过fire方法依次触发Pipeline上的下一个ChannelHandler，如下图：

![format_png][]

ChannelHandler分为InbounHandler和OutboundHandler，InboundHandler用来处理接收消息，OutboundHandler用来处理发送消息。head的ChannelHandler既是InboundHandler又是OutboundHandler，无论是read还是write都会经过head，所以head封装了unsafe方法，用来操作socket的read和write。tail的ChannelHandler只是InboundHandler，read的Pipleline处理将会最终到达tail。

## **二、通过六组实验验证InboundHandler和OutboundHandler的执行顺序** ##

在做实验之前，先把实验代码贴出来。

EchoServer类：

package com.wisdlab.nettylab;
    
    import io.netty.bootstrap.ServerBootstrap;
    import io.netty.channel.ChannelFuture;
    import io.netty.channel.ChannelInitializer;
    import io.netty.channel.ChannelOption;
    import io.netty.channel.EventLoopGroup;
    import io.netty.channel.nio.NioEventLoopGroup;
    import io.netty.channel.socket.SocketChannel;
    import io.netty.channel.socket.nio.NioServerSocketChannel;
    
    /**
     * @ClassName EchoServer
     * @Description TODO
     * @Author felix
     * @Date 2019/9/26 10:37
     * @Version 1.0
     **/
    public class EchoServer {
        private int port;
    
        public EchoServer(int port) {
            this.port = port;
        }
    
        private void run() {
            EventLoopGroup bossGroup = new NioEventLoopGroup();
            EventLoopGroup workGroup = new NioEventLoopGroup();
    
            try {
                ServerBootstrap serverBootstrap = new ServerBootstrap();
                serverBootstrap.group(bossGroup, workGroup)
                        .channel(NioServerSocketChannel.class)
                        .childHandler(new ChannelInitializer<SocketChannel>() {
                            @Override
                            protected void initChannel(SocketChannel socketChannel) throws Exception {
                                //outboundhandler一定要放在最后一个inboundhandler之前
                                //否则outboundhandler将不会执行到
                                socketChannel.pipeline().addLast(new EchoOutboundHandler3());
                                socketChannel.pipeline().addLast(new EchoOutboundHandler2());
                                socketChannel.pipeline().addLast(new EchoOutboundHandler1());
    
                                socketChannel.pipeline().addLast(new EchoInboundHandler1());
                                socketChannel.pipeline().addLast(new EchoInboundHandler2());
                                socketChannel.pipeline().addLast(new EchoInboundHandler3());
                            }
                        })
                        .option(ChannelOption.SO_BACKLOG, 10000)
                        .childOption(ChannelOption.SO_KEEPALIVE, true);
                System.out.println("EchoServer正在启动.");
    
                ChannelFuture channelFuture = serverBootstrap.bind(port).sync();
                System.out.println("EchoServer绑定端口" + port);
    
                channelFuture.channel().closeFuture().sync();
                System.out.println("EchoServer已关闭.");
            } catch (Exception e) {
                e.printStackTrace();
            } finally {
                bossGroup.shutdownGracefully();
                workGroup.shutdownGracefully();
            }
        }
    
        public static void main(String[] args) {
            int port = 8080;
            if (args != null && args.length > 0) {
                try {
                    port = Integer.parseInt(args[0]);
                } catch (Exception e) {
                    e.printStackTrace();
                }
            }
    
            EchoServer server = new EchoServer(port);
            server.run();
        }
    }

EchoInboundHandler1类：

package com.wisdlab.nettylab;
    
    import io.netty.buffer.ByteBuf;
    import io.netty.buffer.Unpooled;
    import io.netty.channel.ChannelHandlerContext;
    import io.netty.channel.ChannelInboundHandlerAdapter;
    import io.netty.util.CharsetUtil;
    
    /**
     * @ClassName EchoInboundHandler1
     * @Description TODO
     * @Author felix
     * @Date 2019/9/26 11:15
     * @Version 1.0
     **/
    public class EchoInboundHandler1 extends ChannelInboundHandlerAdapter {
        @Override
        public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
            System.out.println("进入 EchoInboundHandler1.channelRead");
    
            String data = ((ByteBuf)msg).toString(CharsetUtil.UTF_8);
            System.out.println("EchoInboundHandler1.channelRead 收到数据：" + data);
            ctx.fireChannelRead(Unpooled.copiedBuffer("[EchoInboundHandler1] " + data, CharsetUtil.UTF_8));
    
            System.out.println("退出 EchoInboundHandler1 channelRead");
        }
    
        @Override
        public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
            System.out.println("[EchoInboundHandler1.channelReadComplete]");
        }
    
        @Override
        public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
            System.out.println("[EchoInboundHandler1.exceptionCaught]" + cause.toString());
        }
    }

EchoInboundHandler2类：

package com.wisdlab.nettylab;
    
    import io.netty.buffer.ByteBuf;
    import io.netty.buffer.Unpooled;
    import io.netty.channel.ChannelHandlerContext;
    import io.netty.channel.ChannelInboundHandlerAdapter;
    import io.netty.util.CharsetUtil;
    
    /**
     * @ClassName EchoInboundHandler2
     * @Description TODO
     * @Author felix
     * @Date 2019/9/27 15:35
     * @Version 1.0
     **/
    public class EchoInboundHandler2 extends ChannelInboundHandlerAdapter {
        @Override
        public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
            System.out.println("进入 EchoInboundHandler2.channelRead");
    
            String data = ((ByteBuf) msg).toString(CharsetUtil.UTF_8);
            System.out.println("EchoInboundHandler2.channelRead 接收到数据：" + data);
            //ctx.writeAndFlush(Unpooled.copiedBuffer("[第一次write] [EchoInboundHandler2] " + data, CharsetUtil.UTF_8));
            ctx.channel().writeAndFlush(Unpooled.copiedBuffer("测试一下channel().writeAndFlush", CharsetUtil.UTF_8));
            ctx.fireChannelRead(Unpooled.copiedBuffer("[EchoInboundHandler2] " + data, CharsetUtil.UTF_8));
    
            System.out.println("退出 EchoInboundHandler2 channelRead");
        }
    
        @Override
        public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
            System.out.println("[EchoInboundHandler2.channelReadComplete]读取数据完成");
        }
    
        @Override
        public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
            System.out.println("[EchoInboundHandler2.exceptionCaught]");
        }
    }

EchoInboundHandler3类：

package com.wisdlab.nettylab;
    
    import io.netty.buffer.ByteBuf;
    import io.netty.buffer.Unpooled;
    import io.netty.channel.ChannelHandlerContext;
    import io.netty.channel.ChannelInboundHandlerAdapter;
    import io.netty.util.CharsetUtil;
    
    /**
     * @ClassName EchoInboundHandler3
     * @Description TODO
     * @Author felix
     * @Date 2019/10/23 13:43
     * @Version 1.0
     **/
    public class EchoInboundHandler3 extends ChannelInboundHandlerAdapter {
        @Override
        public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
            System.out.println("进入 EchoInboundHandler3.channelRead");
    
            String data = ((ByteBuf)msg).toString(CharsetUtil.UTF_8);
            System.out.println("EchoInboundHandler3.channelRead 接收到数据：" + data);
            //ctx.writeAndFlush(Unpooled.copiedBuffer("[第二次write] [EchoInboundHandler3] " + data, CharsetUtil.UTF_8));
            ctx.fireChannelRead(msg);
    
            System.out.println("退出 EchoInboundHandler3 channelRead");
        }
    
        @Override
        public void channelReadComplete(ChannelHandlerContext ctx) throws Exception {
            System.out.println("[EchoInboundHandler3.channelReadComplete]读取数据完成");
        }
    
        @Override
        public void exceptionCaught(ChannelHandlerContext ctx, Throwable cause) throws Exception {
            System.out.println("[EchoInboundHandler3.exceptionCaught]");
        }
    
    
    }

EchoOutboundHandler1类：

package com.wisdlab.nettylab;
    
    import io.netty.buffer.Unpooled;
    import io.netty.channel.ChannelHandlerContext;
    import io.netty.channel.ChannelOutboundHandlerAdapter;
    import io.netty.channel.ChannelPromise;
    import io.netty.util.CharsetUtil;
    
    /**
     * @ClassName EchoOutboundHandler1
     * @Description TODO
     * @Author felix
     * @Date 2019/9/27 15:36
     * @Version 1.0
     **/
    public class EchoOutboundHandler1 extends ChannelOutboundHandlerAdapter {
        @Override
        public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
            System.out.println("进入 EchoOutboundHandler1.write");
    
            //ctx.writeAndFlush(Unpooled.copiedBuffer("[第一次write中的write]", CharsetUtil.UTF_8));
            ctx.channel().writeAndFlush(Unpooled.copiedBuffer("在OutboundHandler里测试一下channel().writeAndFlush", CharsetUtil.UTF_8));
            ctx.write(msg);
    
            System.out.println("退出 EchoOutboundHandler1.write");
        }
    }

EchoOutboundHandler2类：

package com.wisdlab.nettylab;
    
    import io.netty.buffer.Unpooled;
    import io.netty.channel.ChannelHandlerContext;
    import io.netty.channel.ChannelOutboundHandlerAdapter;
    import io.netty.channel.ChannelPromise;
    import io.netty.util.CharsetUtil;
    
    /**
     * @ClassName EchoOutboundHandler2
     * @Description TODO
     * @Author felix
     * @Date 2019/9/27 15:36
     * @Version 1.0
     **/
    public class EchoOutboundHandler2 extends ChannelOutboundHandlerAdapter {
    
        @Override
        public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
            System.out.println("进入 EchoOutboundHandler2.write");
    
            //ctx.writeAndFlush(Unpooled.copiedBuffer("[第二次write中的write]", CharsetUtil.UTF_8));
            ctx.write(msg);
    
            System.out.println("退出 EchoOutboundHandler2.write");
        }
    }

EchoOutboundHandler3类：

package com.wisdlab.nettylab;
    
    import io.netty.channel.ChannelHandlerContext;
    import io.netty.channel.ChannelOutboundHandlerAdapter;
    import io.netty.channel.ChannelPromise;
    
    /**
     * @ClassName EchoOutboundHandler3
     * @Description TODO
     * @Author felix
     * @Date 2019/10/23 23:23
     * @Version 1.0
     **/
    public class EchoOutboundHandler3 extends ChannelOutboundHandlerAdapter {
        @Override
        public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
            System.out.println("进入 EchoOutboundHandler3.write");
    
            ctx.write(msg);
    
            System.out.println("退出 EchoOutboundHandler3.write");
        }
    
    }

### **实验一：在InboundHandler中不触发fire方法，后续的InboundHandler还能顺序执行吗？** ###

![format_png 1][]

如上图所示，InboundHandler2没有调用fire方法：

public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
            System.out.println("进入 EchoInboundHandler1.channelRead");
    
            String data = ((ByteBuf)msg).toString(CharsetUtil.UTF_8);
            System.out.println("EchoInboundHandler1.channelRead 收到数据：" + data);
            //ctx.fireChannelRead(Unpooled.copiedBuffer("[EchoInboundHandler1] " + data, CharsetUtil.UTF_8));
    
            System.out.println("退出 EchoInboundHandler1 channelRead");
        }

那么InboundHandler中的代码还会被执行到吗？看一下执行结果：

![format_png 2][]

由上图可知，InboundHandler2没有调用fire事件，InboundHandler3没有被执行。

**结论：InboundHandler是通过fire事件决定是否要执行下一个InboundHandler，如果哪个InboundHandler没有调用fire事件，那么往后的Pipeline就断掉了。**

### **实验二：InboundHandler和OutboundHandler的执行顺序是什么？** ###

![format_png 3][]

由上图可知，执行顺序为：

InboundHandler1 => InboundHandler2 => **OutboundHandler1 => OutboundHander2 => OutboundHandler3** => InboundHandler3

所以，我们得到以下几个结论：

**1、InboundHandler是按照Pipleline的加载顺序，顺序执行。**

**2、OutboundHandler是按照Pipeline的加载顺序，逆序执行。**

### **实验三：如果把OutboundHandler放在InboundHandler的后面，OutboundHandler会执行吗？** ###

执行结果如下：

![format_png 4][]

由此可见，OutboundHandler没有执行，为什么呢？因为Pipleline是执行完所有有效的InboundHandler，再返回执行在最后一个InboundHandler之前的OutboundHandler。注意，有效的InboundHandler是指fire事件触达到的InboundHandler，如果某个InboundHandler没有调用fire事件，后面的InboundHandler都是无效的InboundHandler。为了印证这一点，我们继续做一个实验，我们把其中一个OutboundHandler放在最后一个有效的InboundHandler之前，看看这唯一的一个OutboundHandler是否会执行，其他OutboundHandler是否不会执行。

![format_png 5][]

执行结果如下：

![format_png 6][]

由此可见，只执行了OutboundHandler1，其他OutboundHandler没有被执行。

所以，我们得到以下几个结论：

1、有效的InboundHandler是指通过fire事件能触达到的最后一个InboundHander。

2、如果想让所有的OutboundHandler都能被执行到，那么必须把OutboundHandler放在最后一个有效的InboundHandler之前。

3、推荐的做法是通过addFirst加载所有OutboundHandler，再通过addLast加载所有InboundHandler。

### **实验四：如果其中一个OutboundHandler没有执行write方法，那么消息会不会发送出去？** ###

我们把OutboundHandler2的write方法注掉

public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
            System.out.println("进入 EchoOutboundHandler3.write");
    
            //ctx.write(msg);
    
            System.out.println("退出 EchoOutboundHandler3.write");
        }

执行结果如下：

![format_png 7][]

可以看到，OutboundHandler3并没有被执行到，另外，客户端也没有收到发送的消息。

所以，我们得到以下几个结论：

**1、OutboundHandler是通过write方法实现Pipeline的串联的。**

**2、如果OutboundHandler在Pipeline的处理链上，其中一个OutboundHandler没有调用write方法，最终消息将不会发送出去。**

### **实验五：ctx.writeAndFlush 的OutboundHandler的执行顺序是什么？** ###

我们设定ChannelHandler在Pipeline中的加载顺序如下：

**OutboundHandler3 **=> InboundHandler1 => **OutboundHandler2 **=> InboundHandler2 => **OutboundHandler1 **=> InboundHandler3

![format_png 8][]

在InboundHander2中调用ctx.writeAndFlush：

public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
            System.out.println("进入 EchoInboundHandler2.channelRead");
    
            String data = ((ByteBuf) msg).toString(CharsetUtil.UTF_8);
            System.out.println("EchoInboundHandler2.channelRead 接收到数据：" + data);
            ctx.writeAndFlush(Unpooled.copiedBuffer("[第一次write] [EchoInboundHandler2] " + data, CharsetUtil.UTF_8));
            //ctx.channel().writeAndFlush(Unpooled.copiedBuffer("测试一下channel().writeAndFlush", CharsetUtil.UTF_8));
            ctx.fireChannelRead(Unpooled.copiedBuffer("[EchoInboundHandler2] " + data, CharsetUtil.UTF_8));
    
            System.out.println("退出 EchoInboundHandler2 channelRead");
        }

执行结果如下：

![format_png 9][]

由上图可知，依次执行了OutboundHandler2和OutboundHandler3，为什么会这样呢？因为ctx.writeAndFlush是从当前的ChannelHandler开始，向前依次执行OutboundHandler的write方法，所以分别执行了OutboundHandler2和OutboundHandler3：

**OutboundHandler3 **=> InboundHandler1 => **OutboundHandler2 **=> **InboundHandler2 **=> OutboundHandler1 => InboundHandler3

所以，我们得到如下结论：

**1、ctx.writeAndFlush是从当前ChannelHandler开始，逆序向前执行OutboundHandler。**

**2、ctx.writeAndFlush所在ChannelHandler后面的OutboundHandler将不会被执行。**

### **实验六：ctx.channel().writeAndFlush 的OutboundHandler的执行顺序是什么？** ###

还是实验五的代码，不同之处只是把ctx.writeAndFlush修改为ctx.channel().writeAndFlush。

public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception {
            System.out.println("进入 EchoInboundHandler2.channelRead");
    
            String data = ((ByteBuf) msg).toString(CharsetUtil.UTF_8);
            System.out.println("EchoInboundHandler2.channelRead 接收到数据：" + data);
            //ctx.writeAndFlush(Unpooled.copiedBuffer("[第一次write] [EchoInboundHandler2] " + data, CharsetUtil.UTF_8));
            ctx.channel().writeAndFlush(Unpooled.copiedBuffer("测试一下channel().writeAndFlush", CharsetUtil.UTF_8));
            ctx.fireChannelRead(Unpooled.copiedBuffer("[EchoInboundHandler2] " + data, CharsetUtil.UTF_8));
    
            System.out.println("退出 EchoInboundHandler2 channelRead");
        }

执行结果如下：

![format_png 10][]

由上图可知，所有OutboundHandler都执行了，由此我们得到结论：

**1、ctx.channel().writeAndFlush 是从最后一个OutboundHandler开始，依次逆序向前执行其他OutboundHandler，即使最后一个ChannelHandler是OutboundHandler，在InboundHandler之前，也会执行该OutbondHandler。**

**2、千万不要在OutboundHandler的write方法里执行ctx.channel().writeAndFlush，否则就死循环了。**

![format_png 11][]

##  **三、总结** ##

**1、InboundHandler是通过fire事件决定是否要执行下一个InboundHandler，如果哪个InboundHandler没有调用fire事件，那么往后的Pipeline就断掉了。  
2、InboundHandler是按照Pipleline的加载顺序，顺序执行。  
3、OutboundHandler是按照Pipeline的加载顺序，逆序执行。  
4、有效的InboundHandler是指通过fire事件能触达到的最后一个InboundHander。  
5、如果想让所有的OutboundHandler都能被执行到，那么必须把OutboundHandler放在最后一个有效的InboundHandler之前。  
6、推荐的做法是通过addFirst加载所有OutboundHandler，再通过addLast加载所有InboundHandler。  
7、OutboundHandler是通过write方法实现Pipeline的串联的。  
8、如果OutboundHandler在Pipeline的处理链上，其中一个OutboundHandler没有调用write方法，最终消息将不会发送出去。  
9、ctx.writeAndFlush是从当前ChannelHandler开始，逆序向前执行OutboundHandler。  
10、ctx.writeAndFlush所在ChannelHandler后面的OutboundHandler将不会被执行。  
11、ctx.channel().writeAndFlush 是从最后一个OutboundHandler开始，依次逆序向前执行其他OutboundHandler，即使最后一个ChannelHandler是OutboundHandler，在InboundHandler之前，也会执行该OutbondHandler。  
12、千万不要在OutboundHandler的write方法里执行ctx.channel().writeAndFlush，否则就死循环了。**

[format_png]: /images/20210720/67c12a3a646146d1b50a235f45bc5e0a.png
[format_png 1]: /images/20210720/2229799e691e46dfba70dcc605cf8cdf.png
[format_png 2]: /images/20210720/fda0bf5a2009493ba839c5a27c5d4833.png
[format_png 3]: /images/20210720/f831b5a64185425e9c5897b3299a3178.png
[format_png 4]: /images/20210720/4358dfbd16ee4d5dbec3f4fa904e85a3.png
[format_png 5]: /images/20210720/90e259b087ce4fe6a5f758c4c7546d23.png
[format_png 6]: /images/20210720/c224d2a240494eb1b696e5777f3696e6.png
[format_png 7]: /images/20210720/caf581d84f334024bf2f9584d200b97f.png
[format_png 8]: /images/20210720/9629fb3ef89d487891dd4ebd536d20ee.png
[format_png 9]: /images/20210720/532c562c9ddd4a0f84a8bd5db98eff03.png
[format_png 10]: /images/20210720/b853998c929c453bbdcd86d7f75e3154.png
[format_png 11]: /images/20210720/495ff06b81cb4d4e9b61664309a91c43.png