Netty学习笔记(七)--- Codec框架_bytetomessagedecoder 和 messagetomessagedecoder-程序员宅基地

技术标签: Netty  

我们知道,在网络中数据都是以字节码的形式来进行传输的,每个网络应用程序都必须定义如何解析在两个节点之间来回传输的原始字节码,以及如何将其和目标应用程序的数据格式做相互转换。编解码器就是用来处理这种逻辑的,它由编码器和解码器两个组件组成,其中编码器负责将消息转换为适合传输的格式,解码器则负责将网络字节流转换回应用程序的消息格式。

Netty提供了编解码器框架,使得编写自定义的编解码器很容易,并且也很容易重用和封装。它提供了一系列实现这两种组件的类,查看这些类的源码会发现:编码器继承自ChannelOutboundHandlerAdapter类,而解码器继承自ChannelInboundHandlerAdapter类,算是ChannelHandler的一种特殊实现,因此我们可以像添加ChannelHandler一样,将多个编解码器链接在一起,以实现自定义的任意负责转换逻辑。下面就分别对两种组件的类进行了解。

解码器

上面也提到了,解码器是ChannelInboundHandlerAdapter的子类,所以它负责将进站消息从一种格式转换为另一种格式,它包括了两种类型:

  • 解码字节到消息:ByteToMessageDecoder;
  • 解码消息到消息:MessageToMessageDecoder。
ByteToMessageDecoder类

通常我们需要将字节解码成消息或者解码成其他的序列化字节,Netty为此提供了一个抽象基类:ByteToMessageDecoder。它提供了两个重要方法,我们可以通过继承它并重写这两个方法,实现符合自身需求的解码逻辑。

/* 
这是你必须实现的唯一抽象方法。decode()方法被调用时将会传入一个包含了传入数据的ByteBuf,以及一个用来添加解码消息的List。对这个方法的调用将会重复进行,直到确定没有新的元素被添加到该List,或者该 ByteBuf中没有更多可读取的字节时为止。然后,如果该List不为空,那么它的内容将会被传递给ChannelPipeline中的下一个ChannelInboundHandler。
*/
protected abstract void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out)
/*
Netty提供的这个默认实现只是简单地调用了decode()方法。当Channel的状态变为非活动时,这个方法将会被调用一次。可以重写该方法以提供特殊的处理。
*/
protected void decodeLast(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) {
    
    decode(ctx, in, out);
}

假设服务端接收了一个包含简单int的字节流,每个int都需要被单独处理。在这种情况下,你需要从入站 ByteBuf中读取每个int,并将它传递给ChannelPipeline 中的下一个 ChannelInboundHandler。为了解码这个字节流,我们就要扩展ByteToMessageDecoder 类。

// 扩展ByteToMessageDecoder类,重写decode()方法,以将字节解码为特定的格式
public class ToIntegerDecoder extends ByteToMessageDecoder{
    
    @Override
    protected void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception {
    
        // 检查ByteBuf中是否存在4个以上的字节可读
        if (in.readableBytes() >= 4){
    
            // 从入站ByteBuf中读取一个int,并将其添加到解码消息的List中
            out.add(in.readInt());
        }
    }
}

在这里插入图片描述

上面的代码中,我们通过继承ByteToMessageDecoder类并重写decode方法,实现了自定义的解码器类:ToIntegerDecoder。它的主要功能是从进站ByteBuf中读取字节并解码为int类型的数据。上图展示了解码器处理数据,然后将解码后的消息传递到ChannelPipeline中的下一个ChannelInboundHandler的过程。

你可能会发现,在调用 readInt()方法前不得不验证所输入的 ByteBuf 是否具有足够的数据有点繁琐。其实Netty提供了另外一个特殊的解码器:ReplayingDecoder。它继承并扩展了ByteToMessageDecoder类,它通过使用一个自定义的ByteBuf实现:ReplayingDecoderByteBuf,包装传入的ByteBuf实现了这一点,其将在内部执行该调用,这样我们就可以不用显式的对其进行验证了。

这里有一个简单的准则:如果使用 ByteToMessageDecoder 不会引入太多的复杂性,那么请使用它;否则,请使用 ReplayingDecoder。

MessageToMessageDecoder类

上面的解码器将字节数据解码为int类型的数据,现在我们需要将这些int类型的数据转换为字符串,这就需要用到将一种消息对象转换为另一种消息对象的解码器:MessageToMessageDecoder。该类是一个抽象类,我们需要继承它并实现自己的解码逻辑。

// 扩展MessageToMessageDecoder类,重写decode()方法,以将消息解码为特定的格式的消息
public class IntegerToStringDecoder extends MessageToMessageDecoder<Integer>{
    
    @override
    protected void decode(ChannelHandlerContext ctx, Integer msg, List<Object> out) throws Exception{
    
        // 将消息转换为字符串,并将其添加到解码消息的List中
        out.add(String.valueOf(msg));
    }
}

在这里插入图片描述
通过上面的代码,就可以将int类型的数据转换为String类型,并将其添加到解码消息的List中,通过ChannelHandlerContext流转到后续的ChannelHandler中。

编码器

和解码器正好相反,编码器继承自ChannelOutboundHandlerAdapter,它负责将出站数据从一种格式转换为另一种格式。它也提供了两种抽象类:

  • 将消息编码为消息:MessageToMessageEncoder;
  • 将消息编码为字节:MessageToByteEncoder。
MessageToMessageEncoder类

上面的IntegerToStringDecoder类将int类型的数据转换为String类型数据,现在将该数据通过编码器再次转换为int类型数据(当然也可以通过解码器进行转换),这里我们通过继承MessageToMessageEncoder类实现。

// 扩展MessageToMessageEncoder类,重写encode()方法,以将消息编码为特定的格式的消息
public class StringToIntegerEncoder extends MessageToMessageEncoder<String> {
    
    @Override
    protected void encode(ChannelHandlerContext ctx, String msg, List<Object> out) throws Exception {
    
        // 将字符串数据解析为int类型数据,并添加到编码消息的list中
        out.add(Integer.parseInt(msg));
    }
}
MessageToByteEncoder类

StringToIntegerEncoder将字符串编码为int类型后,数据继续向下传递,我们再次进行再次编码,将int类型的数据编码为字节数据,这里我们通过继承MessageToByteEncoder类来实现。

// 扩展MessageToByteEncoder类,重写encode()方法,以将消息编码为字节类型
public class IntegerToByteEncoder extends MessageToByteEncoder<Integer>{
    
    @Override
    protected void encode(ChannelHandlerContext ctx, Integer msg, ByteBuf out) throws Exception {
    
        // 将int类型的数据写入到ByteBuf中,ByteBuf中数据以字节形式存在
        out.writeInt(msg);
    }
}

通过两个编码器的实现,最终会将字符串类型的数据转换为字节数据,实现了和解码器完全相反的逆操作。

你可能已经注意到了,编码器的类只有一个encode()方法,而解码器有decode()和decodeLast()方法。原因是解码器通常需要在Channel 关闭之后产生最后一个消息,因此也就有了 decodeLast()方法。这显然不适用于编码器的场景——在连接被关闭之后仍然产生一个消息是毫无意义的。

编解码器

我们在编码的过程中,总是将不同功能的组件写入到不同的模块中,以提高代码的可重用性和可扩展性,这也是Netty设计的一个基本原则。就像上面的解码器和编码器,我们把它们当作单独的组件进行讨论,但有时可能将二者结合起来处理数据也很有用,Netty的抽象编解码类正好就是用于这个目的。

ByteToMessageCodec类

ByteToMessageCodec既能处理解码进站数据,也能编码出站数据,因为它结合了ByteToMessageDecoder 以及它的逆向:MessageToByteEncoder。查看源码可看出,它最终同时实现了ChannelInboundHandler和ChannelOutboundHandler两个接口,其内部包裹了MessageToByteEncoder和ByteToMessageDecoder的实现类。

public abstract class ByteToMessageCodec<I> extends ChannelDuplexHandler {
    
    ......
    // 调用内部类实现赋值
    private final MessageToByteEncoder<I> encoder;

    private final ByteToMessageDecoder decoder = new ByteToMessageDecoder() {
    
        @Override
        public void decode(...){
    ...}
        @Override
        protected void decodeLast(...){
    ...}
    };
   	......
}
MessageToMessageCodec类

和上面的编解码器类似的,MessageToMessageCodec可以看成是MessageToMessageeEncoder和MessageTomessageDecoder的组合体,它有两个方法需要我们实现。

// 将OUTBOUND_IN类型的消息编码为INBOUND_IN类型的消息,这些消息将被转发到下一个OutBoundHandler
protected abstract void encode(ChannelHandlerContext ctx, OUTBOUND_IN msg, List<Object> out);
// 将INBOUND_IN类型的消息解码为OUTBOUND_IN类型的消息,这些消息将被转发到下一个InBoundHandler
protected abstract void decode(ChannelHandlerContext ctx, INBOUND_IN msg, List<Object> out)
    

它最常见的就是需要将消息从一个API转到另一个API,下面的代码显示了在WebSocket框架APIs之间的消息转换,其中INBOUND_IN类型为WebSocketFrame,OUTBOUND_IN类型为MyWebSocketFrame,后者是编解码器本身的一个静态嵌套类。

public class WebSocketConvertHandler extends MessageToMessageCodec<WebSocketFrame,WebSocketConvertHandler.MyWebSocketFrame>{
    
    @Override
    // 将MyWebSocketFrame编码为指定的WebSocketFrame子类型
    protected void encode(ChannelHandlerContext ctx, WebSocketConvertHandler.MyWebSocketFrame msg, List<Object> out) throws Exception {
    
        ByteBuf payload = msg.getData().duplicate().retain();
        switch (msg.getType()){
    
            case BINARY:
                out.add(new BinaryWebSocketFrame(payload));
                break;
            case TEXT:
                out.add(new TextWebSocketFrame(payload));
                break;
            case CLOSE:
                out.add(new CloseWebSocketFrame(true, 0, payload));
                break;
            case CONTINUATION:
                out.add(new ContinuationWebSocketFrame(payload));
                break;
            case PING:
                out.add(new PingWebSocketFrame(payload));
                break;
            case PONG:
                out.add(new PongWebSocketFrame(payload));
                break;
            default:
                throw new IllegalStateException("Unsupported websocket msg " + msg);
        }
    }
	
    @Override
    // 将WebSocketFrame解码为MyWebSocketFrame类型
    protected void decode(ChannelHandlerContext ctx, WebSocketFrame msg, List<Object> out) throws Exception {
    
        ByteBuf payload = msg.content().duplicate().retain();
        if (msg instanceof BinaryWebSocketFrame)
            out.add(new MyWebSocketFrame(MyWebSocketFrame.FrameType.BINARY, payload));
        else if(msg instanceof CloseWebSocketFrame)
            out.add(new MyWebSocketFrame(MyWebSocketFrame.FrameType.CLOSE, payload));
        else if (msg instanceof PingWebSocketFrame)
            out.add(new MyWebSocketFrame(MyWebSocketFrame.FrameType.PING, payload));
        else if (msg instanceof PongWebSocketFrame)
            out.add(new MyWebSocketFrame(MyWebSocketFrame.FrameType.PONG, payload));
        else if (msg instanceof TextWebSocketFrame)
            out.add(new MyWebSocketFrame(MyWebSocketFrame.FrameType.TEXT, payload));
        else if (msg instanceof ContinuationWebSocketFrame)
            out.add(new MyWebSocketFrame(MyWebSocketFrame.FrameType.CONTINUATION, payload));
        else
            throw new IllegalStateException("Unsupported websocket msg " + msg);
    }

    public static final class MyWebSocketFrame{
    
        public enum FrameType{
    
            BINARY,
           	CLOSE,
            PING,
            PONG,
            TEXT,
            CONTINUATION
        }

        private final FrameType type;
        private final ByteBuf data;

        public MyWebSocketFrame(FrameType type, ByteBuf data){
    
            this.data = data;
            this.type = type;
        }

        public FrameType getType() {
    
            return type;
        }

        public ByteBuf getData() {
    
            return data;
        }
    }
}
CombinedChannelDuplexHandler类

上面的案例中,同一个类中既包含了解码器也包含了编码器,这时就出现了一个问题,如果我只想使用其中的编码器或者解码器,就只能再单独实现一个处理类,其可重用性就大大降低了。Netty提供了一种解决方案,就是使用CombinedChannelDuplexHandler。

public class CombinedChannelDuplexHandler<I extends ChannelInboundHandler, O extends ChannelOutboundHandler> extends ChannelDuplexHandler {
    
    private I inboundHandler;
    private O outboundHandler;
   	... 
}

它充当了 ChannelInboundHandler 和 ChannelOutboundHandler(该类的类型参数 I 和 O)的容器,通过提供分别继承了解码器类和编码器类的类型,我们可以实现一个编解码器,而又不必直接扩展抽象的编解码器类。

通过上面编写的解码器和编码器,我们可以将它们组合起来构建一个编解码器:

public class CombinedByteIntegerCodec extends CombinedChannelDuplexHandler<ByteToIntegerDecoder,IntegerToByteEncoder>{
    
    public CombinedByteIntegerCodec(){
    
        super(new ByteToIntegerDecoder(), new IntegerToByteEncoder());
    }
}

从上面代码可以看出,使用CombinedChannelDuplexHandler绑定解码器和编码器很容易实现,和上面的两种编解码器相比,使用更加简单灵活,提高了代码的可重用性。

版权声明:本文为博主原创文章,遵循 CC 4.0 BY-SA 版权协议,转载请附上原文出处链接和本声明。
本文链接:https://blog.csdn.net/Lincain/article/details/90633694

智能推荐

攻防世界_难度8_happy_puzzle_攻防世界困难模式攻略图文-程序员宅基地

文章浏览阅读645次。这个肯定是末尾的IDAT了,因为IDAT必须要满了才会开始一下个IDAT,这个明显就是末尾的IDAT了。,对应下面的create_head()代码。,对应下面的create_tail()代码。不要考虑爆破,我已经试了一下,太多情况了。题目来源:UNCTF。_攻防世界困难模式攻略图文

达梦数据库的导出(备份)、导入_达梦数据库导入导出-程序员宅基地

文章浏览阅读2.9k次,点赞3次,收藏10次。偶尔会用到,记录、分享。1. 数据库导出1.1 切换到dmdba用户su - dmdba1.2 进入达梦数据库安装路径的bin目录,执行导库操作  导出语句:./dexp cwy_init/[email protected]:5236 file=cwy_init.dmp log=cwy_init_exp.log 注释:   cwy_init/init_123..._达梦数据库导入导出

js引入kindeditor富文本编辑器的使用_kindeditor.js-程序员宅基地

文章浏览阅读1.9k次。1. 在官网上下载KindEditor文件,可以删掉不需要要到的jsp,asp,asp.net和php文件夹。接着把文件夹放到项目文件目录下。2. 修改html文件,在页面引入js文件:<script type="text/javascript" src="./kindeditor/kindeditor-all.js"></script><script type="text/javascript" src="./kindeditor/lang/zh-CN.js"_kindeditor.js

STM32学习过程记录11——基于STM32G431CBU6硬件SPI+DMA的高效WS2812B控制方法-程序员宅基地

文章浏览阅读2.3k次,点赞6次,收藏14次。SPI的详情简介不必赘述。假设我们通过SPI发送0xAA,我们的数据线就会变为10101010,通过修改不同的内容,即可修改SPI中0和1的持续时间。比如0xF0即为前半周期为高电平,后半周期为低电平的状态。在SPI的通信模式中,CPHA配置会影响该实验,下图展示了不同采样位置的SPI时序图[1]。CPOL = 0,CPHA = 1:CLK空闲状态 = 低电平,数据在下降沿采样,并在上升沿移出CPOL = 0,CPHA = 0:CLK空闲状态 = 低电平,数据在上升沿采样,并在下降沿移出。_stm32g431cbu6

计算机网络-数据链路层_接收方收到链路层数据后,使用crc检验后,余数为0,说明链路层的传输时可靠传输-程序员宅基地

文章浏览阅读1.2k次,点赞2次,收藏8次。数据链路层习题自测问题1.数据链路(即逻辑链路)与链路(即物理链路)有何区别?“电路接通了”与”数据链路接通了”的区别何在?2.数据链路层中的链路控制包括哪些功能?试讨论数据链路层做成可靠的链路层有哪些优点和缺点。3.网络适配器的作用是什么?网络适配器工作在哪一层?4.数据链路层的三个基本问题(帧定界、透明传输和差错检测)为什么都必须加以解决?5.如果在数据链路层不进行帧定界,会发生什么问题?6.PPP协议的主要特点是什么?为什么PPP不使用帧的编号?PPP适用于什么情况?为什么PPP协议不_接收方收到链路层数据后,使用crc检验后,余数为0,说明链路层的传输时可靠传输

软件测试工程师移民加拿大_无证移民,未受过软件工程师的教育(第1部分)-程序员宅基地

文章浏览阅读587次。软件测试工程师移民加拿大 无证移民,未受过软件工程师的教育(第1部分) (Undocumented Immigrant With No Education to Software Engineer(Part 1))Before I start, I want you to please bear with me on the way I write, I have very little gen...

随便推点

Thinkpad X250 secure boot failed 启动失败问题解决_安装完系统提示secureboot failure-程序员宅基地

文章浏览阅读304次。Thinkpad X250笔记本电脑,装的是FreeBSD,进入BIOS修改虚拟化配置(其后可能是误设置了安全开机),保存退出后系统无法启动,显示:secure boot failed ,把自己惊出一身冷汗,因为这台笔记本刚好还没开始做备份.....根据错误提示,到bios里面去找相关配置,在Security里面找到了Secure Boot选项,发现果然被设置为Enabled,将其修改为Disabled ,再开机,终于正常启动了。_安装完系统提示secureboot failure

C++如何做字符串分割(5种方法)_c++ 字符串分割-程序员宅基地

文章浏览阅读10w+次,点赞93次,收藏352次。1、用strtok函数进行字符串分割原型: char *strtok(char *str, const char *delim);功能:分解字符串为一组字符串。参数说明:str为要分解的字符串,delim为分隔符字符串。返回值:从str开头开始的一个个被分割的串。当没有被分割的串时则返回NULL。其它:strtok函数线程不安全,可以使用strtok_r替代。示例://借助strtok实现split#include <string.h>#include <stdio.h&_c++ 字符串分割

2013第四届蓝桥杯 C/C++本科A组 真题答案解析_2013年第四届c a组蓝桥杯省赛真题解答-程序员宅基地

文章浏览阅读2.3k次。1 .高斯日记 大数学家高斯有个好习惯:无论如何都要记日记。他的日记有个与众不同的地方,他从不注明年月日,而是用一个整数代替,比如:4210后来人们知道,那个整数就是日期,它表示那一天是高斯出生后的第几天。这或许也是个好习惯,它时时刻刻提醒着主人:日子又过去一天,还有多少时光可以用于浪费呢?高斯出生于:1777年4月30日。在高斯发现的一个重要定理的日记_2013年第四届c a组蓝桥杯省赛真题解答

基于供需算法优化的核极限学习机(KELM)分类算法-程序员宅基地

文章浏览阅读851次,点赞17次,收藏22次。摘要:本文利用供需算法对核极限学习机(KELM)进行优化,并用于分类。

metasploitable2渗透测试_metasploitable2怎么进入-程序员宅基地

文章浏览阅读1.1k次。一、系统弱密码登录1、在kali上执行命令行telnet 192.168.26.1292、Login和password都输入msfadmin3、登录成功,进入系统4、测试如下:二、MySQL弱密码登录:1、在kali上执行mysql –h 192.168.26.129 –u root2、登录成功,进入MySQL系统3、测试效果:三、PostgreSQL弱密码登录1、在Kali上执行psql -h 192.168.26.129 –U post..._metasploitable2怎么进入

Python学习之路:从入门到精通的指南_python人工智能开发从入门到精通pdf-程序员宅基地

文章浏览阅读257次。本文将为初学者提供Python学习的详细指南,从Python的历史、基础语法和数据类型到面向对象编程、模块和库的使用。通过本文,您将能够掌握Python编程的核心概念,为今后的编程学习和实践打下坚实基础。_python人工智能开发从入门到精通pdf