十一、Node.js Stream (流)

流 ( Stream) 是一组有顺序的，有起点和终点的字节集合，是对数据传输的总称或抽象

数据在两设备间的传输称为流，流的本质是数据传输

Node.js Stream 是一个抽象接口

Node.js 中有很多对象实现了这个接口，例如，对 http 服务器发起请求的 request 对象就是一个 Stream，还有 stdout ( 标准输出 )

Node.js Stream 有四种流类型

流类型	描述
Readable	可读操作
Writable	可写操作
Duplex	可读可写操作
Transform	操作被写入数据，然后读出结果

Node.js 中 所有的 Stream 对象都是 EventEmitter 的实例

Stream 对象常用的事件有

事件	描述
data	当有数据可读时触发
end	没有更多的数据可读时触发
error	在接收和写入过程中发生错误时触发
finish	所有数据已被写入到底层系统时触发

接下来我们将学习 Stream 的常用操作

从流中读取数据

假设当前目录下存在 demo.txt 文件，内容如下

HelloWorld

接下来我们使用 fs.createReadStream 方法创建读取流

然后实现 stream.data 事件输出数据

main.js

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

// 创建可读流
var readerStream = fs.createReadStream('demo.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("程序执行完毕");

运行以上 Node.js 脚本，输出结果如下

$ node main.js 
HelloWorld

写入流

Node.js fs.createWriteStream 方法可以创建一个写入流

范例

我们使用 fs.createWriteStream 创建一个写入流，将以下内容输出到 output.txt 文件中

HelloWorld

main.js

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

// 创建一个可以写入的流，写入到文件 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("程序执行完毕");

运行以上 Node.js 脚本，输出结果如下

$ node main.js 
程序执行完毕
写入完成

使用 cat output.txt 查看 output.txt 文件内容如下

$ cat output.txt 
HelloWorld

管道流

管道提供了一个输出流到输入流的机制

管道流通常用于从一个流中获取数据并将数据传递到另外一个流中

假如我们把文件比作装水的桶，而水就是文件里的内容，我们用一根管子(pipe)连接两个桶使得水从一个桶流入另一个桶，这样就慢慢的实现了大文件的复制过程

Node.js stream.pipe 可以用于创建管道流

范例

接下来我们使用 stream.pipe 从 demo.txt 文件中读取内容然后输出到 output.txt 文件中

我们先来看看 demo.txt 文件中的内容

$ cat demo.txt 
HelloWorld

然后使用 rm output.txt 移除已经存在的 output.txt 文件

main.js

var fs = require("fs");

// 创建一个可读流
var readerStream = fs.createReadStream('demo.txt');

// 创建一个可写流
var writerStream = fs.createWriteStream('output.txt');

// 管道读写操作
// 读取 demo.txt 文件内容，并将内容写入到 output.txt 文件中
readerStream.pipe(writerStream);

console.log("程序执行完毕");

运行以上 Node.js 范例，输出结果如下

$ node main.js 
程序执行完毕

查看 output.txt 文件的内容如下

$ cat output.txt 
HelloWorld

链式流

链式流是通过连接输出流到另外一个流并创建多个对个流操作链的机制

链式流一般用于管道操作

多次调用 stream.pipe 方法可以创建链式流

范例

我们使用管道流和链式流来压缩文件

main.js

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

// 压缩 demo.txt 文件为 input.txt.gz
fs.createReadStream('demo.txt')
  .pipe(zlib.createGzip())
  .pipe(fs.createWriteStream('demo.txt.gz'));

console.log("文件压缩完成。");

运行以上 Node.js 范例，输出结果如下

$ node main.js  
文件压缩完成。

使用 ls -lh demo.txt.gz 命令可以看到当前目录下存在 demo.txt.gz 文件

$ ls -lh demo.txt.gz 
-rw-r--r-- 1 penglei staff 78 10 25 19:45 demo.txt.gz