基於Nodejs的Tcp封包和解包

• 蘇格團隊
• 做者：Jonny

咱們知道，TCP是面向鏈接流傳輸的，其採用Nagle算法，在緩衝區對上層數據進行了處理。避免觸發自動分片機制和網絡上大量小數據包的同時也形成了粘包（小包合併）和半包（大包拆分）問題，致使數據沒有消息保護邊界，接收端接收到一次數據沒法判斷是不是一個完整數據包。那有什麼方案能夠解決這問題呢？

---

一、粘包問題解決方案及對比

很簡單，既然消息沒有邊界，那咱們在消息往下傳以前給它加一個邊界識別就行了。

1. 發送固定長度的消息
2. 使用特殊標記來區分消息間隔
3. 把消息的尺寸與消息一塊發送

第一種方案不夠靈活；第二種有風險，若是數據內恰好有該特殊字符會出問題；第三種方案雖然要增長對消息頭的解析，不過相對而言仍是要安全一些。

二、分包與拆包

既然使用第三種方案，就必然涉及到封包和拆包的問題。

首先確定須要定義數據包的結構，這相似Http包同樣，有包頭和包體。包頭其實上是個大小固定的結構體，其中有個結構體成員變量表示包體的長度，其餘的結構體成員可根據須要本身定義。根據包頭長度固定以及包頭中含有包體長度的變量就能正確的拆分出一個完整的數據包。包體則存放數據內容。

在發送端，須要進行封包。封包就是給一段數據加上包頭,這樣一來數據包就分爲包頭和包體兩部份內容了。

在接受端，則須要進行拆包。主要流程以下：

1. 爲每個鏈接動態分配一個緩衝區,同時把此緩衝區和SOCKET關聯.
2. 當接收到數據時首先把此段數據存放在緩衝區中.
3. 判斷緩存區中的數據長度是否夠一個包頭的長度,如不夠,則不進行拆包操做.
4. 根據包頭數據解析出裏面表明包體長度的變量.
5. 判斷緩存區中除包頭外的數據長度是否夠一個包體的長度,如不夠,則不進行拆包操做.
6. 取出整個數據包.這裏的"取"的意思是不光從緩衝區中拷貝出數據包,並且要把此數據包從緩存區中刪除掉.刪除的辦法就是把此包後面的數據移動到緩衝區的起始地址.

其中對於緩衝區的設計，主要由倆種：

1. 採用動態變化的緩衝區暫存，根據數據大小調整緩衝區大小。這個方案有個缺點，爲了不緩衝區不斷增加，每次解析出一個完整包後須要將緩衝區殘留的數據拷貝到緩衝區首部，這增長了系統負載。
2. 採用環形緩衝區，定義兩個指針,分別指向有效數據的頭和尾.在存放數據和刪除數據時只是進行頭尾指針的移動

三、網絡字節序和本機字節序

定義了消息結構以後，發送端和接收端還須要統一字節序。咱們知道，不一樣機器的本機字節序不一樣，絕大多數X86機器都是小端字節序，而後仍是由少數機器是大端存儲的。所以在數據流進行傳輸時，必須先統一字節序。通常約定在傳輸時採用網絡字節序（大端），統一用unicode編碼。

四、代碼實現

瞭解以上知識以後，咱們如今以後要作什麼了。發送端按定義的協議規則封包，接受端把接收到的buffer放入緩衝區，當緩衝區內有完整包時開始拆包。封包拆包過程須要注意，讀寫超過一個字節的數據時須要按大端字節序讀取。下面看node的代碼實現（只提供核心實現片斷）：

1）發送端封包：

let head = new Buffer(4);
    let jsonStr = JSON.stringify(json);
    let body = new Buffer(jsonStr);
    //超過一字節的大端寫入
    head.writeInt32BE(body.byteLength, 0);
    let buffer = Buffer.concat([head, body]);
複製代碼

2）接收端收到buffer入緩衝區：

let dataReadStart = 0; //新數據的起始位置
let dataLength = buffer.length; // 要拷貝數據的長度
let availableLen = _bufferLength - _dataLen; // 緩衝區剩餘可用空間

// buffer剩餘空間不足夠存儲本次數據
if (availableLen < dataLength) {
    let newLength = Math.ceil((_dataLen + dataLength) / _bufferLength) * _bufferLength;
    let _tempBuffer = Buffer.alloc(newLength);
    
    // 將舊數據複製到新buffer而且修正相關參數
    if (_writePointer < _readPointer) { // 數據存儲在舊buffer的尾部+頭部的順序
        let dataTailLen = _bufferLength - _readPointer;
        _buffer.copy(_tempBuffer, 0, _readPointer, _readPointer + dataTailLen);
        _buffer.copy(_tempBuffer, dataTailLen, 0, _writePointer);
    } else {  // 數據是按照順序進行的完整存儲
        _buffer.copy(_tempBuffer, 0, _readPointer, _writePointer);
    }
    _bufferLength = newLength;
    _buffer = _tempBuffer;
    _tempBuffer = null;
    _readPointer = 0;
    _writePointer = _dataLen;

    //存儲新到來的buffer
    buffer.copy(_buffer, _writePointer, dataReadStart, dataReadStart + dataLength);
    _dataLen += dataLength;
    _writePointer += dataLength;

} else if (_writePointer + dataLength > _bufferLength) {
// 空間夠用狀況下，可是數據會衝破緩衝區尾部，部分存到緩衝區舊數據後，一部分存到緩衝區開始位置
    // 緩衝區尾部剩餘空間的長度
    let bufferTailLength = _bufferLength - _writePointer;

    // 數據尾部位置
    let dataEndPosition = dataReadStart + bufferTailLength;
    buffer.copy(_buffer, _writePointer, dataReadStart, dataEndPosition);

    // data剩餘未拷貝進緩存的長度
    let restDataLen = dataLength - bufferTailLength;
    buffer.copy(_buffer, 0, dataEndPosition, dataLength);

    _dataLen = _dataLen + dataLength;
    _writePointer = restDataLen

} else { // 剩餘空間足夠存儲數據，直接拷貝數據到緩衝區
    buffer.copy(_buffer, _writePointer, dataReadStart, dataReadStart + dataLength);
    _dataLen = _dataLen + dataLength;
    _writePointer = _writePointer + dataLength
}
複製代碼

2）取出緩衝區全部完整數據包（收到的buffer入緩衝區後）

let _dataHeadLen = 4;
timer && clearInterval(timer);
timer = setInterval(()=>{
    // 緩衝區數據不夠解析出包頭
    if (_dataLen < _dataHeadLen) {
        console.log('數據長度小於包頭規定長度，等待數據......')
        clearInterval(timer);
    }
    // 解析包頭長度
    // 尾部最後剩餘可讀字節長度
    let restDataLen = _bufferLength - _readPointer;
    let dataLen = 0;
    let headBuffer = Buffer.alloc(_dataHeadLen);
    // 數據包爲分段存儲，不能直接解析出包頭，先拼接
    if (restDataLen < _dataHeadLen) {
        // 取出第一部分頭部字節
        _buffer.copy(headBuffer, 0, _readPointer, _bufferLength)
        // 取出第二部分頭部字節
        let unReadHeadLen = _dataHeadLen - restDataLen;
        _buffer.copy(headBuffer, restDataLen, 0, unReadHeadLen)
        dataLen = headBuffer.readUInt32BE(0);
    } else {
        _buffer.copy(headBuffer, 0, _readPointer, _readPointer + _dataHeadLen);
        dataLen = headBuffer.readUInt32BE(0);;
    }

    // 數據長度不夠讀取，直接返回
    if (_dataLen - _dataHeadLen  < dataLen) {
        log.info("緩衝區已有body數據長度小於包頭定義body的長度，等待數據......")
        clearInterval(timer);

    } else { // 數據夠讀，讀取數據包 
        let package = Buffer.alloc(dataLen);
        // 數據是分段存儲，須要分兩次讀取
        if (_bufferLength - _readPointer < dataLen) {
            let firstPartLen = _bufferLength - _readPointer;
            // 讀取第一部分，直接到字符尾部的數據
            _buffer.copy(package, 0, _readPointer, firstPartLen + _readPointer);
            // 讀取第二部分，存儲在開頭的數據
            let secondPartLen = dataLen - firstPartLen;
            _buffer.copy(package, firstPartLen, 0, secondPartLen);
            _readPointer = secondPartLen; //更新可讀起點

        } else { // 直接讀取數據
            _buffer.copy(package, 0, _readPointer, _readPointer + dataLen);
            _readPointer += dataLen; //更新可讀起點
        }

        _dataLen -= readData.length; //更新數據長度
        // 已經讀取完全部數據
        if (_readPointer === _writePointer) {
            clearInterval(timer)
        }

        //開始解包
        callback(package);
          
    }
}, 50);
複製代碼

4）拆包獲得數據

let headBytes = 4;
let head = new Buffer(headBytes);
buffer.copy(head, 0, 0, headBytes);
let dataLen = head.readUInt32BE();
const body = new Buffer(dataLen);
buffer.copy(body, 0, headBytes, headBytes + dataLen)

let content = null;
try {
    const str = body.toString('utf-8');
    if(str === ''){
        content = null;
    }else{
        content = JSON.parse(body);
    }
} catch (e) {
    log.error('head指定body長度有問題')
}
//傳遞給業務層
callback(content);
複製代碼

五、總結

從上面咱們已經瞭解到了封包解包的一個過程。TCP是可靠傳輸的，同一時間在網絡上只會有一個數據包，而且丟包會重傳，所以不用擔憂丟包或者數據包亂序問題。UDP有消息保護邊界，不須要進行拆包解包，而後其是非可靠傳輸，也須要解決其餘一些問題，譬如丟包和數據包排序問題。

上面進行數據包結構設計時只是簡單地加了一個包體長度，事實上在業務場景能夠自由增長鬚要的字段，譬如協議版本，協議類型等等。