Node.js Stream(流)

Node.js Stream(流)

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

Node.js,Stream 有四種流型別:

  • Readable - 可讀操作。

  • Writable - 可寫操作。

  • Duplex - 可讀可寫操作.

  • Transform - 操作被寫入資料,然後讀出結果。

所有的 Stream 物件都是 EventEmitter 的例項。常用的事件有:

  • data - 當有資料可讀時觸發。

  • end - 沒有更多的資料可讀時觸發。

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

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

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


從流中讀取資料

建立 input.txt 檔案,內容如下:

入門教學官網地址:www.itread01.com

建立 main.js 檔案, 程式碼如下:

var fs = require("fs");
var datahttps://www.itread01.com/nodejs/= '';

// 建立可讀流
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("程式執行完畢");

以上程式碼執行結果如下:

程式執行完畢
入門教學官網地址:www.itread01.com

寫入流

建立 main.js 檔案, 程式碼如下:

var fs = require("fs");
var datahttps://www.itread01.com/nodejs/= '入門教學官網地址:www.itread01.com';

// 建立一個可以寫入的流,寫入到檔案 output.txt 中
var writerStream = fs.createWriteStream('output.txt');

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

// 標記檔案末尾
writerStream.end();

// 處理流事件 --> finish、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 
入門教學官網地址:www.itread01.com

管道流

管道提供了一個輸出流到輸入流的機制。通常我們用於從一個流中獲取資料並將資料傳遞到另外一個流中。

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

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

設定 input.txt 檔案內容如下:

入門教學官網地址:www.itread01.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 
入門教學官網地址:www.itread01.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 
檔案解壓完成。