Node.js Stream 模块 pipe 方法使用与实现原理分析 - 图1

通过流我们可以将一大块数据拆分为一小部分一点一点的流动起来，而无需一次性全部读入，在 Linux 下我们可以通过 | 符号实现，类似的在 Nodejs 的 Stream 模块中同样也为我们提供了 pipe() 方法来实现。

1. Stream pipe 基本示例

选择 Koa 来实现这个简单的 Demo，因为之前有人在 “Nodejs技术栈” 交流群问过一个问题，怎么在 Koa 中返回一个 Stream，顺便在下文借此机会提下。

1.1 未使用 Stream pipe 情况

在 Nodejs 中 I/O 操作都是异步的，先用 util 模块的 promisify 方法将 fs.readFile 的 callback 形式转为 Promise 形式，这块代码看似没问题，但是它的体验不是很好，因为它是将数据一次性读入内存再进行的返回，当数据文件很大的时候也是对内存的一种消耗，类似内存泄漏这种问题也很容易出现，因此不推荐它。

  1. const Koa = require('koa');
  2. const fs = require('fs');
  3. const app = new Koa();
  4. const { promisify } = require('util');
  5. const { resolve } = require('path');
  6. const readFile = promisify(fs.readFile);
  8. app.use(async ctx => {
  9.   try {
  10.     ctx.body = await readFile(resolve(__dirname, 'test.json'));
  11.   } catch(err) { ctx.body = err };
  12. });
  14. app.listen(3000);

1.2 使用 Stream pipe 情况

下面，再看看怎么通过 Stream 的方式在 Koa 框架中响应数据

  1. ...
  2. app.use(async ctx => {
  3.   try {
  4.     const readable = fs.createReadStream(resolve(__dirname, 'test.json'));
  5.     ctx.body = readable;
  6.   } catch(err) { ctx.body = err };
  7. });

以上在 Koa 中直接创建一个可读流赋值给 ctx.body 就可以了，你可能疑惑了为什么没有 pipe 方法，因为框架给你封装好了，不要被表象所迷惑了，看下相关源码：

  1. // https://github.com/koajs/koa/blob/master/lib/application.js#L256
  2. function respond(ctx) {
  3.   ...
  4.   let body = ctx.body;
  5.   if (body instanceof Stream) return body.pipe(res);
  6.   ...
  7. }

没有神奇之处，框架在返回的时候做了层判断，因为 res 是一个可写流对象，如果 body 也是一个 Stream 对象（此时的 Body 是一个可读流），则使用 body.pipe(res) 以流的方式进行响应。

1.3 使用 Stream VS 不使用 Stream

Node.js Stream 模块 pipe 方法使用与实现原理分析 - 图2

Node.js Stream 模块 pipe 方法使用与实现原理分析 - 图3

看到一个图片，不得不说画的实在太萌了，来源 https://www.cnblogs.com/vajoy/p/6349817.html

2. pipe 的调用过程与实现原理

以上最后以流的方式响应数据最核心的实现就是使用 pipe 方法来实现的输入、输出，本节的重点也是研究 pipe 的实现，最好的打开方式通过阅读源码一起来看看吧。

2.1 顺藤摸瓜

在应用层我们调用了 fs.createReadStream() 这个方法，顺藤摸瓜找到这个方法创建的可读流对象的 pipe 方法实现，以下仅列举核心代码实现，基于 Nodejs v12.x 源码。

2.1.1 /lib/fs.js

导出一个 createReadStream 方法，在这个方法里面创建了一个 ReadStream 可读流对象，且 ReadStream 来自 internal/fs/streams 文件，继续向下找。

  1. // https://github.com/nodejs/node/blob/v12.x/lib/fs.js
  2. // 懒加载，主要在用到的时候用来实例化 ReadStream、WriteStream ... 等对象
  3. function lazyLoadStreams() {
  4.   if (!ReadStream) {
  5.     ({ ReadStream, WriteStream } = require('internal/fs/streams'));
  6.     [ FileReadStream, FileWriteStream ] = [ ReadStream, WriteStream ];
  7.   }
  8. }
  10. function createReadStream(path, options) {
  11.   lazyLoadStreams();
  12.   return new ReadStream(path, options); // 创建一个可读流
  13. }
  15. module.exports = fs = {
  16.   createReadStream, // 导出 createReadStream 方法
  17.   ...
  18. }

2.1.2 /lib/internal/fs/streams.js

这个方法里定义了构造函数 ReadStream，且在原型上定义了 open、_read、_destroy 等方法，并没有我们要找的 pipe 方法。

但是呢通过 ObjectSetPrototypeOf 方法实现了继承，ReadStream 继承了 Readable 在原型中定义的函数，接下来继续查找 Readable 的实现。

  1. // https://github.com/nodejs/node/blob/v12.x/lib/internal/fs/streams.js
  2. const { Readable, Writable } = require('stream');
  4. function ReadStream(path, options) {
  5.   if (!(this instanceof ReadStream))
  6.     return new ReadStream(path, options);
  8.   ...
  9.   Readable.call(this, options);
  10.   ...
  11. }
  12. ObjectSetPrototypeOf(ReadStream.prototype, Readable.prototype);
  13. ObjectSetPrototypeOf(ReadStream, Readable);
  15. ReadStream.prototype.open = function() { ... };
  17. ReadStream.prototype._read = function(n) { ... };;
  19. ReadStream.prototype._destroy = function(err, cb) { ... };
  20. ...
  22. module.exports = {
  23.   ReadStream,
  24.   WriteStream
  25. };

2.1.3 /lib/stream.js

在 stream.js 的实现中，有条注释：在 Readable/Writable/Duplex/… 之前导入 Stream，原因是为了避免 cross-reference(require)，为什么会这样？

第一步 stream.js 这里将 require(‘internal/streams/legacy’) 导出复制给了 Stream。

在之后的 _stream_readable、Writable、Duplex … 模块也会反过来引用 stream.js 文件，具体实现下面会看到。

Stream 导入了 internal/streams/legacy

上面 /lib/internal/fs/streams.js 文件从 stream 模块获取了一个 Readable 对象，就是下面的 Stream.Readable 的定义。

  1. // https://github.com/nodejs/node/blob/v12.x/lib/stream.js
  2. // Note: export Stream before Readable/Writable/Duplex/...
  3. // to avoid a cross-reference(require) issues
  4. const Stream = module.exports = require('internal/streams/legacy');
  6. Stream.Readable = require('_stream_readable');
  7. Stream.Writable = require('_stream_writable');
  8. Stream.Duplex = require('_stream_duplex');
  9. Stream.Transform = require('_stream_transform');
  10. Stream.PassThrough = require('_stream_passthrough');
  11. ...

2.1.4 /lib/internal/streams/legacy.js

上面的 Stream 等于 internal/streams/legacy，首先继承了 Events 模块，之后呢在原型上定义了 pipe 方法，刚开始看到这里的时候以为实现是在这里了，但后来看 _stream_readable 的实现之后，发现 _stream_readable 继承了 Stream 之后自己又重新实现了 pipe 方法，那么疑问来了这个模块的 pipe 方法是干嘛的？什么时候会被用？翻译文件名 “legacy=遗留”？有点没太理解，难道是遗留了？有清楚的大佬可以指点下，也欢迎在公众号 “Nodejs技术栈” 后台加我微信一块讨论下！

  1. // https://github.com/nodejs/node/blob/v12.x/lib/internal/streams/legacy.js
  2. const {
  3.   ObjectSetPrototypeOf,
  4. } = primordials;
  5. const EE = require('events');
  6. function Stream(opts) {
  7.   EE.call(this, opts);
  8. }
  9. ObjectSetPrototypeOf(Stream.prototype, EE.prototype);
  10. ObjectSetPrototypeOf(Stream, EE);
  12. Stream.prototype.pipe = function(dest, options) {
  13.   ...
  14. };
  16. module.exports = Stream;

2.1.5 /lib/_stream_readable.js

在 _stream_readable.js 的实现里面定义了 Readable 构造函数，且继承于 Stream，这个 Stream 正是我们上面提到的 /lib/stream.js 文件，而在 /lib/stream.js 文件里加载了 internal/streams/legacy 文件且重写了里面定义的 pipe 方法。

经过上面一系列的分析，终于找到可读流的 pipe 在哪里，同时也更进一步的认识到了在创建一个可读流时的执行调用过程，下面将重点来看这个方法的实现。

  1. module.exports = Readable;
  2. Readable.ReadableState = ReadableState;
  4. const EE = require('events');
  5. const Stream = require('stream');
  7. ObjectSetPrototypeOf(Readable.prototype, Stream.prototype);
  8. ObjectSetPrototypeOf(Readable, Stream);
  10. function Readable(options) {
  11.   if (!(this instanceof Readable))
  12.     return new Readable(options);
  14.   ...
  15.   Stream.call(this, options); // 继承自 Stream 构造函数的定义
  16. }
  17. ...

2.2 _stream_readable 实现分析

2.2.1 声明构造函数 Readable

声明构造函数 Readable 继承 Stream 的构造函数和原型。

Stream 是 /lib/stream.js 文件，上面分析了，这个文件继承了 events 事件，此时也就拥有了 events 在原型中定义的属性，例如 on、emit 等方法。

  1. const Stream = require('stream');
  2. ObjectSetPrototypeOf(Readable.prototype, Stream.prototype);
  3. ObjectSetPrototypeOf(Readable, Stream);
  5. function Readable(options) {
  6.   if (!(this instanceof Readable))
  7.     return new Readable(options);
  9.   ...
  11.   Stream.call(this, options);
  12. }

2.2.2 声明 pipe 方法，订阅 data 事件

在 Stream 的原型上声明 pipe 方法，订阅 data 事件，src 为可读流对象，dest 为可写流对象。

我们在使用 pipe 方法的时候也是监听的 data 事件，一边读取数据一边写入数据。

看下 ondata() 方法里的几个核心实现：

  • dest.write(chunk)：接收 chunk 写入数据，如果内部的缓冲小于创建流时配置的 highWaterMark，则返回 true，否则返回 false 时应该停止向流写入数据，直到 ‘drain’ 事件被触发。
  • src.pause()：可读流会停止 data 事件，意味着此时暂停数据写入了。

之所以调用 src.pause() 是为了防止读入数据过快来不及写入，什么时候知道来不及写入呢，要看 dest.write(chunk) 什么时候返回 false，是根据创建流时传的 highWaterMark 属性，默认为 16384 (16KB)，对象模式的流默认为 16。

注意：是 16KB 不是 16Kb，也是之前犯的一个错误，大写的 B 和小写的 b 在这里是有区别的。计算机中所有数据都以 0 和 1 表示，其中 0 或 1 称作一个位（bit），用小写的 b 表示。大写的 B 表示字节（byte），1byte = 8bit，大写 K 表示千，所以是千个位（Kb）和千个字节（KB），一般都是使用 KB 表示一个文件的大小。

  1. Readable.prototype.pipe = function(dest, options) {
  2.   const src = this;
  3.   src.on('data', ondata);
  4.   function ondata(chunk) {
  5.     const ret = dest.write(chunk);
  6.     if (ret === false) {
  7.       ...
  8.       src.pause();
  9.     }
  10.   }
  11.   ...
  12. };

2.2.3 订阅 drain 事件，继续流动数据

上面提到在 data 事件里，如果调用 dest.write(chunk) 返回 false，就会调用 src.pause() 停止数据流动，什么时候再次开启呢？

如果说可以继续写入事件到流时会触发 drain 事件，也是在 dest.write(chunk) 等于 false 时，如果 ondrain 不存在则注册 drain 事件。

  1. Readable.prototype.pipe = function(dest, options) {
  2.   const src = this;
  3.   src.on('data', ondata);
  4.   function ondata(chunk) {
  5.     const ret = dest.write(chunk);
  6.     if (ret === false) {
  7.       ...
  8.       if (!ondrain) {
  9.         // When the dest drains, it reduces the awaitDrain counter
  10.         // on the source.  This would be more elegant with a .once()
  11.         // handler in flow(), but adding and removing repeatedly is
  12.         // too slow.
  13.         ondrain = pipeOnDrain(src);
  14.         dest.on('drain', ondrain);
  15.       }
  16.       src.pause();
  17.     }
  18.   }
  19.   ...
  20. };
  22. // 当可写入流 dest 耗尽时，它将会在可读流对象 source 上减少 awaitDrain 计数器
  23. // 为了确保所有需要缓冲的写入都完成，即 state.awaitDrain === 0 和 src 可读流上的 data 事件存在，切换流到流动模式
  24. function pipeOnDrain(src) {
  25.   return function pipeOnDrainFunctionResult() {
  26.     const state = src._readableState;
  27.     debug('pipeOnDrain', state.awaitDrain);
  28.     if (state.awaitDrain)
  29.       state.awaitDrain--;
  30.     if (state.awaitDrain === 0 && EE.listenerCount(src, 'data')) {
  31.       state.flowing = true;
  32.       flow(src);
  33.     }
  34.   };
  35. }
  37. // stream.read() 从内部缓冲拉取并返回数据。如果没有可读的数据，则返回 null。在可读流上 src 还有一个 readable 属性，如果可以安全地调用 readable.read()，则为 true
  38. function flow(stream) {
  39.   const state = stream._readableState;
  40.   debug('flow', state.flowing);
  41.   while (state.flowing && stream.read() !== null);
  42. }

2.2.4 触发 data 事件

调用 readable 的 resume() 方法，触发可读流的 ‘data’ 事件，进入流动模式。

  1. Readable.prototype.pipe = function(dest, options) {
  2.   const src = this;
  3.   // Start the flow if it hasn't been started already.
  4.   if (!state.flowing) {
  5.     debug('pipe resume');
  6.     src.resume();
  7.   }
  8.   ...

然后实例上的 resume（Readable 原型上定义的）会在调用 resume() 方法，在该方法内部又调用了 resume_()，最终执行了 stream.read(0) 读取了一次空数据（size 设置的为 0），将会触发实例上的 _read() 方法，之后会在触发 data 事件。

  1. function resume(stream, state) {
  2.   ...
  3.   process.nextTick(resume_, stream, state);
  4. }
  6. function resume_(stream, state) {
  7.   debug('resume', state.reading);
  8.   if (!state.reading) {
  9.     stream.read(0);
  10.   }
  12.   ...
  13. }

2.2.5 订阅 end 事件

end 事件：当可读流中没有数据可供消费时触发，调用 onend 函数，执行 dest.end() 方法，表明已没有数据要被写入可写流，进行关闭（关闭可写流的 fd），之后再调用 stream.write() 会导致错误。

  1. Readable.prototype.pipe = function(dest, options) {
  2.   ...
  3.   const doEnd = (!pipeOpts || pipeOpts.end !== false) &&
  4.               dest !== process.stdout &&
  5.               dest !== process.stderr;
  7.   const endFn = doEnd ? onend : unpipe;
  8.   if (state.endEmitted)
  9.     process.nextTick(endFn);
  10.   else
  11.     src.once('end', endFn);
  13.   dest.on('unpipe', onunpipe);
  14.   ...
  16.   function onend() {
  17.     debug('onend');
  18.     dest.end();
  19.   }
  20. }

2.2.6 触发 pipe 事件

在 pipe 方法里面最后还会触发一个 pipe 事件，传入可读流对象

  1. Readable.prototype.pipe = function(dest, options) {
  2.   ...
  3.   const source = this;
  4.   dest.emit('pipe', src);
  5.   ...
  6. };

在应用层使用的时候可以在可写流上订阅 pipe 事件，做一些判断，具体可参考官网给的这个示例 stream_event_pipe

2.2.7 支持链式调用

最后返回 dest，支持类似 unix 的用法：A.pipe(B).pipe(C)

  1. Stream.prototype.pipe = function(dest, options) {
  2.   return dest;
  3. };

3. 总结

本文总体分为两部分：

  • 第一部分相对较基础，讲解了 Nodejs Stream 的 pipe 方法在 Koa2 中是怎么去应用的。
  • 第二部分仍以 Nodejs Stream pipe 方法为题，查找它的实现，以及对源码的一个简单分析，其实 pipe 方法核心还是要去监听 data 事件，向可写流写入数据，如果内部缓冲大于创建流时配置的 highWaterMark，则要停止数据流动，直到 drain 事件触发或者结束，当然还要监听 end、error 等事件做一些处理。

4. Reference

  • nodejs.cn/api/stream.html
  • cnodejs.org/topic/56ba030271204e03637a3870
  • github.com/nodejs/node/blob/master/lib/_stream_readable.js