接上篇《TCP 粘包和半包 介紹及解決(上)》

上一篇介紹了粘包和半包及其通用的解決方案，今天重點來看一下 Netty 是如何實現(xiàn)封裝成幀(Framing)方案的。

解碼核心流程

之前介紹過三種解碼器FixedLengthFrameDecoder、DelimiterBasedFrameDecoder、LengthFieldBasedFrameDecoder，它們都繼承自ByteToMessageDecoder，而ByteToMessageDecoder繼承自ChannelInboundHandlerAdapter，其核心方法為channelRead。因此，我們來看看ByteToMessageDecoder的channelRead方法：

@Override 
public void channelRead(ChannelHandlerContext ctx, Object msg) throws Exception { 
 if (msg instanceof ByteBuf) { 
 CodecOutputList out = CodecOutputList.newInstance(); 
 try { 
 // 將傳入的消息轉(zhuǎn)化為data 
 ByteBuf data = (ByteBuf) msg; 
 // 最終實現(xiàn)的目標(biāo)是將數(shù)據(jù)全部放進(jìn)cumulation中 
 first = cumulation == null; 
 // 第一筆數(shù)據(jù)直接放入 
 if (first) { 
 cumulation = data; 
 } else { 
 // 不是第一筆數(shù)據(jù)就進(jìn)行追加 
 cumulation = cumulator.cumulate(ctx.alloc(), cumulation, data); 
 } 
 // 解碼 
 callDecode(ctx, cumulation, out); 
 } 
 // 以下代碼省略，因為不屬于解碼過程 
 } 

再來看看callDecode方法：

protected void callDecode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) { 
 try { 
 while (in.isReadable()) { 
 int outoutSize = out.size(); 
 if (outSize > 0) { 
 // 以下代碼省略，因為初始狀態(tài)時，outSize 只可能是0，不可能進(jìn)入這里 
 } 
 int oldInputLength = in.readableBytes(); 
 // 在進(jìn)行 decode 時，不執(zhí)行handler的remove操作。 
 // 只有當(dāng) decode 執(zhí)行完之后，開始清理數(shù)據(jù)。 
 decodeRemovalReentryProtection(ctx, in, out); 
 // 省略以下代碼，因為后面的內(nèi)容也不是解碼的過程 

再來看看decodeRemovalReentryProtection方法：

final void decodeRemovalReentryProtection(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) 
 throws Exception { 
 // 設(shè)置當(dāng)前狀態(tài)為正在解碼 
 decodeState = STATE_CALLING_CHILD_DECODE; 
 try { 
 // 解碼 
 decode(ctx, in, out); 
 } finally { 
 // 執(zhí)行hander的remove操作 
 boolean removePending = decodeState == STATE_HANDLER_REMOVED_PENDING; 
 decodeState = STATE_INIT; 
 if (removePending) { 
 handlerRemoved(ctx); 
 } 
 } 
} 
// 子類都重寫了該方法，每種實現(xiàn)都會有自己特殊的解碼方式 
protected abstract void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception; 

從上面的過程可以總結(jié)出，在解碼之前，需要先將數(shù)據(jù)寫入cumulation，當(dāng)解碼結(jié)束后，需要通過 handler 進(jìn)行移除。

具體解碼過程

剛剛說到decode方法在子類中都有實現(xiàn)，那針對我們說的三種解碼方式，一一看其實現(xiàn)。

1. FixedLengthFrameDecoder

其源碼為：

@Override 
protected final void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception { 
 Object decodedecoded = decode(ctx, in); 
 if (decoded != null) { 
 out.add(decoded); 
 } 
} 
protected Object decode( 
 @SuppressWarnings("UnusedParameters") ChannelHandlerContext ctx, ByteBuf in) throws Exception { 
 // 收集到的數(shù)據(jù)是否小于固定長度，小于就代表無法解析 
 if (in.readableBytes() < frameLength) { 
 return null; 
 } else { 
 return in.readRetainedSlice(frameLength); 
 } 
} 

就和這個類的名字一樣簡單，就是固定長度進(jìn)行解碼，因此，在設(shè)置該解碼器的時候，需要在構(gòu)造方式里傳入frameLength。

2. DelimiterBasedFrameDecoder

其源碼為：

@Override 
protected final void decode(ChannelHandlerContext ctx, ByteBuf in, List<Object> out) throws Exception { 
 Object decodedecoded = decode(ctx, in); 
 if (decoded != null) { 
 out.add(decoded); 
 } 
} 
protected Object decode(ChannelHandlerContext ctx, ByteBuf buffer) throws Exception { 
 // 當(dāng)前的分割符是否是換行分割符(\n或者\r\n) 
 if (lineBasedDecoder != null) { 
 return lineBasedDecoder.decode(ctx, buffer); 
 } 
 // Try all delimiters and choose the delimiter which yields the shortest frame. 
 int minFrameLength = Integer.MAX_VALUE; 
 ByteBuf minDelim = null; 
 // 其他分割符進(jìn)行一次切分 
 for (ByteBuf delim: delimiters) { 
 int frameLength = indexOf(buffer, delim); 
 if (frameLength >= 0 && frameLength < minFrameLength) { 
 minFrameLength = frameLength; 
 minDelim = delim; 
 } 
 } 
 // 以下代碼省略 

根據(jù)它的名字可以知道，分隔符才是它的核心。它將分割符分成兩類，只有換行分割符(n或者rn)和其他。因此，需要注意的是，你可以定義多種分割符，它都是支持的。

3. LengthFieldBasedFrameDecoder

該類比較復(fù)雜，如果直接看方法容易把自己看混亂，因此我準(zhǔn)備結(jié)合類上的解釋，先看看其私有變量。

* 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 ：該字段代表 Length 字段是從第幾個字節(jié)開始的。上面的例子里，Length 字段是從第1個字節(jié)開始(HDR1 是第0個字節(jié))，因此該值即為0。
• lengthFieldLength：該字段代表 Length 字段所占用的字節(jié)數(shù)。上面的例子里，Length 字段占用2個字節(jié)，因此該值為2。
• lengthAdjustment：該字段代表 Length 字段結(jié)束位置到真正的內(nèi)容開始位置的距離。上面例子里，因為 Length 字段的含義是整個消息(包括 HDR1、Length、HDR2、Actual Content，一般 Length 指的只是 Actual Content)，所以 Length 末尾到真正的內(nèi)容開始位置(HDR1的開始處)，相當(dāng)于減少3個字節(jié)，所以是-3。
• initialBytesToStrip： 展示時需要從 Length 字段末尾開始跳過幾個字節(jié)。上面例子里，因為真正的內(nèi)容是從 HDR1 開始的，最終展示的內(nèi)容是從 HDR2 開始的，所以中間差了3個字節(jié)，所以該值是3。

該類的解碼方法比較復(fù)雜，有興趣的同學(xué)可以試著自己分析一下。

總結(jié)

這一篇主要是結(jié)合 Netty 里的源代碼講解了 Netty 中封裝成幀(Framing)的三種方式，相信你一定有了不一樣的理解。