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.w3cschool.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.w3cschool.cn"); console.log("寫入位元組數 : "+ len);
執行以上代碼,輸出結果為:
$node main.js 寫入位元組數 : 16
從緩沖區讀取資料
讀取 Node 緩沖區資料的文法如下所示:
buf.toString([encoding[,start[,end]]])
- 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.w3cschool.cn'); var json = buf.toJSON(buf); console.log(json);
{ type: 'Buffer', data: [ 119, 119, 119, 46, 119, 51, 99, 115, 99, 104, 111, 111, 108, 46, 99, 110 ] }
緩沖區合并
Node 緩沖區合并的文法如下所示:
Buffer.concat(list[, totalLength])
- list - 用于合并的 Buffer 對象數組清單。
- totalLength - 指定合并後Buffer對象的總長度。
傳回一個多個成員合并的新 Buffer 對象。
var buffer1 = new Buffer('W3Cschool教程 '); var buffer2 = new Buffer('www.w3cschool.cn'); var buffer3 = Buffer.concat([buffer1,buffer2]); console.log("buffer3 内容: " + buffer3.toString());
buffer3 内容: W3Cschool教程 www.w3cschool.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(target[, 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('youj'); // 剪切緩沖區 var buffer2 = buffer1.slice(0,2); console.log("buffer2 content: " + buffer2.toString());
buffer2 content: yo
緩沖區長度
Node 緩沖區長度計算文法如下所示:
buf.length;
傳回 Buffer 對象所占據的記憶體長度。
var buffer = new Buffer('www.w3cschool.cn'); // 緩沖區長度 console.log("buffer length: " + buffer.length);
buffer length: 16
方法參考手冊
以下列出了 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 位計算,例如: 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]) |
9 | buf.writeIntBE(value, offset, byteLength[, noAssert]) |
10 | buf.readUIntLE(offset, byteLength[, noAssert]) 支援讀取 48 位以下的數字。noAssert 值為 true 時, offset 不再驗證是否超過 buffer 的長度,預設為 false。 |
11 | buf.readUIntBE(offset, byteLength[, noAssert]) |
12 | buf.readIntLE(offset, byteLength[, noAssert]) |
13 | buf.readIntBE(offset, byteLength[, noAssert]) |
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(target[, 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]) |
24 | buf.readUInt32LE(offset[, noAssert]) 根據指定的偏移量,使用指定的 endian 位元組序格式讀取一個有符号 32 位整數。若參數 noAssert 為 true 将不會驗證 offset 偏移量參數。 這意味着 offset 可能會超出buffer 的末尾。預設是 false。 |
25 | buf.readUInt32BE(offset[, noAssert]) |
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]) |
29 | buf.readInt32LE(offset[, noAssert]) 根據指定的偏移量,使用指定的 endian 位元組序格式讀取一個 signed 32 位整數。若參數 noAssert 為 true 将不會驗證 offset 偏移量參數。 這意味着 offset 可能會超出buffer 的末尾。預設是 false。 |
30 | buf.readInt32BE(offset[, noAssert]) |
31 | buf.readFloatLE(offset[, noAssert]) 根據指定的偏移量,使用指定的 endian 位元組序格式讀取一個 32 位浮點數。若參數 noAssert 為 true 将不會驗證 offset 偏移量參數。 這意味着 offset 可能會超出buffer的末尾。預設是 false。 |
32 | buf.readFloatBE(offset[, noAssert]) |
33 | buf.readDoubleLE(offset[, noAssert]) 根據指定的偏移量,使用指定的 endian位元組序格式讀取一個 64 位double。若參數 noAssert 為 true 将不會驗證 offset 偏移量參數。 這意味着 offset 可能會超出buffer 的末尾。預設是 false。 |
34 | buf.readDoubleBE(offset[, noAssert]) |
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]) |
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]) |
40 | buf.writeInt8(value, offset[, noAssert]) |