nodeJS丶Buff使用及相關API

JavaScript 語言自身只有字串資料型別，沒有二進位制資料型別。

但在處理像TCP流或檔案流時，必須使用到二進位制資料。因此在 Node.js中，定義了一個 Buffer 類，該類用來建立一個專門存放二進位制資料的快取區。

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

建立 Buffer 類

Node Buffer 類可以通過多種方式來建立。

方法 1

建立長度為 10 位元組的 Buffer 例項：

var buf = new Buffer(10);

方法 2

通過給定的陣列建立 Buffer 例項：

var buf = new Buffer([10, 20, 30, 40, 50]);

方法 3

通過一個字串來建立 Buffer 例項：

var buf = new Buffer("www.runoob.com", "utf-8");

utf-8 是預設的編碼方式，此外它同樣支援以下編碼："ascii", "utf8", "utf16le", "ucs2", "base64" 和 "hex"。

寫入緩衝區

語法

寫入 Node 緩衝區的語法如下所示：

buf.write(string[, offset[, length]][, encoding])

引數

引數描述如下：

• string - 寫入緩衝區的字串。

• offset - 緩衝區開始寫入的索引值，預設為 0 。

• length - 寫入的位元組數，預設為 buffer.length

• encoding - 使用的編碼。預設為 'utf8' 。

返回值

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

例項

buf = new Buffer(256);
len = buf.write("www.runoob.com");

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

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

$node main.js
寫入位元組數 : 14

從緩衝區讀取資料

語法

讀取 Node 緩衝區資料的語法如下所示：

buf.toString([encoding[, start[, end]]])

引數

引數描述如下：

• encoding - 使用的編碼。預設為 'utf8' 。

• start - 指定開始讀取的索引位置，預設為 0。

• end - 結束位置，預設為緩衝區的末尾。

返回值

解碼緩衝區資料並使用指定的編碼返回字串。

例項

buf = new Buffer(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

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

$ node main.js
abcdefghijklmnopqrstuvwxyz
abcde
abcde
abcde

將 Buffer 轉換為 JSON 物件

語法

將 Node Buffer 轉換為 JSON 物件的函式語法格式如下：

buf.toJSON()

返回值

返回 JSON 物件。

例項

var buf = new Buffer('www.runoob.com');
var json = buf.toJSON(buf);

console.log(json);

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

[ 119, 119, 119, 46, 114, 117, 110, 111, 111, 98, 46, 99, 111, 109 ]

緩衝區合併

語法

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

Buffer.concat(list[, totalLength])

引數

引數描述如下：

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

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

返回值

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

例項

var buffer1 = new Buffer('菜鳥教程 ');
var buffer2 = new Buffer('www.runoob.com');
var buffer3 = Buffer.concat([buffer1,buffer2]);
console.log("buffer3 內容: " + buffer3.toString());

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

buffer3 內容: 菜鳥教程 www.runoob.com

緩衝區比較

語法

Node Buffer 比較的函式語法如下所示, 該方法在 Node.js v0.12.2 版本引入：

buf.compare(otherBuffer);

引數

引數描述如下：

• otherBuffer - 與 buf 物件比較的另外一個 Buffer 物件。

返回值

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

例項

var buffer1 = new Buffer('ABC');
var buffer2 = new Buffer('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 buffer1 = new Buffer('ABC');
// 拷貝一個緩衝區
var buffer2 = new Buffer(3);
buffer1.copy(buffer2);
console.log("buffer2 content: " + buffer2.toString());

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

buffer2 content: ABC

緩衝區裁剪

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

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

引數

引數描述如下：

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

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

返回值

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

例項

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

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

buffer2 content: ru

緩衝區長度

語法

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

buf.length;

返回值

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

例項

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

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

buffer length: 14

方法參考手冊

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

var b = new Buffer(6);
b.writeUIntBE(0x1234567890ab, 0, 6);
// <Buffer 12 34 56 78 90 ab>