Node.js Stream readable.pipe() 方法

在Node.js中，Stream 是一个非常常用的模块，在处理输入、输出、网络通信等方面经常有用到。而其中 pipe() 方法则是其中非常重要的一种方式，可以比较方便地处理可读可写流之间的数据传递，本文就对其进行详细介绍。

可读流和可写流

在介绍 pipe() 方法之前，我们先简要介绍一下Node.js中的两种重要的流，即可读流和可写流。

可读流

可读流是指能够从中读取数据的数据源，例如文件、标准输入、网络请求等。在Node.js中，可以通过fs.createReadStream()方法创建一个可读流，并通过事件的形式处理从可读流中读出来的数据。

const fs = require('fs');
const readStream = fs.createReadStream('file.txt');

readStream.on('data', (chunk) => {
  console.log(`读取到 ${chunk.length} 个字节的数据`);
});

readStream.on('end', () => {
  console.log('读取完成');
});

可写流

可写流则是指能够向其写入数据的数据目标，例如文件、标准输出、网络响应等。在Node.js中，可以通过fs.createWriteStream()方法创建一个可写流，并通过调用write()方法向其中写入数据。

const fs = require('fs');
const writeStream = fs.createWriteStream('file.txt');

writeStream.write('hello world');
writeStream.end(() => {
  console.log('写入完成');
});

pipe() 方法的作用

pipe()方法则是针对可读流和可写流之间的数据传递而设计的，其作用是将可读流中的数据传递给可写流，从而实现数据的读写。 在Node.js中，可以通过调用可读流的pipe()方法，并传入一个可写流，来启动这种数据传递。

// 使用pipe()方法实现等价于上面可写流的示例
const fs = require('fs');
const readStream = fs.createReadStream('file.txt');
const writeStream = fs.createWriteStream('output.txt');

readStream.pipe(writeStream);

从上面的示例中可以看到，利用pipe()方法，我们无需再手动处理从可读流中读出来的数据和将数据写入可写流之间的关系，一次简单的调用就能够完成全部的数据处理操作。

值得注意的是，由于pipe()方法会自动处理可读流数据缓存、可写流数据写入等细节，因此其对内存的占用是比较轻量级的。同时，pipe()方法默认情况下也会自动处理异常情况，如可写流写入错误、可读流读取错误等，保证了代码的可靠性。

自定义pipe()方法

尽管pipe()方法非常方便，但是有时候我们仍然需要在自定义的代码中控制数据格式、修改数据内容等。针对这种情况，Node.js提供了pipeline()方法，通过自定义传递的多个流处理器来控制和修改数据的传递过程。

const { pipeline } = require('stream');
const fs = require('fs');

const readStream = fs.createReadStream('file.txt');
const writeStream = fs.createWriteStream('output.txt');

const transformStream = new Transform({
  transform(chunk, encoding, callback) {
    const upperChunk = chunk.toString().toUpperCase();
    this.push(upperChunk);
    callback();
  }
});

pipeline(
  readStream,
  transformStream,
  writeStream,
  (err) => {
    if (err) {
      console.error('管道处理过程出错:', err);
    } else {
      console.log('管道处理过程完成');
    }
  }
);

结论

总结一下，pipe() 方法是Stream API中一个非常重要的方法，其可以极大地简化处理流数据的代码逻辑，省去了很多繁琐的数据处理细节。同时，自定义的pipeline()方法则提供了更强大的功能，可以让我们在数据流程中更加自如地控制数据格式和数据内容，提高了我们的灵活性和代码的可读性和可维护性。