通常我们在对特定的网络协议进行解码时会用到它,比如说,最典型的http协议, 虽然http协议看起来, 又有请求头,又有请求体,挺麻烦的,它在网络中依然是以字节流的方式进行传输
基于长度域,指的是在传输的协议中有一个 length字段,这个十六进制的字段记录的可能是整个协议的长度,也可能是消息体的长度, 我们根据具体情况使用不同的构造函数
如何使用呢? 最常用它下面的这个构造函数
public LengthFieldBasedFrameDecoder( int maxFrameLength, int lengthFieldOffset, int lengthFieldLength, int lengthAdjustment, int initialBytesToStrip) { this( maxFrameLength, lengthFieldOffset, lengthFieldLength, lengthAdjustment, initialBytesToStrip, true); }使用它的前提是,知道这五个参数的意思
maxFrameLength 每次解码所能接受的最大帧的长度
lengthFieldOffset 长度域的偏移量
听着挺高大尚的, 偏移量, 说白了,就是在现有的这段字数据中找个开始解码的位置, 大多数设为0, 意为,从开始解码
lengthFieldLength 字段域的长度, 根据lengthFieldOffset的初始值往后数lengthFieldLength个字节,这段范围解析出来的数值 可能是 长度域的大小,也可能是整个协议的大小(包括header,body...) 根据不同的协议不同
lengthAdjustment 矫正长度
initialBytesToStrip 需要取出的长度
下面是javaDoc给的例子
基于长度的拆包 * BEFORE DECODE (14 bytes) AFTER DECODE (12 bytes) * +--------+----------------+ +--------+----------------+ * | Length | Actual Content |----->| Length | Actual Content | * | 0x000C | "HELLO, WORLD" | | 0x000C | "HELLO, WORLD" | * +--------+----------------+ +--------+----------------+ 这是最简单的情况, 假定 Length的长度就是后面的 真正需要解码的内容 现在的字节全部解码后是这样的 12HELLO, WORLD 我们要做的就是区分出 12和HELLO, WORLD * lengthFieldOffset = 0 * lengthFieldLength = 2 // todo 每两个字节 表示一个数据包 * lengthAdjustment = 0 * initialBytesToStrip = 0 意思就是: 字节数组[lengthFieldOffset,lengthFieldLength]之间的内容转换成十进制,就是后面的字段域的长度 00 0C ==> 12 这个12 意思就是 长度域的长度, 说白了 就是我们想要的 HELLO, WORLD 的长度 这样一算,就分开了 基于长度的阶段拆包 * BEFORE DECODE (14 bytes) AFTER DECODE (12 bytes) * +--------+----------------+ +----------------+ * | Length | Actual Content |----->| Actual Content | * | 0x000C | "HELLO, WORLD" | | "HELLO, WORLD" | * +--------+----------------+ +----------------+ 情况2: * lengthFieldOffset = 0 * lengthFieldLength = 2 // todo 每两个字节 表示一个数据包 * lengthAdjustment = 0 * initialBytesToStrip = 2 意思就是 字节数组[lengthFieldOffset,lengthFieldLength]之间的内容转换成十进制,就是后面的字段域的长度是 00 0C ==> 12 这个12 意思就是 长度域的长度, 说白了 就是我们想要的 HELLO, WORLD 的长度 然后, 从0开始 忽略 initialBytesToStrip, 就去除了 length ,只留下 HELLO, WORLD 有时, 在某些其他协议中, length field 可能代表是整个消息的长度, 包括消息头 在这种情况下,我们就得指定一个 非零的 lengthAdjustment 去调整 * BEFORE DECODE (14 bytes) AFTER DECODE (14 bytes) * +--------+----------------+ +--------+----------------+ * | Length | Actual Content |----->| Length | Actual Content | * | 0x000E | "HELLO, WORLD" | | 0x000E | "HELLO, WORLD" | * +--------+----------------+ +--------+----------------+ * lengthFieldOffset = 0 * lengthFieldLength = 2 // todo 每两个字节 表示一个数据包 * lengthAdjustment = -2 * initialBytesToStrip = 0 意思就是 字节数组[lengthFieldOffset,lengthFieldLength]之间的内容转换成十进制,表示整个协议的长度 00 0C ==> 14 意味,协议全长 14 现在还是不能区分开 Length 和 Actual Content 公式: 数据包的长度 = 长度域 + lengthFieldOffset + lengthFieldLength +lengthAdjustment 通过他可以算出 lengthAdjustment = -2 基于偏移长度的拆包 * BEFORE DECODE (17 bytes) AFTER DECODE (17 bytes) * +----------+----------+----------------+ +----------+----------+----------------+ * | Header 1 | Length | Actual Content |----->| Header 1 | Length | Actual Content | * | 0xCAFE | 0x00000C | "HELLO, WORLD" | | 0xCAFE | 0x00000C | "HELLO, WORLD" | * +----------+----------+----------------+ +----------+----------+----------------+ 这个例子和第一个例子很像,但是多了头 我们想拿到后面消息长度的信息,就偏移过header * lengthFieldOffset = 2 * lengthFieldLength = 3 // todo 每两个字节 表示一个数据包 * lengthAdjustment = 0 * initialBytesToStrip = 0 字节数组[lengthFieldOffset,lengthFieldLength]之间的内容转换成十进制, 表示长度域的长度 在这里 整好跳过了 header 1, 0x00 00 0C 是三个字节 也就是 字节数组[lengthFieldOffset,lengthFieldLength]=>[0,3] 0x00 00 0C == 12 表示长度域是 12 现在也成功区分开了 Header 1 和 Length 和 Actual Content 分别是 2 3 12 基于可调整长度的拆包 BEFORE DECODE (17 bytes) AFTER DECODE (17 bytes) * +----------+----------+----------------+ +----------+----------+----------------+ * | Length | Header 1 | Actual Content |----->| Length | Header 1 | Actual Content | * | 0x00000C | 0xCAFE | "HELLO, WORLD" | | 0x00000C | 0xCAFE | "HELLO, WORLD" | * +----------+----------+----------------+ +----------+----------+----------------+ * lengthFieldOffset = 0 * lengthFieldLength = 3 // todo 每两个字节 表示一个数据包 * lengthAdjustment = 2 * initialBytesToStrip = 0 字节数组[lengthFieldOffset,lengthFieldLength]之间的内容转换成十进制, 表示长度域的长度 也就是 字节数组[lengthFieldOffset,lengthFieldLength]=>[0,3] 0x00 00 0C 是三个字节 0x00 00 0C == 12 表示长度域是 12 == 长度域的长度 就是 HELLO, WORLD的长度 但是上面的图多了一个 两个字节长度的 Header 1 下一步进行调整 公式: 数据包的长度 = 长度域 + lengthFieldOffset + lengthFieldLength +lengthAdjustment lengthAdjustment= 17-12-0-3=2 基于偏移可调整长度的截断拆包 * BEFORE DECODE (16 bytes) AFTER DECODE (13 bytes) * +------+--------+------+----------------+ +------+----------------+ * | HDR1 | Length | HDR2 | Actual Content |----->| HDR2 | Actual Content | * | 0xCA | 0x000C | 0xFE | "HELLO, WORLD" | | 0xFE | "HELLO, WORLD" | * +------+--------+------+----------------+ +------+----------------+ * lengthFieldOffset = 1 * lengthFieldLength = 2 // todo 每两个字节 表示一个数据包 * lengthAdjustment = 1 * initialBytesToStrip = 3 lengthFieldOffset =1 偏移1字节 跨过 HDR1 lengthFieldLength =2 从[1,2] ==> 0x000C =12 表示长度域的值 看拆包后的结果,后面明显还多了个 HDR2 ,进行调整 公式: 数据包值 = 长度域 + lengthFieldOffset+ lengthFieldLength + lengthAdjustment 算出 lengthAdjustment = 16 - 12 - 1 - 2 = 1 结果值只有 HDR2 和 Actual Content , 说明,前面通过 initialBytesToStrip 进行忽略 initialBytesToStrip =3 基于偏移可调整长度的 变种 截断拆包 * BEFORE DECODE (16 bytes) AFTER DECODE (13 bytes) * +------+--------+------+----------------+ +------+----------------+ * | HDR1 | Length | HDR2 | Actual Content |----->| HDR2 | Actual Content | * | 0xCA | 0x0010 | 0xFE | "HELLO, WORLD" | | 0xFE | "HELLO, WORLD" | * +------+--------+------+----------------+ +------+----------------+ * lengthFieldOffset = 1 * lengthFieldLength = 2 // todo 每两个字节 表示一个数据包 * lengthAdjustment = -3 * initialBytesToStrip = 3 同样 看结果,保留 HDR2 和 Actual Content lengthFieldOffset = 1 表示跳过开头的 HDR1 [1,2] ==> 00 10 , 算出的 长度域的值==10 很显然这不对 10 < 13 我们要想拆出后面的数据包就得在现有的基础上往左移动三个字节 -3个调整量