Node.js 緩衝區


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.php.cn", "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.php.cn");

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.php.cn');
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('php中文网 ');
var buffer2 = new Buffer('www.php.cn');
var buffer3 = Buffer.concat([buffer1,buffer2]);
console.log("buffer3 内容: " + buffer3.toString());

執行上述程式碼,輸出結果為:

buffer3 内容: php中文网 www.php.cn

緩衝區比較

語法

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]])
參數

參數描述如下:

# -   數字, 可選, 預設: 0

#end

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

傳回值

傳回一個新的緩衝區,它和舊緩衝區指向同一塊內存,但是從索引start 到end 的位置剪切。

實例

var buffer1 = new Buffer('php');
// 剪切缓冲区
var buffer2 = buffer1.slice(0,2);
console.log("buffer2 content: " + buffer2.toString());

執行上述程式碼,輸出結果為:

buffer2 content: ru

緩衝區長度

###語法######Node 緩衝區長度計算語法如下所示:###
buf.length;
###傳回值######傳回Buffer 物件所佔據的記憶體長度。 ######實例###
var buffer = new Buffer('www.php.cn');
//  缓冲区长度
console.log("buffer length: " + buffer.length);
###執行上述程式碼,輸出結果為:###
buffer length: 14
######方法參考手冊######以下列出了Node.js Buffer 模組常用的方法(注意有些方法在舊版本是沒有的):###
序號方法& 描述
#1new Buffer(size)
分配一個新的size 大小單位為8位元組的buffer。  注意, size 必須小於 kMaxLength,否則,將會拋出異常 RangeError。
2new Buffer(buffer)
拷貝參數 buffer 的資料到 Buffer 實例。
3new Buffer(str[, encoding])
# 指派一個新的buffer ,其中包含傳入的str字串。 encoding 編碼方式預設為 'utf8'。
4buf.length
傳回這個 buffer 的 bytes 數。注意這未必是 buffer 裡面內容的大小。 length 是 buffer 物件所分配的記憶體數,它不會隨著這個 buffer 物件內容的改變而改變。
5buf.write(string[, offset[, length]][, encoding])
根據參數offset 偏移量和指定的encoding 編碼方式,將參數string 資料寫入buffer。 offset 偏移量預設值是 0, encoding 編碼方式預設是 utf8。 length 長度是將要寫入的字串的 bytes 大小。 傳回 number 類型,表示寫入了多少 8 位元位元組流。如果 buffer 沒有足夠的空間來放整個 string,它將只會只寫入部分字串。 length 預設是 buffer.length - offset。 這個方法不會出現寫入部分字元。
6buf.writeUIntLE(value, offset, byteLength[, noAssert])
#將value 寫入到buffer 裡,它由offset 和byteLength 決定,支援48 位元計算,例如:
var b = new Buffer(6);
b.writeUIntBE(0x1234567890ab, 0, 6);
// <Buffer 12 34 56 78 90 ab>
noAssert 值為true 時,不再驗證value 和offset 的有效性。 預設是 false。
7buf.writeUIntBE(value, offset, byteLength[, noAssert])
#將value 寫入到buffer 裡,它由offset 和byteLength 決定,支援48 位元計算。 noAssert 值為 true 時,不再驗證 value 和 offset 的有效性。 預設是 false。
8buf.writeIntLE(value, offset, byteLength[, noAssert])
#將value 寫入到buffer 裡,它由offset 和byteLength 決定,支援48 位元計算。 noAssert 值為 true 時,不再驗證 value 和 offset 的有效性。 預設是 false。
9buf.writeIntBE(value, offset, byteLength[, noAssert])
#將value 寫入到buffer 裡,它由offset 和byteLength 決定,支援48 位元計算。 noAssert 值為 true 時,不再驗證 value 和 offset 的有效性。 預設是 false。
10buf.readUIntLE(offset, byteLength[, noAssert])
支援讀取 48 位元以下的數字。 noAssert 值為 true 時, offset 不再驗證是否超過 buffer 的長度,預設為 false。
11buf.readUIntBE(offset, byteLength[, noAssert])
支援讀取 48 位以下的數字。 noAssert 值為 true 時, offset 不再驗證是否超過 buffer 的長度,預設為 false。
12buf.readIntLE(offset, byteLength[, noAssert])
支援讀取 48 位元以下的數字。 noAssert 值為 true 時, offset 不再驗證是否超過 buffer 的長度,預設為 false。
13buf.readIntBE(offset, byteLength[, noAssert])
支援讀取 48 位元以下的數字。 noAssert 值為 true 時, offset 不再驗證是否超過 buffer 的長度,預設為 false。
14buf.toString([encoding[, start[, end]]])
根據encoding 參數(預設是'utf8')傳回一個解碼過的string 類型。也會根據傳入的參數 start (預設是 0) 和 end (預設是 buffer.length)作為取值範圍。
15buf.toJSON()
將 Buffer 實例轉換為 JSON 物件。
16buf[index]
#取得或設定指定的位元組。傳回值代表一個位元組,所以傳回值的合法範圍是十六進位0x00到0xFF 或十進位0至 255。
17buf.equals(otherBuffer)
比較兩個緩衝區是否相等,如果是傳回true,否則回傳false 。
18buf.compare(otherBuffer)
比較兩個Buffer 對象,回傳一個數字,表示buf 在otherBuffer 之前,之後或相同。
19buf.copy(targetBuffer[, targetStart[, sourceStart[, sourceEnd]]])
#buffer 拷貝,來源和目標可以相同。 targetStart 目標開始偏移和 sourceStart 來源開始偏移預設都是 0。 sourceEnd 來源結束位置偏移預設是來源的長度 buffer.length 。
20buf.slice([start[, end]])
剪切Buffer 對象,根據start(預設是0 ) 和end (預設是buffer.length ) 偏移和裁剪了索引。 負的索引是從 buffer 尾部開始計算的。
21buf.readUInt8(offset[, noAssert])
根據指定的偏移量,讀取一個有符號8 位元整數。若參數 noAssert 為 true 將不會驗證 offset 偏移量參數。 如果這樣 offset 可能會超出buffer 的結尾。預設是 false。
22buf.readUInt16LE(offset[, noAssert])
根據指定的偏移量,使用特殊的endian 字節序格式讀取一個有符號16 位元整數。若參數 noAssert 為 true 將不會驗證 offset 偏移量參數。 這意味著 offset 可能會超出 buffer 的末尾。預設是 false。
23buf.readUInt16BE(offset[, noAssert])
#根據指定的偏移量,使用特殊的 endian 位元組序格式讀取一個有符號 16 位元整數。若參數 noAssert 為 true 將不會驗證 offset 偏移量參數。 這意味著 offset 可能會超出 buffer 的末尾。預設是 false。
24buf.readUInt32LE(offset[, noAssert])
根據指定的偏移量,使用指定的endian 字節序格式讀取一個有符號32 位元整數。 若參數 noAssert 為 true 將不會驗證 offset 偏移量參數。 這意味著 offset 可能會超出buffer 的末尾。預設是 false。
25buf.readUInt32BE(offset[, noAssert])
根據指定的偏移量,使用指定的endian 字節序格式讀取一個有符號32 位元整數。 若參數 noAssert 為 true 將不會驗證 offset 偏移量參數。 這意味著 offset 可能會超出buffer 的末尾。預設是 false。
26buf.readInt8(offset[, noAssert])
根據指定的偏移量,讀取一個signed 8位整數。 若參數 noAssert 為 true 將不會驗證 offset 偏移量參數。 這意味著 offset 可能會超出 buffer 的末尾。預設是 false。
27buf.readInt16LE(offset[, noAssert])
根據指定的偏移量,使用特殊的endian 格式讀取一個signed 16 位元整數。 若參數 noAssert 為 true 將不會驗證 offset 偏移量參數。 這意味著 offset 可能會超出 buffer 的末尾。預設是 false。
28buf.readInt16BE(offset[, noAssert])
根據指定的偏移量,使用特殊的endian 格式讀取一個signed 16 位元整數。 若參數 noAssert 為 true 將不會驗證 offset 偏移量參數。 這意味著 offset 可能會超出 buffer 的末尾。預設是 false。
29buf.readInt32LE(offset[, noAssert])
根據指定的偏移量,使用指定的endian 字節序格式讀取一個signed 32 位元整數。 若參數 noAssert 為 true 將不會驗證 offset 偏移量參數。 這意味著 offset 可能會超出buffer 的末尾。預設是 false。
30buf.readInt32BE(offset[, noAssert])
根據指定的偏移量,使用指定的endian 字節序格式讀取一個signed 32 位元整數。 若參數 noAssert 為 true 將不會驗證 offset 偏移量參數。 這意味著 offset 可能會超出buffer 的末尾。預設是 false。
31buf.readFloatLE(offset[, noAssert])
根據指定的偏移量,使用指定的endian 字節序格式讀取一個32 位元浮點數。 若參數 noAssert 為 true 將不會驗證 offset 偏移量參數。 這意味著 offset 可能會超出buffer的末尾。預設是 false。
32buf.readFloatBE(offset[, noAssert])
#根據指定的偏移量,使用指定的 endian 位元組序格式讀取一個 32 位元浮點數。 若參數 noAssert 為 true 將不會驗證 offset 偏移量參數。 這意味著 offset 可能會超出buffer的末尾。預設是 false。
33buf.readDoubleLE(offset[, noAssert])
根據指定的偏移量,使用指定的endian字節序格式讀取一個64 位元double。 若參數 noAssert 為 true 將不會驗證 offset 偏移量參數。 這意味著 offset 可能會超出buffer 的末尾。預設是 false。
34buf.readDoubleBE(offset[, noAssert])
根據指定的偏移量,使用指定的endian字節序格式讀取一個64 位元double。 若參數 noAssert 為 true 將不會驗證 offset 偏移量參數。 這意味著 offset 可能會超出buffer 的末尾。預設是 false。
35buf.writeUInt8(value, offset[, noAssert])
根據傳入的offset 偏移量將value寫入buffer。注意:value 必須是一個合法的有符號 8 位元整數。 若參數 noAssert 為 true 將不會驗證 offset 偏移量參數。 這意味著 value 可能過大,或者 offset 可能會超出 buffer 的末尾從而造成 value 被丟棄。 除非你對這個參數非常有把握,否則不要使用。預設是 false。
36buf.writeUInt16LE(value, offset[, noAssert])
根據傳入的offset 偏移量和指定的endian 格式將value 寫入buffer。注意:value 必須是一個合法的有符號 16 位元整數。 若參數 noAssert 為 true 將不會驗證 value 和 offset 偏移量參數。 這意味著 value 可能過大,或者 offset 可能會超出buffer的末尾從而造成 value 被丟棄。 除非你對這個參數非常有把握,否則盡量不要使用。預設是 false。
37buf.writeUInt16BE(value, offset[, noAssert])
根據傳入的offset 偏移量和指定的endian 格式將value 寫入buffer。注意:value 必須是一個合法的有符號 16 位元整數。 若參數 noAssert 為 true 將不會驗證 value 和 offset 偏移量參數。 這意味著 value 可能過大,或者 offset 可能會超出buffer的末尾從而造成 value 被丟棄。 除非你對這個參數非常有把握,否則盡量不要使用。預設是 false。
38buf.writeUInt32LE(value, offset[, noAssert])
根據傳入的 offset 偏移量和指定的 endian 格式將 value 寫入buffer。注意:value 必須是一個合法的有符號 32 位元整數。 若參數 noAssert 為 true 將不會驗證 value 和 offset 偏移量參數。 這意味著value 可能過大,或者offset可能會超出buffer的末尾從而造成 value 被丟棄。 除非你對這個參數非常有把握,否則盡量不要使用。預設是 false。
39buf.writeUInt32BE(value, offset[, noAssert])
根據傳入的offset 偏移量和指定的endian 格式將value 寫入buffer。注意:value 必須是一個合法的有符號 32 位元整數。 若參數 noAssert 為 true 將不會驗證 value 和 offset 偏移量參數。 這意味著value 可能過大,或者offset可能會超出buffer的末尾從而造成 value 被丟棄。 除非你對這個參數非常有把握,否則盡量不要使用。預設是 false。
40buf.writeInt8(value, offset[, noAssert])<br根據傳入的offset="" 偏移量將="" value="" 寫入="" buffer="" 。注意:value="" 必須是合法的="" signed="" 8="" 位元整數。 ="" 若參數="" noassert="" 為="" true="" 將不會驗證="" 和="" 偏移參數。 ="" 這表示="" 可能過大,或="" 可能會超出="" 的末端因而造成="" 被丟棄。 ="" 除非你對這個參數非常有把握,否則盡量不要使用。預設是="" false。 <="" td="">
41buf.writeInt16LE(value, offset[, noAssert])
根據傳入的offset 偏移量和指定的endian 格式將value 寫入buffer。注意:value 必須是一個合法的 signed 16 位元整數。 若參數 noAssert 為 true 將不會驗證 value 和 offset 偏移量參數。 這意味著 value 可能過大,或者 offset 可能會超出 buffer 的末尾從而造成 value 被丟棄。 除非你對這個參數非常有把握,否則盡量不要使用。預設是 false 。
42buf.writeInt16BE(value, offset[, noAssert])
根據傳入的offset 偏移量和指定的endian 格式將value 寫入buffer。注意:value 必須是一個合法的 signed 16 位元整數。 若參數 noAssert 為 true 將不會驗證 value 和 offset 偏移量參數。 這意味著 value 可能過大,或者 offset 可能會超出 buffer 的末尾從而造成 value 被丟棄。 除非你對這個參數非常有把握,否則盡量不要使用。預設是 false 。
43buf.writeInt32LE(value, offset[, noAssert])
根據傳入的 offset 偏移量和指定的 endian 格式將 value 寫入 buffer。注意:value 必須是一個合法的 signed 32 位元整數。 若參數 noAssert 為 true 將不會驗證 value 和 offset 偏移量參數。 這意味著 value 可能過大,或者 offset 可能會超出 buffer 的末尾從而造成 value 被丟棄。 除非你對這個參數非常有把握,否則盡量不要使用。預設是 false。
44buf.writeInt32BE(value, offset[, noAssert])
根據傳入的offset 偏移量和指定的endian 格式將value 寫入buffer。注意:value 必須是一個合法的 signed 32 位元整數。 若參數 noAssert 為 true 將不會驗證 value 和 offset 偏移量參數。 這意味著 value 可能過大,或者 offset 可能會超出 buffer 的末尾從而造成 value 被丟棄。 除非你對這個參數非常有把握,否則盡量不要使用。預設是 false。
45buf.writeFloatLE(value, offset[, noAssert])
根據傳入的offset 偏移量和指定的endian 格式將value 寫入buffer 。注意:當 value 不是一個 32 位元浮點數類型的值時,結果將是不確定的。 若參數 noAssert 為 true 將不會驗證 value 和 offset 偏移量參數。 這意味著 value可能過大,或者 offset 可能會超出 buffer 的末尾從而造成 value 被丟棄。 除非你對這個參數非常有把握,否則盡量不要使用。預設是 false。
46buf.writeFloatBE(value, offset[, noAssert])
根據傳入的offset 偏移量和指定的endian 格式將value 寫入buffer 。注意:當 value 不是一個 32 位元浮點數類型的值時,結果將是不確定的。 若參數 noAssert 為 true 將不會驗證 value 和 offset 偏移量參數。 這意味著 value可能過大,或者 offset 可能會超出 buffer 的末尾從而造成 value 被丟棄。 除非你對這個參數非常有把握,否則盡量不要使用。預設是 false。
47buf.writeDoubleLE(value, offset[, noAssert])
根據傳入的offset 偏移量和指定的endian 格式將value 寫入buffer。注意:value 必須是一個有效的 64 位元double 類型的值。 若參數 noAssert 為 true 將不會驗證 value 和 offset 偏移量參數。 這意味著 value 可能過大,或者 offset 可能會超出 buffer 的末尾從而造成value被丟棄。 除非你對這個參數非常有把握,否則盡量不要使用。預設是 false。
48buf.writeDoubleBE(value, offset[, noAssert])
根據傳入的 offset 偏移量和指定的 endian 格式將 value 寫入 buffer。注意:value 必須是一個有效的 64 位元double 類型的值。 若參數 noAssert 為 true 將不會驗證 value 和 offset 偏移量參數。 這意味著 value 可能過大,或者 offset 可能會超出 buffer 的末尾從而造成value被丟棄。 除非你對這個參數非常有把握,否則盡量不要使用。預設是 false。
49buf.fill(value[, offset][, end])
使用指定的value 來填入這個buffer 。如果沒有指定 offset (預設為 0) 且 end (預設是 buffer.length) ,將會填入整個buffer。
#