Node.js：Buffer(緩沖區)介紹及常用方法

　　JavaScript 語言自身只有字符串數據類型，沒有二進制數據類型。

　　但在處理像TCP流或文件流時，必須使用到二進制數據。因此在 Node.js中，定義了一個 Buffer 類，該類用來創建一個專門存放二進制數據的緩存區。

　　在 Node.js 中，Buffer 類是隨 Node 內核一起發布的核心庫。Buffer 庫為 Node.js 帶來了一種存儲原始數據的方法，可以讓 Node.js 處理二進制數據，每當需要在 Node.js 中處理 I/O 操作中移動的數據時，就有可能使用 Buffer 庫。原始數據存儲在 Buffer 類的實例中。一個 Buffer 類似於一個整數數組，但它對應於 V8 堆內存之外的一塊原始內存。

　　在v6.0之前創建Buffer對象直接使用new Buffer()構造函數來創建對象實例，但是Buffer對內存的權限操作相比很大，可以直接捕獲一些敏感信息，所以在v6.0以后，官方文檔里面建議使用 Buffer.from() 接口去創建Buffer對象。

一、Buffer 與字符編碼

　　Buffer 實例一般用於表示編碼字符的序列，比如 UTF-8 、 UCS2 、 Base64 、或十六進制編碼的數據。 通過使用顯式的字符編碼，就可以在 Buffer 實例與普通的 JavaScript 字符串之間進行相互轉換。

const buf = Buffer.from('runoob', 'ascii'); // 輸出 cnVub29i
console.log(buf.toString('base64'));

二、創建 Buffer 類

　　Buffer 提供了以下 API 來創建 Buffer 類：

Buffer.alloc(size[, fill[, encoding]])： 返回一個指定大小的 Buffer 實例，如果沒有設置 fill，則默認填滿 0

Buffer.allocUnsafe(size)： 返回一個指定大小的 Buffer 實例，但是它不會被初始化，所以它可能包含敏感的數據

Buffer.allocUnsafeSlow(size)

Buffer.from(array)： 返回一個被 array 的值初始化的新的 Buffer 實例（傳入的 array 的元素只能是數字，不然就會自動被 0 覆蓋）

Buffer.from(arrayBuffer[, byteOffset[, length]])： 返回一個新建的與給定的 ArrayBuffer 共享同一內存的 Buffer。

Buffer.from(buffer)： 復制傳入的 Buffer 實例的數據，並返回一個新的 Buffer 實例

Buffer.from(string[, encoding])： 返回一個被 string 的值初始化的新的 Buffer 實例

// 創建一個長度為 10、且用 0 填充的 Buffer。
const buf1 = Buffer.alloc(10); // 創建一個長度為 10、且用 0x1 填充的 Buffer。 
const buf2 = Buffer.alloc(10, 1); // 創建一個長度為 10、且未初始化的 Buffer。 // 這個方法比調用 Buffer.alloc() 更快， // 但返回的 Buffer 實例可能包含舊數據， // 因此需要使用 fill() 或 write() 重寫。
const buf3 = Buffer.allocUnsafe(10); // 創建一個包含 [0x1, 0x2, 0x3] 的 Buffer。
const buf4 = Buffer.from([1, 2, 3]); // 創建一個包含 UTF-8 字節 [0x74, 0xc3, 0xa9, 0x73, 0x74] 的 Buffer。
const buf5 = Buffer.from('tést'); // 創建一個包含 Latin-1 字節 [0x74, 0xe9, 0x73, 0x74] 的 Buffer。
const buf6 = Buffer.from('tést', 'latin1');

三、寫入緩沖區

　　寫入 Node 緩沖區的語法如下所示：buf.write(string[, offset[, length]][, encoding])

　　參數描述如下：

　　string - 寫入緩沖區的字符串。

　　offset - 緩沖區開始寫入的索引值，默認為 0 。

　　length - 寫入的字節數，默認為 buffer.length

　　encoding - 使用的編碼。默認為 'utf8' 。

　　根據 encoding 的字符編碼寫入 string 到 buf 中的 offset 位置。 length 參數是寫入的字節數。 如果 buf 沒有足夠的空間保存整個字符串，則只會寫入 string 的一部分。 只部分解碼的字符不會被寫入。

　　返回值：返回實際寫入的大小。如果 buffer 空間不足， 則只會寫入部分字符串。

buf = Buffer.alloc(256); len = buf.write("www.runoob.com"); console.log("寫入字節數 : "+ len); //寫入字節數 : 14

四、從緩沖區讀取數據

　　讀取 Node 緩沖區數據的語法如下所示：buf.toString([encoding[, start[, end]]])

　　參數描述如下：

　　encoding - 使用的編碼。默認為 'utf8' 。

　　start - 指定開始讀取的索引位置，默認為 0。

　　end - 結束位置，默認為緩沖區的末尾。

　　返回值：解碼緩沖區數據並使用指定的編碼返回字符串。

buf = Buffer.alloc(26); for (var i = 0 ; i < 26 ; i++) { buf[i] = i + 97; } console.log( buf.toString('ascii'));       // 輸出: abcdefghijklmnopqrstuvwxyz
console.log( buf.toString('ascii',0,5));   // 輸出: abcde
console.log( buf.toString('utf8',0,5));    // 輸出: abcde
console.log( buf.toString(undefined,0,5)); // 使用 'utf8' 編碼, 並輸出: abcde

五、將 Buffer 轉換為 JSON 對象

　　將 Node Buffer 轉換為 JSON 對象的函數語法格式如下：buf.toJSON()

　　當字符串化一個 Buffer 實例時，JSON.stringify() 會隱式地調用該 toJSON()。

　　返回值：返回 JSON 對象。

const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]); const json = JSON.stringify(buf); // 輸出: {"type":"Buffer","data":[1,2,3,4,5]}
console.log(json); const copy = JSON.parse(json, (key, value) => { return value && value.type === 'Buffer' ? Buffer.from(value.data) : value; }); // 輸出: <Buffer 01 02 03 04 05>
console.log(copy);

六、緩沖區合並

　　Node 緩沖區合並的語法如下所示：Buffer.concat(list[, totalLength])

　　參數描述如下：

• list - 用於合並的 Buffer 對象數組列表。

• totalLength - 指定合並后Buffer對象的總長度。

　　返回值：返回一個多個成員合並的新 Buffer 對象。

var buffer1 = Buffer.from(('百度')); var buffer2 = Buffer.from(('www.baidu.com')); var buffer3 = Buffer.concat([buffer1,buffer2]); console.log("buffer3 內容: " + buffer3.toString()); //buffer3 內容: 百度 www.baidu.com

七、緩沖區比較

　　Node Buffer 比較的函數語法如下所示, 該方法在 Node.js v0.12.2 版本引入：buf.compare(otherBuffer);

　　參數描述如下：

• otherBuffer - 與 buf 對象比較的另外一個 Buffer 對象。

　　返回值：返回一個數字，表示 buf 在 otherBuffer 之前，之后或相同。

var buffer1 = Buffer.from('ABC'); var buffer2 = Buffer.from('ABCD'); var result = buffer1.compare(buffer2); if(result < 0) { console.log(buffer1 + " 在 " + buffer2 + "之前"); }else if(result == 0){ console.log(buffer1 + " 與 " + buffer2 + "相同"); }else { console.log(buffer1 + " 在 " + buffer2 + "之后"); }

八、拷貝緩沖區

　　Node 緩沖區拷貝語法如下所示：buf.copy(targetBuffer[, targetStart[, sourceStart[, sourceEnd]]])

　　參數描述如下：

• targetBuffer - 要拷貝的 Buffer 對象。

• targetStart - 數字, 可選, 默認: 0

• sourceStart - 數字, 可選, 默認: 0

• sourceEnd - 數字, 可選, 默認: buffer.length

　　返回值：沒有返回值。

var buf1 = Buffer.from('abcdefghijkl'); var buf2 = Buffer.from('RUNOOB'); //將 buf2 插入到 buf1 指定位置上
buf2.copy(buf1, 2); console.log(buf1.toString()); //abRUNOOBijkl，從索引2開始插入

九、緩沖區裁剪

　　Node 緩沖區裁剪語法如下所示：buf.slice([start[, end]])

　　參數描述如下：

• start - 數字, 可選, 默認: 0

• end - 數字, 可選, 默認: buffer.length

　　返回值：返回一個新的緩沖區，它和舊緩沖區指向同一塊內存，但是從索引 start 到 end 的位置剪切。

var buffer1 = Buffer.from('runoob'); // 剪切緩沖區
var buffer2 = buffer1.slice(0,2); console.log("buffer2 content: " + buffer2.toString()); //buffer2 content: ru

十、緩沖區長度

　　Node 緩沖區長度計算語法如下所示：buf.length;

　　返回值：返回 Buffer 對象所占據的內存長度。

var buffer = Buffer.from('www.baidu.com'); // 緩沖區長度--13
console.log("buffer length: " + buffer.length);