Node.js Stream(流)

Stream 是 Node.js 中非常重要的一個模塊，應(yīng)用廣泛。

Stream 是一個抽象接口，Node 中有很多對象實(shí)現(xiàn)了這個接口。例如，對http 服務(wù)器發(fā)起請求的request 對象就是一個 Stream，還有stdout（標(biāo)準(zhǔn)輸出）。

該抽象接口是可讀、可寫或是既可讀又可寫的，通過這些接口，我們可以和磁盤文件、套接字、HTTP請求來交互，實(shí)現(xiàn)數(shù)據(jù)從一個地方流動到另一個地方的功能。

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

• Readable - 可讀操作。

• Writable - 可寫操作。

• Duplex - 可讀可寫操作.

• Transform - 操作被寫入數(shù)據(jù)，然后讀出結(jié)果。

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

• data - 當(dāng)有數(shù)據(jù)可讀時觸發(fā)。

• end - 沒有更多的數(shù)據(jù)可讀時觸發(fā)。

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

• finish - 所有數(shù)據(jù)已被寫入到底層系統(tǒng)時觸發(fā)。

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

從流中讀取數(shù)據(jù)

創(chuàng)建 input.txt 文件，內(nèi)容如下：

W3Cschool教程官網(wǎng)地址：o2fo.com

創(chuàng)建 main.js 文件, 代碼如下：

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

// 創(chuàng)建可讀流
var readerStream = fs.createReadStream('input.txt');

// 設(shè)置編碼為 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("程序執(zhí)行完畢");

以上代碼執(zhí)行結(jié)果如下：

程序執(zhí)行完畢
W3Cschool教程官網(wǎng)地址：o2fo.com

寫入流

創(chuàng)建 main.js 文件, 代碼如下：

var fs = require("fs");
var data = 'W3Cschool教程官網(wǎng)地址：o2fo.com';

// 創(chuàng)建一個可以寫入的流，寫入到文件 output.txt 中
var writerStream = fs.createWriteStream('output.txt');

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

// 標(biāo)記文件末尾
writerStream.end();

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

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

console.log("程序執(zhí)行完畢");

以上程序會將 data 變量的數(shù)據(jù)寫入到 output.txt 文件中。代碼執(zhí)行結(jié)果如下：

$ node main.js 
程序執(zhí)行完畢
寫入完成。

查看 output.txt 文件的內(nèi)容：

$ cat output.txt 
W3Cschool教程官網(wǎng)地址：o2fo.com

管道流

如上面的圖片所示，我們把文件比作裝水的桶，而水就是文件里的內(nèi)容，我們用一根管子(pipe)連接兩個桶使得水從一個桶流入另一個桶，這樣就慢慢的實(shí)現(xiàn)了大文件的復(fù)制過程。

以下實(shí)例我們通過讀取一個文件內(nèi)容并將內(nèi)容寫入到另外一個文件中。

設(shè)置 input.txt 文件內(nèi)容如下：

W3Cschool教程官網(wǎng)地址：o2fo.com
管道流操作實(shí)例

創(chuàng)建 main.js 文件, 代碼如下：

var fs = require("fs");

// 創(chuàng)建一個可讀流
var readerStream = fs.createReadStream('input.txt');

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

// 管道讀寫操作
// 讀取 input.txt 文件內(nèi)容，并將內(nèi)容寫入到 output.txt 文件中
readerStream.pipe(writerStream);

console.log("程序執(zhí)行完畢");

代碼執(zhí)行結(jié)果如下：

$ node main.js 
程序執(zhí)行完畢

查看 output.txt 文件的內(nèi)容：

$ cat output.txt 
W3Cschool教程官網(wǎng)地址：o2fo.com
管道流操作實(shí)例

鏈?zhǔn)搅?/h2>

鏈?zhǔn)绞峭ㄟ^連接輸出流到另外一個流并創(chuàng)建多個對個流操作鏈的機(jī)制。鏈?zhǔn)搅饕话阌糜诠艿啦僮鳌?/p>

接下來我們就是用管道和鏈?zhǔn)絹韷嚎s和解壓文件。

創(chuàng)建 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("文件壓縮完成。");

代碼執(zhí)行結(jié)果如下：

$ node compress.js 
文件壓縮完成。

執(zhí)行完以上操作后，我們可以看到當(dāng)前目錄下生成了 input.txt 的壓縮文件 input.txt.gz。

接下來，讓我們來解壓該文件，創(chuàng)建 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("文件解壓完成。");

代碼執(zhí)行結(jié)果如下：

$ node decompress.js 
文件解壓完成。