在Node.js child_process.spawn()中实时获取winget下载进度的方法

在使用Node.js的child_process.spawn()执行winget upgrade PACKAGE_NAME命令时，进度条只会在下载完成后才一次性输出到stdout，无法在下载过程中实时捕获每一次进度更新。如何实现实时检测每一次进度变化，而非仅在下载完成后获取？

当前输出：

[
    'starting...',
    '\b \r\r  ██████▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒  17.0 MB / 79.4 MB\r  ████████████████▒▒▒▒▒▒▒▒▒▒▒▒▒▒  43.0 MB / 79.4 MB\r  ████████████████████████▒▒▒▒▒▒  64.0 MB / 79.4 MB\r  ██████████████████████████▒▒▒▒  70.0 MB / 79.4 MB\r  █████████████████████████████▒  77.0 MB / 79.4 MB\r  ██████████████████████████████  79.4 MB / 79.4 MB\r\n',
    'done!',
]

期望输出：

[
    'starting...',
    '\b \r\r  ██████▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒▒  17.0 MB / 79.4 MB',
    '\r  ████████████████▒▒▒▒▒▒▒▒▒▒▒▒▒▒  43.0 MB / 79.4 MB',
    '\r  ████████████████████████▒▒▒▒▒▒  64.0 MB / 79.4 MB',
    '\r  ██████████████████████████▒▒▒▒  70.0 MB / 79.4 MB',
    '\r  █████████████████████████████▒  77.0 MB / 79.4 MB\r',
    '\r  ██████████████████████████████  79.4 MB / 79.4 MB\r\n',
    'done!',
]

解决方法 #

问题核心在于winget默认会对终端输出进行缓冲，且其进度条使用\r（回车符）覆盖当前行实现实时更新，Node.js默认的spawn配置未正确处理这种流式输出。以下是具体实现步骤：

1. 配置spawn参数，禁用输出缓冲

设置stdio为管道模式，同时模拟终端环境让winget输出实时进度：

const { spawn } = require('child_process');

// 启动winget子进程
const wingetProcess = spawn('winget', ['upgrade', 'PACKAGE_NAME'], {
  shell: true, // 依赖Windows Shell环境执行winget
  stdio: ['pipe', 'pipe', 'pipe'], // 使用管道捕获数据流，而非直接继承父进程输出
  env: { ...process.env, TERM: 'xterm' } // 模拟终端环境，强制winget实时输出进度
});

2. 流式处理stdout数据，分割进度更新

维护缓冲区处理不完整输出片段，按\r拆分每一次进度更新：

let outputBuffer = '';

// 监听stdout数据流
wingetProcess.stdout.on('data', (chunk) => {
  outputBuffer += chunk.toString('utf-8'); // 用utf-8编码解析输出，避免乱码
  // 按回车符分割，拆分每一次进度更新
  const progressLines = outputBuffer.split('\r');
  outputBuffer = progressLines.pop(); // 保留未完成的片段到缓冲区

  // 遍历输出每一次进度
  progressLines.forEach(line => {
    if (line.trim()) { // 过滤空行
      console.log('实时进度:', line);
      // 此处可添加自定义逻辑，比如解析下载量、进度百分比等
    }
  });
});

// 处理错误输出
wingetProcess.stderr.on('data', (err) => {
  console.error('错误:', err.toString());
});

// 监听进程结束
wingetProcess.on('close', (code) => {
  console.log(`下载完成，进程退出码: ${code}`);
  // 输出缓冲区剩余内容
  if (outputBuffer.trim()) {
    console.log(outputBuffer);
  }
});

关键说明

• 用\r分割是因为winget通过回车符覆盖当前行实现进度更新，每个\r对应一次进度变化。
• 缓冲区outputBuffer用于处理不完整的输出片段，避免数据丢失。
• 设置TERM: 'xterm'是为了让winget识别为终端环境，从而禁用输出缓冲，实时发送进度数据。

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