Node.js stream.Writable 关闭事件

stream.Writable 是一个抽象类，用于封装写入数据的操作。在 Node.js 中，该类在文件、HTTP 请求和响应等场景下被广泛使用。

当可写流数据结束时，将触发 close 事件。本文将带您深入了解 close 事件的相关知识点。

close 事件概览

close 事件是当可写流数据完成时发出的一个信号。在此事件被触发后，可写流将不再接受新的数据。

close 事件继承自 stream.Writable 类。流实例会在 end() 方法成功完成后，自动触发 close 事件。您也可以通过手动调用 destroy() 方法来触发该事件。

const { Writable } = require('stream');

class MyWritable extends Writable {
  constructor(options) {
    super(options);
  }

  _write(chunk, encoding, next) {
    console.log(`Writing chunk: ${chunk}`);
    next();
  }
}

const writable = new MyWritable();

writable.on('close', () => {
  console.log('The stream has been closed.');
});

writable.write('Hello, world!');
writable.end();

上述示例中，我们创建了 MyWritable 可写流，并为 close 事件添加了一个监听器。当 end() 方法被调用完成后，write() 方法将会输出 'Hello, world!' ，然后自动触发 close 事件。

close 事件的工作原理

当 close 事件被触发，Node.js 会清空可写流的缓冲区并关闭底层的文件或网络套接字。这意味着可写流将不再接受新的数据。

在触发 close 事件后，可写流实例将被释放。在这之后，您将无法再次写入数据。

close 事件的错误处理

如果在写完数据后，可写流遇到了错误，close 事件仍会被触发。这时，您可以通过错误参数来了解错误原因。

const { Writable } = require('stream');

class MyWritable extends Writable {
  constructor(options) {
    super(options);
  }

  _write(chunk, encoding, next) {
    console.log(`Writing chunk: ${chunk}`);
    next(new Error('Oops! An error has occurred.'));
  }
}

const writable = new MyWritable();

writable.on('close', () => {
  console.log('The stream has been closed.');
});

writable.on('error', (err) => {
  console.error(err.message);
});

writable.write('Hello, world!');
writable.end();

在上述示例中，我们重写了 MyWritable 类的 _write() 方法，并在其中故意抛出了一个错误。由于该错误继承自 Error 类，可写流会将其传递到 error 事件中，而不是直接将其抛出。

close 事件的应用场景

close 事件可以用于清空或关闭可写流所涉及的资源（例如文件或网络套接字）。此外，该事件还可以用于关闭与可写流相关的其他资源，例如定时器或子进程。

结论

在 Node.js 中，stream.Writable 类是可写流的抽象类，用于封装数据的写入操作。当可写流完成数据写入后，将触发 close 事件。该事件将清空缓冲区并关闭底层的文件或网络套接字。

在实际编码中，close 事件可以用于清空或关闭可写流所涉及的资源。由于该事件继承自 stream.Writable 类，您还可以在流结束时手动触发该事件。

参考资料

Node.js 官方文档 - Stream.Writable

Node.js 官方文档 - Stream - Writable stream

Node.js 官方文档 - Events - close