如何使用Jest测试console.log的最终打印输出内容？

这个需求完全可以实现，不需要手动实现占位符替换逻辑，有两种成熟方案可以拿到console.log实际打印的最终字符串，而不是调用时传入的原始参数。

console.log最终打印的内容一定会写入进程的标准输出流（Node环境），直接拦截流的写入方法就能拿到和控制台展示完全一致的结果，不需要关心console内部的格式化、序列化逻辑。

test('校验console.log实际打印内容', () => {
  // 保存原始方法引用，测试结束后恢复，避免影响其他用例
  const originalStdoutWrite = process.stdout.write.bind(process.stdout);
  let actualPrinted = '';

  // 拦截输出流，收集目标代码触发的打印内容
  process.stdout.write = (chunk) => {
    actualPrinted += chunk.toString();
    // 保留原始打印逻辑，如果不需要控制台真实输出可以删掉下行
    return originalStdoutWrite(chunk);
  };

  // 执行待测试的代码
  const two = 'two';
  console.log("one %s three", two);

  // 恢复原始输出方法
  process.stdout.write = originalStdoutWrite;

  // console.log默认会在输出末尾追加换行，断言前去掉尾部换行即可
  expect(actualPrinted.trimEnd()).toBe('one two three');
});

Node环境下console.log的字符串格式化逻辑完全基于内置的util.format实现，官方文档明确标注了这个依赖关系，格式化结果和实际打印内容完全一致，不需要拦截输出流。

const util = require('util');

test('通过原生格式化方法获取打印内容', () => {
  // 给console.log打监听桩
  const logSpy = jest.spyOn(console, 'log').mockImplementation((...args) => {
    // 用和console.log完全一致的逻辑生成最终打印字符串
    const finalMessage = util.format(...args);
    // 直接对最终结果做断言
    expect(finalMessage).toBe('one two three');
  });

  // 执行待测试的代码
  const two = 'two';
  console.log("one %s three", two);

  // 恢复原始console.log实现
  logSpy.mockRestore();
});

• 不要直接用jest.spyOn(console, 'log')拿到的调用参数做断言，spy默认记录的是调用时传入的原始参数，也就是示例里的["one %s three", "two"]，不是格式化后的最终结果。
• 所有对全局方法的mock、拦截都要在用例执行结束后恢复原始实现，否则会污染其他测试用例的运行环境。
• 如果是jsdom模拟的浏览器环境跑测试，方案1的思路依然成立，只需要把拦截process.stdout.write替换为对应环境下console输出的写入目标即可。

内容的提问来源于stack exchange，提问作者Nikita Polevoy