如何关闭可读流（结束之前）？

如何在Node.js中关闭可读流？

var input = fs.createReadStream('lines.txt');

input.on('data', function(data) {
   // after closing the stream, this will not
   // be called again

   if (gotFirstLine) {
      // close this stream and continue the
      // instructions from this if
      console.log("Closed.");
   }
});

这比以下更好：

input.on('data', function(data) {
   if (isEnded) { return; }

   if (gotFirstLine) {
      isEnded = true;
      console.log("Closed.");
   }
});

但这不会停止阅读过程...

调用 input.close()。它不在文档中，但是

https://github.com/joyent/node/blob/cfcb1de130867197cbc9c6012b7e84e08e53d032/lib/fs.js#L1597-L1620

显然可以完成工作：)它实际上执行与您相似的操作 isEnded。

EDIT 2015-Apr-19根据以下评论，并进行澄清和更新：

• 该建议是黑客行为，未记录在案。
• 虽然看当前 lib/fs.js来看，它仍然可以在> 1.5年后使用。
• 我同意以下有关致电的评论 destroy()更好。
• 如下面正确说明的，这适用于fs ReadStreams，不适用于通用Readable

至于通用解决方案：至少从我对文档的理解和快速浏览来看，它似乎并不存在_stream_readable.js。

我的建议是将您的可读流置于暂停模式，至少防止上游数据源中的进一步处理。如文档中所述，不要忘记unpipe()并删除所有data事件侦听器，以便pause()实际上暂停

编辑：好消息！从Node.js 8.0.0开始readable.destroy正式可用：https : //nodejs.org/api/stream.html#stream_visible_destroy_error

ReadStream.destroy

您可以随时调用ReadStream.destroy函数。

var fs = require('fs');

var readStream = fs.createReadStream('lines.txt');
readStream
    .on('data', function (chunk) {
        console.log(chunk);
        readStream.destroy();
    })
    .on('end', function () {
        // This may not been called since we are destroying the stream
        // the first time 'data' event is received
        console.log('All the data in the file has been read');
    })
    .on('close', function (err) {
        console.log('Stream has been destroyed and file has been closed');
    });

ReadStream.destroy没有公开功能（Node.js v0.12.2），但是您可以查看GitHub上的源代码（2012年10月5日，确认））。

该destroy函数在内部将ReadStream实例标记为已销毁，然后调用该close函数以释放文件。

您可以侦听close事件以确切了解文件何时关闭。在结束事件将不会触发除非数据被完全消耗。

注意destroy（和close）函数特定于fs.ReadStream。没有通用stream.read “接口”的一部分。

今天，在节点10中

readableStream.destroy()

是关闭可读流的官方方法

参见https://nodejs.org/api/stream.html#stream_visible_destroy_error

你不能 从节点5.3.0开始，没有记录的关闭/关闭/中止/销毁通用Readable流的方法。这是Node流体系结构的限制。

正如这里的其他答案所解释的那样，Node提供了针对Readable的特定实现的未公开记录的hack，例如fs.ReadStream。。这些不是任何Readable的通用解决方案。

如果有人可以在这里证明我错了，请这样做。我希望能够做到我说的是不可能的，并且很高兴得到纠正。

编辑：这是我的解决方法：通过一系列复杂的调用为我的管道实现。.destroy()unpipe()而且毕竟复杂了，它在所有情况下都无法正常工作。

编辑：节点v8.0.0 destroy()为可读流添加了一个api。

在版本中，4.*.*将空值推送到流中将触发EOF信号。

来自Node.js文档

如果传递了非null值，则push（）方法会将数据块添加到队列中，以供后续流处理器使用。如果传递了null，则表示流结束（EOF），之后将无法再写入数据。

在尝试了此页面上的许多其他选项之后，这对我有用。

这个destroy模块旨在确保流被销毁，处理不同的API和Node.js错误。现在是最佳选择之一。

注意 从节点10，您可以使用该.destroy方法而无需进一步依赖。

您可以使用清除和关闭流yourstream.resume()，这将转储流中的所有内容并最终将其关闭。

从官方文档：

read.resume（）：

返回：这个

此方法将使可读流恢复发射“数据”事件。

此方法会将流切换到流模式。如果您不想使用流中的数据，但是希望到达其“结束”事件，则可以调用stream.resume（）来打开数据流。

var readable = getReadableStreamSomehow();
readable.resume();
readable.on('end', () => {
  console.log('got to the end, but did not read anything');
});

这是一个老问题，但我也在寻找答案，并找到了最适合我的实现方案。无论end和close事件被发出，所以我觉得这是最干净的解决方案。

这将在节点4.4。*（撰写本文时为稳定版本）中达到目的：

var input = fs.createReadStream('lines.txt');

input.on('data', function(data) {
   if (gotFirstLine) {
      this.end(); // Simple isn't it?
      console.log("Closed.");
   }
});

有关详细说明，请参见：http : //www.bennadel.com/blog/2692-you-have-to-explicitly-end-streams-after-pipes-break-in-node-js.htm

这段代码可以很好地完成技巧：

function closeReadStream(stream) {
    if (!stream) return;
    if (stream.close) stream.close();
    else if (stream.destroy) stream.destroy();
}

writeStream.end（）是关闭writeStream的首选方法。