如何创建可访问写入内容的NodeJS.WritableStream用于Winston日志测试

我完全懂你想要的效果——就像Go里的bytes.Buffer那样，在内存里搞一个可写的“容器”，让Winston把日志写进去，之后随时能把里面的内容取出来做测试验证，完全不用碰文件系统，还能跨平台跑，对吧？

其实Node.js本身就支持自定义可写流，我们可以基于内置的stream.Writable轻松实现一个内存版的可写流，完全满足你的需求。

实现自己的内存可写流 #

Node.js的stream.Writable是所有可写流的基类，我们只需要继承它并实现核心的_write方法，再加上获取内容的自定义方法就行：

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

class MemoryWritable extends Writable {
  constructor(options) {
    super(options);
    // 用数组存储所有写入的数据块，避免频繁拼接Buffer影响效率
    this._storage = [];
  }

  // 实现Writable要求的核心写入逻辑
  _write(chunk, encoding, callback) {
    // 统一把数据转成Buffer存储（兼容字符串或Buffer类型的chunk）
    const data = typeof chunk === 'string' 
      ? Buffer.from(chunk, encoding) 
      : chunk;
    this._storage.push(data);
    callback(); // 通知流当前数据块已处理完成
  }

  // 自定义方法：获取所有写入的内容（返回Buffer）
  getBuffer() {
    return Buffer.concat(this._storage);
  }

  // 自定义方法：直接获取字符串格式的内容
  getContent(encoding = 'utf8') {
    return this.getBuffer().toString(encoding);
  }
}

结合Winston使用的示例 #

现在把这个内存流用到Winston的自定义Transport里，完全替代fs.createWriteStream('/dev/null')：

const winston = require('winston');

// 实例化我们的内存可写流
const logStorage = new MemoryWritable();

// 创建Winston Logger，指定用Stream Transport指向内存流
const logger = winston.createLogger({
  transports: [
    new winston.transports.Stream({
      stream: logStorage,
      // 可以根据需要配置日志格式，比如JSON格式
      format: winston.format.combine(
        winston.format.json(),
        winston.format.timestamp()
      )
    })
  ]
});

// 测试写日志
logger.info('Hello World from Winston');
logger.error('Something went wrong');

// 注意：流的写入是异步的，测试时要确保所有日志都已写入完成
// 可以用Promise等待Logger的finish事件（或者在测试框架里用异步测试）
await new Promise(resolve => logger.on('finish', resolve));

// 现在就能获取到所有日志内容了！
console.log(logStorage.getContent());
// 输出示例：
// {"level":"info","message":"Hello World from Winston","timestamp":"2024-05-20T12:34:56.789Z"}
// {"level":"error","message":"Something went wrong","timestamp":"2024-05-20T12:34:56.790Z"}

替代方案：用PassThrough流快速实现 #

如果你不想自定义类，也可以用Node.js内置的stream.PassThrough（它是双向流，支持读写），通过监听data事件收集内容：

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

const passThrough = new PassThrough();
const logChunks = [];

// 监听data事件收集所有写入的数据块
passThrough.on('data', (chunk) => logChunks.push(chunk));

// 同样传给Winston的Stream Transport
const logger = winston.createLogger({
  transports: [
    new winston.transports.Stream({ stream: passThrough })
  ]
});

// 写日志后，合并数据块获取内容
logger.info('Test log');
await new Promise(resolve => logger.on('finish', resolve));

const logContent = Buffer.concat(logChunks).toString('utf8');
console.log(logContent);

这种方式更快捷，但自定义MemoryWritable类的方式把收集逻辑封装得更干净，适合在测试代码里复用。

为什么不用fs？ #

完全不需要！你的需求本来就是内存中临时存储日志做测试，用文件系统完全是绕远路——不仅会有跨平台兼容性问题（比如Windows没有/dev/null），还会有文件IO的开销，完全没必要。

这个实现和你Go里用bytes.Buffer的思路一模一样：都是在内存里提供一个可写的目标，写完之后直接读取内部存储的内容做验证。

备注：内容来源于stack exchange，提问作者NotX