Node.js Stream(流)

Stream 是一個抽象介面，Node 中有很多對象實現了這個介面。例如，對http 伺服器發起請求的request 對象就是一個 Stream，還有stdout（標準輸出）。

Node.js，Stream 有四種流類型：

• Readable - 可讀操作。

• Writable - 可寫操作。

• Duplex - 可讀可寫操作.

• Transform - 操作被寫入數據，然後讀出結果。

所有的 Stream 對象都是 EventEmitter 的實例。常用的事件有：

• data - 當有數據可讀時觸發。

• end - 沒有更多的數據可讀時觸發。

• error - 在接收和寫入過程中發生錯誤時觸發。

• finish - 所有數據已被寫入到底層系統時觸發。

本教程會為大家介紹常用的流操作。

從流中讀取數據

創建 input.txt 檔，內容如下：

IT研修官網地址：www.xuhuhu.com

創建 main.js 檔, 代碼如下：

var fs = require("fs");
var data = '';

// 創建可讀流

var readerStream = fs.createReadStream('input.txt');

// 設置編碼為 utf8。

readerStream.setEncoding('UTF8');

// 處理流事件 --> data, end, and error
readerStream.on('data', function(chunk) {
   data += chunk;
});

readerStream.on('end',function(){
   console.log(data);
});

readerStream.on('error', function(err){
   console.log(err.stack);
});

console.log("程式執行完畢");

以上代碼執行結果如下：

程式執行完畢
IT研修官網地址：www.xuhuhu.com

寫入流

創建 main.js 檔, 代碼如下：

var fs = require("fs");
var data = 'IT研修官網地址：www.xuhuhu.com';

// 創建一個可以寫入的流，寫入到檔 output.txt 中

var writerStream = fs.createWriteStream('output.txt');

// 使用 utf8 編碼寫入數據
writerStream.write(data,'UTF8');

// 標記檔末尾

writerStream.end();

// 處理流事件 --> data, end, and error
writerStream.on('finish', function() {
    console.log("寫入完成。");
});

writerStream.on('error', function(err){
   console.log(err.stack);
});

console.log("程式執行完畢");

以上程式會將 data 變數的數據寫入到 output.txt 檔中。代碼執行結果如下：

$ node main.js
程式執行完畢
寫入完成。

查看 output.txt 檔的內容：

$ cat output.txt
IT研修官網地址：www.xuhuhu.com

管道流

如上面的圖片所示，我們把檔比作裝水的桶，而水就是檔裏的內容，我們用一根管子(pipe)連接兩個桶使得水從一個桶流入另一個桶，這樣就慢慢的實現了大檔的複製過程。

以下實例我們通過讀取一個檔內容並將內容寫入到另外一個檔中。

設置 input.txt 檔內容如下：

IT研修官網地址：www.xuhuhu.com
管道流操作實例

創建 main.js 檔, 代碼如下：

var fs = require("fs");

// 創建一個可讀流

var readerStream = fs.createReadStream('input.txt');

// 創建一個可寫流
var writerStream = fs.createWriteStream('output.txt');

// 管道讀寫操作

// 讀取 input.txt 檔內容，並將內容寫入到 output.txt 檔中
readerStream.pipe(writerStream);

console.log("程式執行完畢");

代碼執行結果如下：

$ node main.js
程式執行完畢

查看 output.txt 檔的內容：

$ cat output.txt
IT研修官網地址：www.xuhuhu.com
管道流操作實例

鏈式流

鏈式是通過連接輸出流到另外一個流並創建多個流操作鏈的機制。鏈式流一般用於管道操作。

接下來我們就是用管道和鏈式來壓縮和解壓檔。

創建 compress.js 檔, 代碼如下：

var fs = require("fs");
var zlib = require('zlib');

// 壓縮 input.txt 檔為 input.txt.gz
fs.createReadStream('input.txt')
  .pipe(zlib.createGzip())
  .pipe(fs.createWriteStream('input.txt.gz'));

console.log("檔壓縮完成。");

代碼執行結果如下：

$ node compress.js
檔壓縮完成。

執行完以上操作後，我們可以看到當前目錄下生成了 input.txt 的壓縮檔 input.txt.gz。

接下來，讓我們來解壓該檔，創建 decompress.js 檔，代碼如下：

var fs = require("fs");
var zlib = require('zlib');

// 解壓 input.txt.gz 檔為 input.txt
fs.createReadStream('input.txt.gz')
  .pipe(zlib.createGunzip())
  .pipe(fs.createWriteStream('input.txt'));

console.log("檔解壓完成。");

代碼執行結果如下：

$ node decompress.js
檔解壓完成。