Netty(7)-构建pipeline、channelHandler、Decoder和Encoder

àì夳堔傛蜴生んèń 2023-07-04 14:17 15阅读 0赞

### 文章目录 ###

*   *   *  一.pipeline和channelHandler
         *   *  1.channelHandler的分类
             *   *  1.ChannelInboundHandler
                 *  2.ChannelOutBoundHandler
             *  2.channelHandler的事件传播
             *  3.pipeline的结构与channelHandler的执行顺序
         *  二.构建客户端和服务端的pipeline与Decoder和Encoder
         *   *  1.ChannelInboundHandlerAdapter 与 ChannelOutboundHandlerAdapter
             *  2.Decoder与Encoder
             *   *  1.PacketDecoder
                 *  2.PacketEncoder
             *  3.SimpleChannelInboundHandler

### 一.pipeline和channelHandler ###

使用pipeline，把复杂的逻辑从单独的一个 channelHandler 中抽取出来，pipeline构造成一个双向链表将一个个channelHandler串联起来，形成逻辑处理责任链，每个hanlder只负责处理各自的协议包：

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BicmxvdmVqYXZh_size_16_color_FFFFFF_t_70]

#### 1.channelHandler的分类 ####

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BicmxvdmVqYXZh_size_16_color_FFFFFF_t_70 1]  
ChannelHandler 有两大子接口：

##### 1.ChannelInboundHandler #####

ChannelInboundHandler用以处理读数据的逻辑，比如，我们在一端读到一段数据，首先要解析这段数据，然后对这些数据做一系列逻辑处理，最终把响应写到对端， 在开始组装响应之前的所有的逻辑，都可以放置在 ChannelInboundHandler 里处理，它的一个最重要的方法就是 channelRead()。

##### 2.ChannelOutBoundHandler #####

ChannelOutBoundHandler处理写数据的逻辑，它是定义我们一端在组装完响应之后，把数据写到对端的逻辑，比如，我们封装好一个 response 对象，接下来我们有可能对这个 response 做一些其他的特殊逻辑，然后，再编码成 ByteBuf，最终写到对端，它里面最核心的一个方法就是 write()。

这两个子接口分别有对应的默认实现，ChannelInboundHandlerAdapter，和 ChanneloutBoundHandlerAdapter，它们分别实现了两大接口的所有功能，默认情况下会把读写事件传播到下一个 handler。

#### 2.channelHandler的事件传播 ####

在服务端的 pipeline 添加三个 ChannelInboundHandler

*  NettyServer

serverBootstrap
            .childHandler(new ChannelInitializer<NioSocketChannel>() {
                protected void initChannel(NioSocketChannel ch) {
                    // inBound，处理读数据的逻辑链
                    ch.pipeline().addLast(new InBoundHandlerA());
                    ch.pipeline().addLast(new InBoundHandlerB());
                    ch.pipeline().addLast(new InBoundHandlerC());
                    
                    // outBound，处理写数据的逻辑链
                    ch.pipeline().addLast(new OutBoundHandlerA());
                    ch.pipeline().addLast(new OutBoundHandlerB());
                    ch.pipeline().addLast(new OutBoundHandlerC());
                }
            });

*  InBoundHandler

public class InBoundHandlerA extends ChannelInboundHandlerAdapter { 
        @Override
        public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception { 
            System.out.println("InBoundHandlerA: " + msg);
            super.channelRead(ctx, msg);
        }
    }
    
    public class InBoundHandlerB extends ChannelInboundHandlerAdapter { 
        @Override
        public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception { 
            System.out.println("InBoundHandlerB: " + msg);
            super.channelRead(ctx, msg);
        }
    }
    
    public class InBoundHandlerC extends ChannelInboundHandlerAdapter { 
        @Override
        public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception { 
            System.out.println("InBoundHandlerC: " + msg);
            super.channelRead(ctx, msg);
        }
    }

*  OutBounddHandler

public class OutBoundHandlerA extends ChannelOutboundHandlerAdapter {
        @Override
        public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
            System.out.println("OutBoundHandlerA: " + msg);
            super.write(ctx, msg, promise);
        }
    }
    
    public class OutBoundHandlerB extends ChannelOutboundHandlerAdapter {
        @Override
        public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
            System.out.println("OutBoundHandlerB: " + msg);
            super.write(ctx, msg, promise);
        }
    }
    
    public class OutBoundHandlerC extends ChannelOutboundHandlerAdapter {
        public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception {
            System.out.println("OutBoundHandlerC: " + msg);
            super.write(ctx, msg, promise);
        }
    }

执行程序

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BicmxvdmVqYXZh_size_16_color_FFFFFF_t_70 2]

可以看到，inBoundHandler的执行顺序与我们添加的顺序相同，而outBoundHandler的执行顺序与我们添加的顺序相反。

#### 3.pipeline的结构与channelHandler的执行顺序 ####

1.  pipeline结构  
    ![在这里插入图片描述][202002112205436.png]
2.  channelHandler执行顺序  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BicmxvdmVqYXZh_size_16_color_FFFFFF_t_70 3]

### 二.构建客户端和服务端的pipeline与Decoder和Encoder ###

Netty 内置了很多开箱即用的 ChannelHandler。下面，我们通过学习 Netty 内置的 ChannelHandler 来逐步构建我们的 pipeline。

#### 1.ChannelInboundHandlerAdapter 与 ChannelOutboundHandlerAdapter ####

首先是 ChannelInboundHandlerAdapter ，这个适配器主要用于实现其接口 ChannelInboundHandler 的所有方法，这样我们在编写自己的 handler 的时候就不需要实现 handler 里面的每一种方法，而只需要实现我们所关心的方法，默认情况下，对于 ChannelInboundHandlerAdapter，我们比较关心的是他的如下方法

*  ChannelInboundHandlerAdapter

@Override
    public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception { 
        ctx.fireChannelRead(msg);
    }

他的作用就是接收上一个 handler 的输出，这里的 msg 就是上一个 handler 的输出。大家也可以看到，默认情况下 adapter 会通过 fireChannelRead() 方法直接把上一个 handler 的输出结果传递到下一个 handler。(责任链模式)

与 ChannelInboundHandlerAdapter 类似的类是 ChannelOutboundHandlerAdapter，它的核心方法如下

*  ChannelOutboundHandlerAdapter

@Override
    public void write(ChannelHandlerContext ctx, Object msg, ChannelPromise promise) throws Exception { 
        ctx.write(msg, promise);
    }

默认情况下，这个 adapter 也会把对象传递到下一个 outBound 节点，它的传播顺序与 inboundHandler 相反，这里就不再对这个类展开了。

#### 2.Decoder与Encoder ####

##### 1.PacketDecoder #####

通常情况下，无论我们是在客户端还是服务端，当我们收到数据之后，首先要做的事情就是把二进制数据转换到我们的一个 Java 对象，所以 Netty 很贴心地写了一个父类，来专门做这个事情，下面我们来看一下，如何使用这个类来实现服务端的解码

public class PacketDecoder extends ByteToMessageDecoder { 
    
        @Override
        protected void decode(ChannelHandlerContext ctx, ByteBuf in, List out) { 
            out.add(PacketCodeC.INSTANCE.decode(in));
        }
    }

当我们继承了 ByteToMessageDecoder 这个类之后，我们只需要实现一下 decode() 方法，这里的 in 大家可以看到，传递进来的时候就已经是 ByteBuf 类型，所以我们不再需要强转，第三个参数是 List 类型，我们通过往这个 List 里面添加解码后的结果对象，就可以自动实现结果往下一个 handler 进行传递，这样，我们就实现了解码的逻辑 handler。

另外，值得注意的一点，对于 Netty 里面的 ByteBuf，我们使用 4.1.6.Final 版本，默认情况下用的是堆外内存，在 ByteBuf 这一小节中我们提到，堆外内存我们需要自行释放，在我们前面小节的解码的例子中，其实我们已经漏掉了这个操作，这一点是非常致命的，随着程序运行越来越久，内存泄露的问题就慢慢暴露出来了， 而这里我们使用 ByteToMessageDecoder，Netty 会自动进行内存的释放

当我们通过解码器把二进制数据转换到 Java 对象即指令数据包之后，就可以针对每一种指令数据包编写逻辑了。

##### 2.PacketEncoder #####

处理完请求之后，我们都会给客户端一个响应，在写响应之前，我们需要把响应对象编码成 ByteBuf。

*  LoginRequestHandler

public class LoginRequestHandler extends SimpleChannelInboundHandler<LoginRequestPacket> { 
        @Override
        protected void channelRead0(ChannelHandlerContext ctx, LoginRequestPacket loginRequestPacket) { 
            LoginResponsePacket loginResponsePacket = login(loginRequestPacket);
            ByteBuf responseByteBuf = PacketCodeC.INSTANCE.encode(ctx.alloc(), loginResponsePacket);
            ctx.channel().writeAndFlush(responseByteBuf);
        }
    }

*  MessageRequestHandler

public class MessageRequestHandler extends SimpleChannelInboundHandler<MessageRequestPacket> { 
        @Override
        protected void channelRead0(ChannelHandlerContext ctx, MessageRequestPacket messageRequestPacket) { 
            MessageResponsePacket messageResponsePacket = receiveMessage(messageRequestPacket);
            ByteBuf responseByteBuf = PacketCodeC.INSTANCE.encode(ctx.alloc(), messageRequestPacket);
            ctx.channel().writeAndFlush(responseByteBuf);
        }
    }

我们注意到，我们处理每一种指令完成之后的逻辑是类似的，都需要进行编码，然后调用 writeAndFlush() 将数据写到客户端，这个编码的过程其实也是重复的逻辑，而且在编码的过程中，我们还需要手动去创建一个 ByteBuf，如下过程

*  PacketUtil.java

public ByteBuf encode(ByteBufAllocator byteBufAllocator, Packet packet) { 
        // 1. 创建 ByteBuf 对象
        ByteBuf byteBuf = byteBufAllocator.ioBuffer();
        // 2. 序列化 java 对象
    
        // 3. 实际编码过程
    
        return byteBuf;
    }

而Netty 提供了一个特殊的 channelHandler 来专门处理编码逻辑，我们不需要每一次将响应写到对端的时候调用一次编码逻辑进行编码，也不需要自行创建 ByteBuf，这个类叫做 MessageToByteEncoder，从字面意思也可以看出，它的功能就是将对象转换到二进制数据。

*  PacketEncoder

public class PacketEncoder extends MessageToByteEncoder<Packet> { 
    
        @Override
        protected void encode(ChannelHandlerContext ctx, Packet packet, ByteBuf out) { 
            PacketUtil.INSTANCE.encode(out, packet);
        }
    }

*  PackageUtil

/** * @Auther: ARong * @Date: 2020/2/4 9:14 下午 * @Description: 用于包编码和解码 */
    public class PacketUtil { 
    
        // 饿汉单例模式
        public static PacketUtil INSTANCE = new PacketUtil();
    
        private PacketUtil(){ }
        /* * @Author ARong * @Description 将packet编码为byteBuf * @Date 2020/2/9 9:04 下午 * @Param [byteBuf, packet] * @return void **/
        public void encode(ByteBuf byteBuf, Packet packet) { 
            // 获取序列化器序列化对象
            MySerializer serializer = SerializerFactory.getSerializer(packet.getSerMethod());
            byte[] data = serializer.serialize(packet);
            // 按照通信协议填充ByteBUf
            byteBuf.writeInt(packet.getMagic());// 魔数
            byteBuf.writeByte(packet.getVersion()); // 版本号
            byteBuf.writeByte(packet.getSerMethod()); // 序列化方式
            byteBuf.writeByte(packet.getCommand()); // 指令
            byteBuf.writeInt(data.length);// 数据长度
            byteBuf.writeBytes(data); // 数据
        }
    
        /* * @Author ARong * @Description 将ByteBuf按照约定序列化方式解码成Packet * @Date 2020/2/4 9:21 下午 * @Param [byteBuf] * @return io_learn.netty.part4_protocol.packet.Packet **/
        public Packet decode(ByteBuf byteBuf) { 
            // 暂不判断魔数，跳过
            byteBuf.skipBytes(4);
            // 暂不判断魔数版本号，跳过
            byteBuf.skipBytes(1);
            // 获取序列化方式
            byte serMethod = byteBuf.readByte();
            // 获取指令
            byte command = byteBuf.readByte();
            // 获取数据包长度
            int length = byteBuf.readInt();
            // 获取存储数据的字节数组
            byte[] data = new byte[length];
            byteBuf.readBytes(data);
            // 反序列化数据，获取Packet
            Class<? extends Packet> packetType = getPacketType(command);
            Packet res = SerializerFactory.getSerializer(serMethod).deserialize(packetType, data);
            return res;
        }
    
    
        /* * @Author ARong * @Description 通过指令获取相应的Packet * @Date 2020/2/4 9:31 下午 * @Param [commond] * @return io_learn.netty.part4_protocol.packet.Packet **/
        public static Class<? extends Packet> getPacketType(byte commond) { 
            if (commond == Command.LOGIN_REQUEST) { 
                return LoginRequestPacket.class;
            }
            if (commond == Command.LOGIN_RESPONSE) { 
                return LoginResponsePacket.class;
            }
            if (commond == Command.MESSAGE_REQUEST) { 
                return MessageRequestPacket.class;
            }
            if (commond == Command.MESSAGE_RESPONSE) { 
                return MessageResponsePacket.class;
            }
            return null;
        }
    }

之后就可以这样使用，而无需再次编码了：

#### 3.SimpleChannelInboundHandler ####

回顾一下我们前面处理 Java 对象的逻辑

if (packet instanceof LoginRequestPacket) { 
        // ...
    } else if (packet instanceof MessageRequestPacket) { 
        // ...
    } else if ...

我们通过 if else 逻辑进行逻辑的处理，当我们要处理的指令越来越多的时候，代码会显得越来越臃肿，我们可以通过给 pipeline 添加多个 handler(ChannelInboundHandlerAdapter的子类) 来解决过多的 if else 问题，如下

*  XXXHandler.java

if (packet instanceof XXXPacket) { 
        // ...处理
    } else { 
        // 责任链模式
       ctx.fireChannelRead(packet); 
    }

这样一个好处就是，每次添加一个指令处理器，逻辑处理的框架都是一致的，

但是，大家应该也注意到了，这里我们编写指令处理 handler 的时候，依然编写了一段我们其实可以不用关心的 if else 判断，然后还要手动传递无法处理的对象 (XXXPacket) 至下一个指令处理器，这也是一段重复度极高的代码，因此，Netty 基于这种考虑抽象出了一个 SimpleChannelInboundHandler 对象，类型判断和对象传递的活都自动帮我们实现了，而我们可以专注于处理我们所关心的指令即可。

下面，我们来看一下如何使用 SimpleChannelInboundHandler 来简化我们的指令处理逻辑

*  LoginRequestHandler

SimpleChannelInboundHandler 从字面意思也可以看到，使用它非常简单，我们在继承这个类的时候，给他传递一个泛型参数，然后在 channelRead0() 方法里面，我们不用再通过 if 逻辑来判断当前对象是否是本 handler 可以处理的对象，也不用强转，不用往下传递本 handler 处理不了的对象，这一切都已经交给父类 SimpleChannelInboundHandler 来实现了，我们只需要专注于我们要处理的业务逻辑即可。

是用来处理登录的逻辑，同理，我们可以很轻松地编写一个消息处理逻辑处理器

*  MessageRequestHandler

对应我们的代码

*  NettyServer

serverBootstrap
                   .childHandler(new ChannelInitializer<NioSocketChannel>() { 
                        protected void initChannel(NioSocketChannel ch) { 
                            ch.pipeline().addLast(new PacketDecoder());
                            ch.pipeline().addLast(new LoginRequestHandler());
                            ch.pipeline().addLast(new MessageRequestHandler());
                            ch.pipeline().addLast(new PacketEncoder());
                        }
                });

客户端

*  NettyClient

bootstrap
            .handler(new ChannelInitializer<SocketChannel>() { 
                @Override
                public void initChannel(SocketChannel ch) { 
                    ch.pipeline().addLast(new PacketDecoder());
                    ch.pipeline().addLast(new LoginResponseHandler());
                    ch.pipeline().addLast(new MessageResponseHandler());
                    ch.pipeline().addLast(new PacketEncoder());
                }
            });

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BicmxvdmVqYXZh_size_16_color_FFFFFF_t_70]: https://img-blog.csdnimg.cn/20200211220504463.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BicmxvdmVqYXZh,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BicmxvdmVqYXZh_size_16_color_FFFFFF_t_70 1]: https://img-blog.csdnimg.cn/20200211220514299.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BicmxvdmVqYXZh,size_16,color_FFFFFF,t_70
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BicmxvdmVqYXZh_size_16_color_FFFFFF_t_70 2]: https://img-blog.csdnimg.cn/20200211220531946.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BicmxvdmVqYXZh,size_16,color_FFFFFF,t_70
[202002112205436.png]: https://img-blog.csdnimg.cn/202002112205436.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BicmxvdmVqYXZh_size_16_color_FFFFFF_t_70 3]: https://img-blog.csdnimg.cn/20200211220553808.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3BicmxvdmVqYXZh,size_16,color_FFFFFF,t_70