Latest web development tutorials

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 堆內存之外的一塊原始內存。


創建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.w3big.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.w3big.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.w3big.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.w3big.com');
var buffer3 = Buffer.concat([buffer1,buffer2]);
console.log("buffer3 内容: " + buffer3.toString());

執行以上代碼,輸出結果為:

buffer3 内容: 本教程 www.w3big.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('w3big');
// 剪切缓冲区
var buffer2 = buffer1.slice(0,2);
console.log("buffer2 content: " + buffer2.toString());

執行以上代碼,輸出結果為:

buffer2 content: ru

緩衝區長度

語法

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

buf.length;

返回值

返回Buffer 對象所佔據的內存長度。

實例

var buffer = new Buffer('www.w3big.com');
//  缓冲区长度
console.log("buffer length: " + buffer.length);

執行以上代碼,輸出結果為:

buffer length: 14

方法參考手冊

以下列出了Node.js Buffer 模塊常用的方法(注意有些方法在舊版本是沒有的):

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