nodejs使用PassThrough流进行数据传递合并

在Node.js中流stream是处理数据的强大工具它们允许我们以流式方式处理大量数据而不必一次性将所有数据加载到内存中。PassThrough是Node.js中的一个流类型它在数据流传递过程中起到 无操作 的中间层将数据从可读流传递到可写流同时不做任何修改或处理。本文将介绍PassThrough流的作用、适用场景以及提供一个示例来演示如何使用它。

一、什么是PassThrough流

PassThrough流是Node.js中的一种双工流duplex stream既可以读取数据又可以写入数据。然而与其他流不同的是PassThrough流不会对数据进行任何更改只是简单地将从可读流传递来的数据传输到可写流。它通常在需要将数据从一个流传递到另一个流的情况下使用而无需对数据进行额外的处理。

二、PassThrough流示例场景

1. 日志文件流处理

假设我们正在构建一个应用程序并需要同时将日志消息写入文件和输出到控制台。我们可以使用PassThrough流来创建一个中间层将日志消息从应用程序写入流中然后将其传递到文件流和控制台流实现日志记录的同时不需要额外的数据处理。

'use strict';

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

// 创建一个 PassThrough 流作为中间层
const logStream = new PassThrough();

// 创建一个文件可写流将日志写入到文件中
const fileStream = fs.createWriteStream('app.log');
logStream.pipe(fileStream);

// 将日志信息输出到控制台
logStream.on('data', (chunk) => {
  console.log('Log:', chunk.toString());
});

// 模拟写入日志
logStream.write('This is a log message.\n');
logStream.write('Another log message.\n');
logStream.end();

2. shell脚本执行日志输出流合并

这里以 Egg.js 服务为例在内存中创建一个中间缓存 PassThrough 流然后把 shell 脚本执行的 stdout 和 stderr 输出流写入到这个中间缓存中最后将这个中间缓存流通过接口返回。演示代码如下

'use strict';

const Controller = require('egg').Controller;
const { createReadStream } = require('fs');
const { join } = require('path');
const { spawn } = require('child_process');
const { PassThrough } = require('stream');

class HomeController extends Controller {

  async testStream() {
    ctx.set('Content-Type', 'text/plain; charset=utf-8');

    const shPath = join(__dirname, './test.sh');
    const childProcess = spawn('sh', [ shPath ]);
    
    // 创建内存中的可读写流
    const memoryStream = new PassThrough();

    // 将子进程的 stdout 输出流写入内存流
    childProcess.stdout.pipe(memoryStream);

    // 将子进程的 stderr 输出流写入内存流
    childProcess.stderr.pipe(memoryStream);
    
    ctx.body = memoryStream;
  }

}

module.exports = HomeController;

三、总结

PassThrough 流是Node.js中流模块的有用组成部分它在数据流传递过程中起到中间层的作用。通过在适当的场景中使用 PassThrough 流我们可以轻松地将数据从一个流传递到另一个流同时保持数据的原样性。无论是日志记录还是其他类似的数据传递需求PassThrough 流都可以为我们提供一种简单而有效的解决方案。

---

欢迎访问天问博客