Node.js从基础到高级运用】二十二、同步执行的子进程

引言

在 Node.js 的应用程序中，我们有时候需要在父进程中同步地执行子进程，这对于需要顺序执行任务或者处理命令行工具的输出特别有用。child_process 模块在 Node.js 中用于创建子进程，并且提供了几种同步执行子进程的方法。在 Windows 系统中使用时，我们通常需要注意命令行语法和路径的差异。本文将介绍如何在 Windows 环境下使用 child_process 模块中的 execSync 和 spawnSync 函数来同步执行子进程，并提供相应的代码示例。

execSync 函数

execSync 函数用于同步执行一个命令，并返回命令的标准输出。如果命令执行过程中发生错误，则会抛出异常。

示例：使用 execSync 执行 Windows 命令

const { execSync } = require('child_process'); // 引入 child_process 模块的 execSync 函数

try {
  // 同步执行 'dir' 命令并将输出赋值给 stdout 变量（在 Windows 中，'dir' 命令用于列出目录内容）
  const stdout = execSync('dir');
  
  // 输出命令执行的结果
  console.log(`stdout: ${stdout.toString()}`);
} catch (error) {
  // 如果执行过程中发生错误，打印错误信息
  console.error(`执行出错: ${error}`);
}

在这个示例中，execSync('dir') 同步执行了 Windows 的 dir 命令，并返回了命令的输出。我们通过 .toString() 将输出的 Buffer 转换为字符串，以便更好地阅读。

spawnSync 函数

spawnSync 函数用于同步执行一个命令，它返回一个包含 stdout 和 stderr 的对象。与 execSync 不同，spawnSync 适用于更复杂的场景，如需要分别处理标准输出和标准错误，或者执行需要交互的命令。

示例：使用 spawnSync 执行 Windows 命令

const { spawnSync } = require('child_process'); // 引入 child_process 模块的 spawnSync 函数

// 使用 spawnSync 同步执行 'dir' 命令
const result = spawnSync('cmd.exe', ['/c', 'dir']);

// 输出命令执行的标准输出
console.log(`stdout: ${result.stdout.toString()}`);
// 输出命令执行的标准错误
console.error(`stderr: ${result.stderr.toString()}`);
// 同步执行 'ping' 命令
const stdout = spawnSync('ping', ['www.baidu.com']).stdout.toString();
console.log(stdout)

在这个示例中，我们使用 spawnSync 来执行 dir 命令。注意，在 Windows 中，直接执行某些命令（比如 dir）可能需要通过 cmd.exe 与 /c 参数来调用。这样做可以确保命令在命令提示符下执行。

execFileSync 函数

execFileSync 函数用于同步执行一个文件，并返回文件的标准输出。如果文件执行过程中发生错误，则会抛出异常。

示例：使用 execFileSync 执行 Windows 下的可执行文件

const { execFileSync } = require('child_process'); // 引入 child_process 模块的 execFileSync 函数

try {
  // 同步执行 'ipconfig' 命令并将输出赋值给 stdout 变量（在 Windows 中，'ipconfig' 命令用于显示网络配置信息）
  const stdout = execFileSync('ipconfig', ['/all']);
  
  // 输出命令执行的结果
  console.log(`stdout: ${stdout.toString()}`);
} catch (error) {
  // 如果执行过程中发生错误，打印错误信息
  console.error(`执行出错: ${error}`);
}

在这个示例中，execFileSync('ipconfig', ['/all']) 同步执行了 Windows 的ipconfig命令，并返回了命令的输出。通过传递参数数组，我们可以指定命令行参数。

总结

在 Node.js 中同步执行子进程的方法是非常直接的，尤其是在处理需要顺序完成的任务时非常有用。