Node.js Stream(流)

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

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

  • Readable - 可讀操作。

  • Writable - 可寫操作。

  • Duplex - 可讀可寫操作.

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

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

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

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

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

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

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


從流中讀取數據

創建 input.txt 文件,內容如下:

菜鳥教程官網地址:rb.wikimirror.xyz

創建 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("程序執行完畢");

以上代碼執行結果如下:

程序執行完畢
菜鳥教程官網地址:rb.wikimirror.xyz

寫入流

創建 main.js 文件, 代碼如下:

var fs = require("fs");
var data = '菜鳥教程官網地址:rb.wikimirror.xyz';

// 創建一個可以寫入的流,寫入到文件 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 
菜鳥教程官網地址:rb.wikimirror.xyz

管道流

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

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

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

設置 input.txt 文件內容如下:

菜鳥教程官網地址:rb.wikimirror.xyz
管道流操作實例

創建 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 
菜鳥教程官網地址:rb.wikimirror.xyz
管道流操作實例

鏈式流

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

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

創建 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 
文件解壓完成。