javascript - Stream.Transform 在 Node 中究竟是如何工作的？

Question

下面是我在博客上在线找到的代码片段，其中包含一个使用流 Transform 类更改数据流并输出更改后的结果的简单示例。关于这件事，有些事情我不太明白。

var stream = require('stream');
var util = require('util');

// node v0.10+ use native Transform, else polyfill
var Transform = stream.Transform ||
  require('readable-stream').Transform;

为什么程序需要检查 this var 是否指向 Upper 构造函数的实例？ Upper 构造函数用于构造下面的上层对象，那么检查这个的原因是什么？另外，我尝试了记录选项，但它返回 null/undefined，那么该参数的意义何在？

function Upper(options) {
  // allow use without new
  if (!(this instanceof Upper)) {
    return new Upper(options);
  }

我假设这个 Transform.call 方法是为了显式设置 this 变量？但为什么程序会这样做，因为 Transform 无论如何都不会被调用。

  // init Transform
  Transform.call(this, options);
}

谷歌搜索 util 包后，我知道这里使用它是为了允许 Upper 继承 Transform 的原型(prototype)方法。是对的吗？

util.inherits(Upper, Transform);

下面的函数才是真正让我困惑的地方。据我所知，该程序正在 Upper 的原型(prototype)上设置一个方法，用于转换输入到其中的数据。但是，我根本看不到这个函数在哪里被调用!

Upper.prototype._transform = function (chunk, enc, cb) {
  var upperChunk = chunk.toString().toUpperCase();
  this.push(upperChunk);
  cb();
};


// try it out - from the original code
var upper = new Upper();
upper.pipe(process.stdout); // output to stdout

通过调试器运行代码后，我可以看到 upper.write 调用了前面提到的 Upper.prototype._transform 方法，但是为什么会发生这种情况呢？ upper 是 Upper 构造函数的一个实例，而 write 是一个似乎与应用于 Upper 原型(prototype)的 _transform 方法没有任何关系的方法。

upper.write('hello world\n'); // input line 1
upper.write('another line');  // input line 2
upper.end();  // finish

Answer 1

首先，如果您还没有看过，请查看转换流实现者的文档 here .

• 问:为什么程序需要检查 this var 是否指向 Upper 构造函数的实例？ Upper 构造函数用于构造下面的上层对象，那么为什么要检查这个呢？

• A:它需要检查，因为任何人都可以调用Upper()而无需new。因此，如果检测到用户出于方便(并为了使事情正常工作)而在没有 new 的情况下调用了构造函数，则会代表用户隐式调用 new。

<小时/>

• 问:另外，我尝试了日志记录选项，但它返回 null/未定义，那么该参数的意义何在？

• A: options 只是一个构造函数/函数参数。如果您没有将任何内容传递给构造函数，那么显然它将是未定义(或者您传递给它的任何值)。您可以根据需要拥有任意数量的参数，就像任何普通函数一样。然而，在 Upper() 的情况下，由于转换的简单性(只需将所有输入转换为大写)，实际上并不需要配置。

<小时/>

• 问:我假设这个 Transform.call 方法是为了显式设置 this 变量？但为什么程序会这样做，因为 Transform 无论如何都不会被调用。

• 答:不，Transform.call()允许继承的“类”执行自己的初始化，例如设置内部状态变量。您可以将其视为调用 ES6 类中的 super()。

<小时/>

• 问: 谷歌搜索 util 包后，我知道这里使用它是为了允许 Upper 继承 Transform 的原型(prototype)方法。是这样吗？

• 答:是的，这是正确的。然而，现在你也可以使用 ES6 类来进行真正的继承。 node.js stream implementers documentation显示了两种继承方法的示例。

<小时/>

• 问:下面的函数才是真正让我困惑的地方。据我所知，该程序正在 Upper 的原型(prototype)上设置一个方法，用于转换输入到其中的数据。但是，我根本看不到这个函数在哪里被调用!

• 答:当 Node 有数据需要处理时，该函数会在内部调用。将该方法视为您需要在自定义 Transform 中实现的接口(interface)(或“纯虚函数”，如果您熟悉 C++)的一部分。

<小时/>

• 问:通过调试器运行代码后，我可以看到 upper.write 调用了前面提到的 Upper.prototype._transform 方法，但为什么会出现这种情况呢？ upper 是 Upper 构造函数的一个实例，而 write 是一个与应用于 Upper 原型(prototype)的 _transform 方法似乎没有任何关系的方法。

• 答:如 Transform documentation 中所述，变换流只是简化的双工流(意味着它们接受输入并产生输出)。当您调用 .write() 时，您正在写入 Transform 流的可写(输入)端。这就是使用您刚刚传递给 .write() 的数据触发对 ._transform() 的调用。当您调用 .push() 时，您正在写入 Transform 流的可读(输出)端。该数据是您在 Transform 流上调用 .read() 或附加 'data' 事件处理程序时看到的数据。