Netty源码阅读入门实战(八) - 解码下

public LengthFieldBasedFrameDecoder(ByteOrder byteOrder, int maxFrameLength, int lengthFieldOffset, int lengthFieldLength, int lengthAdjustment, int initialBytesToStrip, boolean failFast) {
    // 省略参数校验
    this.byteOrder = byteOrder;
    this.maxFrameLength = maxFrameLength;
    this.lengthFieldOffset = lengthFieldOffset;
    this.lengthFieldLength = lengthFieldLength;
    this.lengthAdjustment = lengthAdjustment;
    lengthFieldEndOffset = lengthFieldOffset + lengthFieldLength;
    this.initialBytesToStrip = initialBytesToStrip;
    this.failFast = failFast;
}

void decode(ChannelHandlerContext ctx, ByteBuf in, List out) 
 
in 表目前为止还未拆的数据，拆完之后的包添加到 out这个list中即可实现包向下传递 
第一层实现
  
重载的protected方法decode实现真正的拆包,以下三步走 
基于长度域解码器步骤 
计算需要抽取的数据包长度跳过字节逻辑处理丢弃模式下的处理 
1 计算需要抽取的数据包的长度 
    protected Object decode(ChannelHandlerContext ctx, ByteBuf in) throws Exception {
        // 拿到实际的未调整过的包长度
        long frameLength = getUnadjustedFrameLength(in, actualLengthFieldOffset, lengthFieldLength, byteOrder);

        if (frameLength < lengthFieldEndOffset) {
            failOnFrameLengthLessThanLengthFieldEndOffset(in, frameLength, lengthFieldEndOffset);
        }

        if (frameLength > maxFrameLength) {
            exceededFrameLength(in, frameLength);
            return null;
        }
    }
 
 拿到长度域的实际字节偏移
   调整包的长度
   如果当前可读字节还未达到长度长度域的偏移，那说明肯定是读不到长度域的，直接不读
   
上面有个getUnadjustedFrameLength，若你的长度域代表的值表达的含义不是基本的int,short等基本类型，可重写该方法
 
 比如，有的奇葩的长度域里面虽然是4个字节，比如 0x1234，但是TA的含义是10进制，即长度就是十进制的1234，那么覆盖这个函数即可实现奇葩长度域拆包
 2. 长度校验 
整个数据包的长度还没有长度域长，直接抛异常
 
 数据包长度超出最大包长度，进入丢弃模式
  
  当前可读字节已达到frameLength，直接跳过frameLength个字节，丢弃之后，后面有可能就是一个合法的数据包当前可读字节未达到frameLength，说明后面未读到的字节也需丢弃，进入丢弃模式，先把当前累积的字节全部丢弃  
bytesToDiscard 表还需丢弃多少字节
  
最后，调用failIfNecessary判断是否需要抛出异常 
  不需要再丢弃后面的未读字节(bytesToDiscard == 0)，重置丢弃状态 
    如果没有设置快速失败(!failFast)，或者设置了快速失败并且是第一次检测到大包错误(firstDetectionOfTooLongFrame)，抛出异常，让handler处理如果设置了快速失败，并且是第一次检测到打包错误，抛出异常，让handler去处理
    
前面我们可以知道failFast默认为true，而这里firstDetectionOfTooLongFrame为true，所以，第一次检测到大包肯定会抛出异常
  
3 丢弃模式的处理 
LengthFieldBasedFrameDecoder.decoder方法入口处还有一段代码
  
若当前处在丢弃模式，先计算需要丢弃多少字节，取当前还需可丢弃字节和可读字节的最小值，丢弃后，进入 failIfNecessary，对照着这个函数看，默认情况下是不会继续抛出异常，而如果设置了 failFast为false，那么等丢弃完之后，才会抛出异常
  
2 跳过指定字节长度的逻辑处理 
在丢弃模式的处理及长度校验都通过后 
先验证当前是否已读到足够的字节，若读到了，在下一步抽取一个完整的数据包之前，需根据initialBytesToStrip的设置来跳过某些字节，当然，跳过的字节不能大于数据包的长度，否则抛 CorruptedFrameException 异常
  
抽取frame 
拿到当前累积数据的读指针，然后拿到待抽取数据包的实际长度进行抽取，抽取之后，移动读指针
 抽取的过程即调用了一下 ByteBuf 的retainedSlice API，该API无内存copy的开销
 
 从真正抽取数据包来看看，传入的参数为 int 型，所以自定义协议中，如果你的长度域是8字节，那么前4字节基本没用 
小结 
如果你使用了Netty，并且二进制协议基于长度，考虑使用LengthFieldBasedFrameDecoder吧，通过调整各种参数，一定会满足你LengthFieldBasedFrameDecoder的拆包包括合法参数校验，异常包处理，以及最后调用 ByteBuf 的retainedSlice来实现无内存copy的拆包 
8 解码器总结 
8.1 ByteToMessageDecoder 解码步骤 
累加字节流调用子类的decode方法进行解析将解析到的ByteBuf向下传播 
8.2 基于长度解码器步骤 
计算需要抽取的数据包长度跳过字节逻辑处理丟弃模式下的处理 
8.3 两个问题 
解码器抽象的解码过程netty里面有哪些拆箱即用的解码器