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