Netty进阶之路-LengthFieldBasedFrameDecoder和LengthFieldPrepender
前言
之前我利用MessagePack编解码,作用其实就是为了提升性能(网络传输中的带宽和本身的存储)。但是之前的在末尾加换行符的解决粘包/半包问题已经不适用了,这篇来讲讲一个比较通用的解决粘包/半包问题的方法。
解决思路
我们可以模仿报文的形式,例如http头中会带有报文的长度。
客户端使用LengthFieldPrepender给实际内容(二进制数据)进行编码添加报文头Length字段,服务端使用LengthFieldBasedFrameDecoder进行解码。
LengthFieldPrepender
本身它有许多的构造方法但是最终会调用这个构造函数。
public LengthFieldPrepender(ByteOrder byteOrder, int lengthFieldLength,
int lengthAdjustment, boolean lengthIncludesLengthFieldLength)
{
if ((lengthFieldLength != 1) && (lengthFieldLength != 2) && (lengthFieldLength != 3) && (lengthFieldLength != 4) && (lengthFieldLength != 8))
{
throw new IllegalArgumentException("lengthFieldLength must be either 1, 2, 3, 4, or 8: " + lengthFieldLength);
}
ObjectUtil.checkNotNull(byteOrder, "byteOrder");
this.byteOrder = byteOrder;
this.lengthFieldLength = lengthFieldLength;
this.lengthIncludesLengthFieldLength = lengthIncludesLengthFieldLength;
this.lengthAdjustment = lengthAdjustment;
}
- List itembyteOrder:表示Length字段本身占用的字节数使用的是大端还是小端编码
- lengthFieldLength:表示Length字段本身占用的字节数,只可以指定 1, 2, 3, 4, 或 8
- lengthAdjustment:表示Length字段调整值
- lengthIncludesLengthFieldLength:表示Length字段本身占用的字节数是否包含在Length字段表示的值中。
说明一下:
lengthIncludesLengthFieldLength 默认是false 协议格式是 : length+内容
如果为false 假设内容为长度为12 则length = 12
如果为true 且lengthFieldLength = 2 假设内容为长度为12 则length = 14
一般我们这么用就可以了
socketChannel.pipeline().addLast(new LengthFieldPrepender(2));
LengthFieldBasedFrameDecoder
用样本身它有许多的构造方法但是最终会调用这个构造函数。
public LengthFieldBasedFrameDecoder(ByteOrder byteOrder, int maxFrameLength, int lengthFieldOffset, int lengthFieldLength, int lengthAdjustment, int initialBytesToStrip, boolean failFast)
{
if (byteOrder == null) {
throw new NullPointerException("byteOrder");
}
if (maxFrameLength <= 0) {
throw new IllegalArgumentException("maxFrameLength must be a positive integer: " + maxFrameLength);
}
if (lengthFieldOffset < 0) {
throw new IllegalArgumentException("lengthFieldOffset must be a non-negative integer: " + lengthFieldOffset);
}
if (initialBytesToStrip < 0) {
throw new IllegalArgumentException("initialBytesToStrip must be a non-negative integer: " + initialBytesToStrip);
}
if (lengthFieldOffset > maxFrameLength - lengthFieldLength) {
throw new IllegalArgumentException("maxFrameLength (" + maxFrameLength + ") must be equal to or greater than lengthFieldOffset (" + lengthFieldOffset + ") + lengthFieldLength (" + lengthFieldLength + ").");
}
this.byteOrder = byteOrder;
this.maxFrameLength = maxFrameLength;
this.lengthFieldOffset = lengthFieldOffset;
this.lengthFieldLength = lengthFieldLength;
this.lengthAdjustment = lengthAdjustment;
this.lengthFieldEndOffset = (lengthFieldOffset + lengthFieldLength);
this.initialBytesToStrip = initialBytesToStrip;
this.failFast = failFast;
}
- byteOrder 表示Length字段的字节是大端还是小端
- maxFrameLength 表示最大长度
- lengthFieldOffset 表示Length字段的偏移量(如果之前还有其他报文,没有为0)
- lengthFieldLength Length字段占用的字节数
- lengthAdjustment Length字段补偿值
- initialBytesToStrip 跳过初始字节数 获取真正的内容
- failFast 就是超出maxFrameLength 是立马抛出还是读完数据再抛出
说明一下
lengthAdjustment 其实就是和LengthFieldPrepender中的lengthIncludesLengthFieldLength配合使用 如果为false的话 lengthAdjustment 为0 如果为true且lengthFieldLength =2 则lengthAdjustment = -2;
一般我们这么用就可以了
socketChannel.pipeline().addLast(new LengthFieldBasedFrameDecoder(65535, 0, 2,0,2));//编码
总结
LengthFieldBasedFrameDecoder:最大长度为65535,Length字段占用的字节数为2,解码时跳过2个字节(length长度)
LengthFieldPrepender:Length字段本身占用的字节数为2
2个配合使用就可以解决粘包/半包问题
socketChannel.pipeline().addLast(new LengthFieldBasedFrameDecoder(65535, 0, 2,0,2));//编码
socketChannel.pipeline().addLast(new LengthFieldPrepender(2));
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。
文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/15326.html