Node.js Buffer(緩衝區)

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('itread01', 'ascii');

// 輸出 72756e6f6f62
console.log(buf.toString('hex'));

// 輸出 cnVub29i
console.log(buf.toString('base64'));

Node.js 目前支援的字元編碼包括：

• ascii - 僅支援 7 位 ASCII 資料。如果設定去掉高位的話，這種編碼是非常快的。

• utf8 - 多位元組編碼的 Unicode 字元。許多網頁和其他文件格式都使用 UTF-8 。

• utf16le - 2 或 4 個位元組，小位元組序編碼的 Unicode 字元。支援代理對（U+10000 至 U+10FFFF）。

• ucs2 - utf16le 的別名。

• base64 - Base64 編碼。

• latin1 - 一種把 Buffer 編碼成一位元組編碼的字串的方式。

• binary - latin1 的別名。

• hex - 將每個位元組編碼為兩個十六進位制字元。

建立 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.itread01.com");

console.log("寫入位元組數 : "+  len);

執行以上程式碼，輸出結果為：

$node main.js
寫入位元組數 : 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));   //使用 'ascii' 編碼, 並輸出: abcde
console.log( buf.toString('utf8',0,5));    // 使用 'utf8' 編碼, 並輸出: abcde
console.log( buf.toString(undefined,0,5)); // 使用預設的 'utf8' 編碼, 並輸出: abcde

執行以上程式碼，輸出結果為：

$ node main.js
abcdefghijklmnopqrstuvwxyz
abcde
abcde
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);

執行以上程式碼，輸出結果為：

{"type":"Buffer","data":[1,2,3,4,5]}
<Buffer 01 02 03 04 05>

緩衝區合併

語法

Node 緩衝區合併的語法如下所示：

Buffer.concat(list[, totalLength])

引數

引數描述如下：

• list - 用於合併的 Buffer 物件陣列列表。

• totalLength - 指定合併後Buffer物件的總長度。

返回值

返回一個多個成員合併的新 Buffer 物件。

例項

var buffer1 = Buffer.from(('入門教學'));
var buffer2 = Buffer.from(('www.itread01.com'));
var buffer3 = Buffer.concat([buffer1,buffer2]);
console.log("buffer3 內容: " + buffer3.toString());

執行以上程式碼，輸出結果為：

buffer3 內容: 入門教學www.itread01.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 + "之後");
}

執行以上程式碼，輸出結果為：

ABC在ABCD之前

拷貝緩衝區

語法

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('itread01');

//將 buf2 插入到 buf1 指定位置上
buf2.copy(buf1, 2);

console.log(buf1.toString());

執行以上程式碼，輸出結果為：

abitread01ijkl

緩衝區裁剪

Node 緩衝區裁剪語法如下所示：

buf.slice([start[, end]])

引數

引數描述如下：

• start - 數字, 可選, 預設: 0

• end - 數字, 可選, 預設: buffer.length

返回值

返回一個新的緩衝區，它和舊緩衝區指向同一塊記憶體，但是從索引 start 到 end 的位置剪下。

例項

var buffer1 = Buffer.from('itread01');
// 剪下緩衝區
var buffer2 = buffer1.slice(0,2);
console.log("buffer2 content: " + buffer2.toString());

執行以上程式碼，輸出結果為：

buffer2 content: ru

緩衝區長度

語法

Node 緩衝區長度計算語法如下所示：

buf.length;

返回值

返回 Buffer 物件所佔據的記憶體長度。

例項

var buffer = Buffer.from('www.itread01.com');
//  緩衝區長度
console.log("buffer length: " + buffer.length);

執行以上程式碼，輸出結果為：

buffer length: 14

方法參考手冊

以下列出了 Node.js Buffer 模組常用的方法（注意有些方法在舊版本是沒有的）：

const buf = Buffer.allocUnsafe(6);

buf.writeUIntLE(0x1234567890ab, 0, 6);

// 輸出: <Buffer ab 90 78 56 34 12>
console.log(buf);

const buf = Buffer.allocUnsafe(6);

buf.writeUIntBE(0x1234567890ab, 0, 6);

// 輸出: <Buffer 12 34 56 78 90 ab>
console.log(buf);