「译」Node.js Streams 基础

Node.js 天生异步和事件驱动，很是适合处理 I/O 相关的任务。若是你在处理应用中 I/O 相关的操做，你能够利用 Node.js 中的流(stream)。所以，咱们先具体看看流，理解一下它们是怎么简化 I/O 操做的吧。

流是什么

流是 unix 管道，让你能够很容易地从数据源读取数据，而后流向另外一个目的地。
简单来讲，流不是什么特别的东西，它只是一个实现了一些方法的 EventEmitter。根据它实现的方法，流能够变成可读流(Readable)，可写流(Writable)，或者双向流(Duplex，同时可读可写)。
可读流能让你从一个数据源读取数据，而可写流则可让你往目的地写入数据。

若是你已经用过 Node.js，你极可能已经遇到过流了。
例如，在一个 Node.js 的 HTTP 服务器里面，request 是一个可读流，response 是一个可写流。
你也可能用过 fs 模块，它能帮你处理可读可写流。

如今让你学一些基础，理解不一样类型的流。本文会讨论可读流和可写流，双向流超出了本文的讨论范围，咱们不做讨论。

可读流 (Readable Streams)

咱们能够用可读流从一个数据源中读取数据，这个数据源能够是任何东西，例如系统中的一个文件，内存中的 buffer，甚至是其余流。由于流是 EventEmitter，它们会用各类事件发送数据。咱们会利用这些事件来让流工做。

从流中读取数据

从流中读取数据最好的方式是监听 data 事件，添加一个回调函数。当有数据流过来的时候，可读流会发送 data 事件，回调函数就会触发。看看下面的代码片断：

var fs = require('fs');
var readableStream = fs.createReadStream('file.txt');
var data = '';

var readableStream.on('data', function(chunk) {
  data += chunk;
});

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

fs.createReadStream 会给你一个可读流。
最开始的时候，这个流不是流动态的。当你添加了 data 的事件监听器，加上一个回调函数时，它才会变成流动态的。在这以后，它就会读取一小块数据，而后传到你的回调函数里面。
流的实现者决定了 data 事件的触发频率，例如 HTTP request 会在读取到几 KB 数据的时候触发 data 事件。 当你从一个文件中读取数据的时候，你可能会决定当一行被读完的时候就触发 data 事件。

当没有数据可读的时候 (读到文件尾部时)，流就会发送 end 事件。在上面的例子中，咱们监听了这个事件，当读完文件的时候，就把数据打印出来。

还有另外一种读取流的方式，你只要在读到文件尾部前不断调用流实例中的 read() 方法就能够了。

var fs = require('fs');
var readableStream = fs.createReadStream('file.txt');
var data = '';
var chunk;

readableStream.on('readable', function() {
  while ((chunk = readableStream.read()) != null) {
    data += chunk;
  }
});

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

read() 方法会从内部 buffer 中读取数据，当没有数据可读的时候，它会返回 null。
所以，在 while 循环中咱们检查 read() 是否是返回 null，当它返回 null 的时候，就终止循环。
须要注意的是，当咱们能够从流中读取数据的时候，readable 事件就会触发。

设置编码

默认状况下，你从流中读取到的是 Buffer 对象。若是你要读取的是字符串的话，这并不适合你。所以，你能够像下面的例子那样经过调用 Readable.setEncoding() 来设置流的编码：

var fs = require('fs');
var readableStream = fs.createReadStream('file.txt');
var data = '';

readableStream.setEncoding('utf8');

readableStream.on('data', function(chunk) {
  data += chunk;
});

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

上面的例子中，咱们把流的编码设置成 utf8，数据就会被解析成 utf8，回调函数中的 chunk 就会是字符串了。

管道 (Piping)

管道是一个很棒的机制，你不须要本身管理流的状态就能够从数据源中读取数据，而后写入到目的地中。咱们先看看下面的例子：

var fs = require('fs');
var readableStream = fs.createReadStream('file1.txt');
var writableStream = fs.createWriteStream('file2.txt');

readableStream.pipe(writableStream);

上面的例子利用 pipe() 方法把 file1 的内容写到 file2 中。由于 pipe() 会帮你管理数据流，你不须要担忧数据流的速度。这让 pipe() 变得很是简洁易用。
须要注意的是，pipe() 会返回目的地的流，所以你能够很轻易让多个流连接起来！

连接 (Chaining)

假设有一个归档文件，你想要解压它。有不少方式能够完成这个任务。但最简洁的方式是利用管道和连接：

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

fs.createReadStream('input.txt.gz')
  .pipe(zlib.createGunzip())
  .pipe(fs.createWriteStream('output.txt'));

首先，咱们经过 input.txt.gz 建立了一个可读流，而后让它流向 zlib.createGunzip() 流，它会解压内容。最后，咱们添加一个可写流把解压后的内容写到另外一个文件中。

其余方法

咱们已经讨论了一些可读流中重要的概念了，这里还有一些你须要知道的方法：

1. Readable.pause() - 这个方法会暂停流的流动。换句话说就是它不会再触发 data 事件。

2. Readable.resume() - 这个方法和上面的相反，会让暂停流恢复流动。

3. Readable.unpipe() - 这个方法会把目的地移除。若是有参数传入，它会让可读流中止流向某个特定的目的地，不然，它会移除全部目的地。

可写流 (Writable Streams)

可写流让你把数据写入目的地。就像可读流那样，这些也是 EventEmitter，它们也会触发不一样的事件。咱们来看看可写流中会触发的事件和方法吧。

写入流

要把数据写如到可写流中，你须要在可写流实例中调用 write() 方法，看看下面的例子：

var fs = require('fs');
var readableStream = fs.createReadStream('file1.txt');
var writableStream = fs.createWriteStream('file2.txt');

readableStream.setEncoding('utf8');

readableStream.on('data', function(chunk) {
  writableStream.write('chunk');
});

上面的代码很是简单，它只是从输入流中读取数据，而后用 write() 写入到目的地中。
这个方法返回一个布尔值来表示写入是否成功。若是返回的是 true 那表示写入成功，你能够继续写入更多的数据。 若是是 false，那意味着发生了什么错误，你如今不能继续写入了。可写流会触发一个 drain 事件来告诉你你能够继续写入数据。

写完数据后

当你不须要在写入数据的时候，你能够调用 end() 方法来告诉流你已经完成写入了。假设 res 是一个 HTTP response 对象，你一般会发送响应给浏览器：

res.write('Some Data!!');
res.end();

当 end() 被调用时，全部数据会被写入，而后流会触发一个 finish 事件。注意在调用 end() 以后，你就不能再往可写流中写入数据了。例以下面的代码就会报错：

res.write('Some Data!!');
res.end();
res.write('Trying to write again'); //Error !

这里有一些和可写流相关的重要事件：

1. error - 在写入或连接发生错误时触发

2. pipe - 当可读流连接到可写流时，这个事件会触发

3. unpipe - 在可读流调用 unpipe 时会触发

结论

这些是关于流的基础知识。流，管道，连接是核心，它们是 Node.js 中最强大的功能。若是使用得当，流能够帮助你写出简洁并且高性能的代码。

出处

http://scarletsky.github.io/2016/07/01/basics-node-js-streams/

参考资料

https://www.sitepoint.com/basics-node-js-streams/