Node.js Stream writeable._write() 方法

在 Node.js 的 Stream 模块中，Writable（可写流）是一个抽象类，定义了写入数据的接口。这个类不能直接使用，必须通过继承和实现其中的一些方法来实现对可写流的操作。

其中，_write() 方法是可写流实现中最重要的一个方法，用于向流中写入数据。

语法

writable._write(chunk, encoding, callback)

参数说明如下：

• chunk: 要写入的数据，可以是字符串或缓冲区（Buffer）。
• encoding: 如果 chunk 是字符串则指定编码格式，默认为 utf8。
• callback: 写入操作结束后的回调函数，可选参数。

实现方式

子类必须实现 _write() 方法来定义如何写入数据。这个方法会在写入一个新的数据块时被调用。一般情况下，子类的 _write() 方法会经常性地调用 write() 方法将数据写入底层的资源。

在 writable.write() 方法内部，会判断当前是否正在写入数据，如果正在写入则会将数据块加入到一个队列中等待下一次写入机会。如果没有正在写入的操作，那么就会直接调用 _write() 方法将数据写入底层资源中。

返回值

_write() 方法没有返回值，但可以在回调函数中传递一个表示错误的参数，如果有错误发生，流会触发一个 error 事件。如果没有发生错误，可以在回调函数中调用 callback() 来通知流写入操作已经完成。

示例代码

以下是一个自定义的可写流的例子，展示了如何实现 _write() 方法。

const { Writable } = require('stream')

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

  _write(chunk, encoding, callback) {
    console.log(`Writing data: ${chunk.toString()}`)
    // 写入数据到底层资源中
    // ...

    // 通知流写入操作已经完成
    process.nextTick(callback)
  }
}

const writable = new MyWritable()

writable.write('hello')
writable.write('world')

上面的代码定义了一个名为 MyWritable 的可写流类，并实现了 _write() 方法，用于在控制台输出写入的数据。

然后创建了一个实例 writable，并通过 write() 方法向流中写入数据。如果一切正常，你将在控制台看到类似于下面的输出：

Writing data: hello
Writing data: world

相关方法

Writable 类还定义了其他一些相关的方法，具体介绍请参考官方文档：

• writable.write(chunk, [encoding], [callback])
• writable.end([chunk], [encoding], [callback])
• writable.setDefaultEncoding(encoding)
• writable.cork()
• writable.uncork()