Node.js之Buffer

什麼是 Buffer

如同官方 API 中介紹的那樣，在 ES6 引入 TypedArray 之前，JavaScript 沒有讀取或者操作二進制資料流的機制。 Buffer 類作為 NodeJS API 的一部分被引入，以便能夠和 TCP 等網絡流和檔案流等進行互動。

現在 TypedArray 已經被添加到了 ES6 中，Buffer 類以一種更優化和适用于 NodeJS 操作的方式實作了 Unit8Array API。

總而言之，Buffer 類是用來處理二進制資料，因為太常用了，是以直接放在了全局變量裡，使用的時候無需 require。

Buffer 類的執行個體類似于整型數組，不過緩沖區的大小在建立時确定，不能調整。Buffer 對象不同之處在于它不經 V8 的記憶體配置設定機制，Buffer 是一個 JavaScript 和 C++ 結合的子產品，記憶體由 C++ 申請，JavaScript 配置設定。

關于 Buffer 記憶體配置設定相關知識不展開讨論，感興趣同學可以看看樸老濕的書。

執行個體化 Buffer

在 NodeJS v6 之前都是通過調用構造函數的方式執行個體化 Buffer，根據參數傳回不同結果。處于安全性原因，這種方式在 v6 後的版本中已經被廢除，提供了

Buffer.from()

Buffer.alloc()

Buffer.allocUnsafe()

三個單獨的，職責清晰的函數處理執行個體化 Buffer 的工作。

Buffer.from(array)：傳回一個内容包含所提供的位元組副本的 Buffer，數組中每一項是一個表示八位位元組的數字，是以值必須在 0 ~ 255 之間，否則會取模

Buffer.from(arrayBuffer)：傳回一個與給定的 ArrayBuffer 共享記憶體的新 Buffer

Buffer.from(buffer)：傳回給定 Buffer 的一個副本 Buffer

Buffer.from(string [, encoding])：傳回一個包含給定字元串的 Buffer

Buffer.alloc(size [, fill [, encoding]])：傳回指定大小并且“已填充”的 Buffer

Buffer.allocUnsafe(size)：傳回指定大小的 Buffer，内容必須用 buf.fill(0) 等方法填充

// 0x 表示 16 進制

Buffer.from([1, 2, 3]) // [0x1, 0x2, 0x3]
Buffer.from('test', 'utf-8') // [0x74, 0x65, 0x73, 0x74]
Buffer.alloc(5, 1) // [0x1, 0x1, 0x1, 0x1, 0x1]
Buffer.allocUnsafe(5); // 值不确定，後面詳談           

Buffer.allocUnsafe()

的執行會快于

Buffer.alloc()

看名字很不安全，确實也不安全。

當調用

Buffer.allocUnsafe()

時配置設定的記憶體段尚未初始化（不歸零），這樣配置設定記憶體速度很塊，但配置設定到的記憶體片段可能包含舊資料。如果在使用的時候不覆寫這些舊資料就可能造成記憶體洩露，雖然速度快，盡量避免使用。

編碼

Buffer 支援以下幾種編碼格式

ascii

utf8

utf16le

base64

binary

hex

Buffer 和 String 轉換

字元串轉為 Buffer 比較簡單

Buffer.from(string [, encoding])           

同時 Buffer 執行個體也有 toString 方法将 Buffer 轉為字元串

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

Buffer 拼接

使用 concat 方法可以講多個 Buffer 執行個體拼接為一個 Buffer 執行個體

Buffer.concat(list[, totalLength])           

StringDecoder

在 NodeJS 中一個漢字由三個位元組表示，如果我們進行中文字元的時候使用了不是3的倍數的位元組數就會造成字元拼接亂碼問題。

const buf = Buffer.from('中文字元串！');

for(let i = 0; i < buf.length; i+=5){
  var b = Buffer.allocUnsafe(5);
  buf.copy(b, 0, i);
  console.log(b.toString());
}           

這樣可以看到結果中出現了亂碼

但如果使用 string_decoder 子產品便可以解決這個問題

const StringDecoder = require('string_decoder').StringDecoder;
const decoder = new StringDecoder('utf8');
const buf = Buffer.from('中文字元串！');
for(let i = 0; i < buf.length; i+=5){
  var b = Buffer.allocUnsafe(5);
  buf.copy(b, 0, i);
  console.log(decoder.write(b));
}           

StringDecoder 在得到編碼後，知道寬位元組在utf-8下占3個位元組，是以在處理末尾不全的位元組時，會保留到第二次 write()。目前隻能處理UTF-8、Base64 和 UCS-2/UTF-16LE。

Buffer 其它常用 API

還有一些 Buffer 常用的 API

Buffer.isBuffer：判斷對象是否為 Buffer

Buffer.isEncoding：判斷 Buffer 對象編碼

buf.length：傳回 記憶體為此 Buffer 執行個體所申請的位元組數，并不是 Buffer 執行個體内容的位元組數

buf.indexOf：和數組的 indexOf 類似，傳回某字元串、acsii 碼或者 buf 在改 buf 中的位置

buf.copy：将一個 buf 的（部分）内容複制到另外一個 buf 中