Node.js child_process.execFile(file[, args][, options][, callback])用法及代码示例

child_process.execFile(file[, args][, options][, callback])

参数

• file <string> 要运行的可执行文件的名称或路径。
• args <string[]> 字符串参数列表。
• options <Object>
  • cwd <string> | <URL> 子进程的当前工作目录。
  • env <Object> 环境键值对。 默认： process.env 。
  • encoding <string> 默认： 'utf8'
  • timeout <number> 默认： 0
  • maxBuffer <number>stdout 或 stderr 上允许的最大数据量(以字节为单位)。如果超过，则终止子进程并截断任何输出。请参阅警告maxBuffer 和 Unicode.默认： 1024 * 1024.
  • killSignal <string> | <integer> 默认： 'SIGTERM'
  • uid <number> 设置进程的用户身份(参见 setuid(2) )。
  • gid <number> 设置进程的组标识(参见 setgid(2) )。
  • windowsHide <boolean> 隐藏通常在 Windows 系统上创建的子进程控制台窗口。 默认： false 。
  • windowsVerbatimArguments <boolean> 在 Windows 上不对参数进行引用或转义。在 Unix 上被忽略。 默认： false 。
  • shell <boolean> | <string> 如果 true ，在 shell 内运行 command。在 Unix 上使用 '/bin/sh'，在 Windows 上使用 process.env.ComSpec。可以将不同的 shell 指定为字符串。请参阅 Shell requirements 和 Default Windows shell 。 默认： false(无 shell )。
  • signal <AbortSignal> 允许使用 AbortSignal 中止子进程。
• callback <Function>进程终止时与输出一起调用。
  • error <Error>
  • stdout <string> | <Buffer>
  • stderr <string> | <Buffer>
• 返回： <ChildProcess>

child_process.execFile() 函数与 child_process.exec() 类似，只是它默认不生成 shell。相反，指定的可执行文件 file 直接作为新进程生成，使其比 child_process.exec() 更高效。

支持与 child_process.exec() 相同的选项。由于未生成 shell，因此不支持 I/O 重定向和文件通配等行为。

const { execFile } = require('node:child_process');
const child = execFile('node', ['--version'], (error, stdout, stderr) => {
  if (error) {
    throw error;
  }
  console.log(stdout);
});

传递给回调的 stdout 和 stderr 参数将包含子进程的 stdout 和 stderr 输出。默认情况下，Node.js 会将输出解码为 UTF-8 并将字符串传递给回调。 encoding 选项可用于指定用于解码 stdout 和 stderr 输出的字符编码。如果 encoding 是 'buffer' 或无法识别的字符编码，则将 Buffer 对象传递给回调。

如果此方法作为其 util.promisify() ed 版本调用，它会为具有 stdout 和 stderr 属性的 Object 返回 Promise。返回的ChildProcess 实例作为child 属性附加到Promise。如果发生错误(包括导致退出代码不是 0 的任何错误)，将返回一个被拒绝的 promise，并在回调中给出相同的 error 对象，但具有两个附加属性 stdout 和 stderr 。

const util = require('node:util');
const execFile = util.promisify(require('node:child_process').execFile);
async function getVersion() {
  const { stdout } = await execFile('node', ['--version']);
  console.log(stdout);
}
getVersion();

如果启用了 shell 选项，请不要将未经处理的用户输入传递给此函数。任何包含 shell 元字符的输入都可用于触发任意命令执行。

如果启用了 signal 选项，则在相应的 AbortController 上调用 .abort() 与在子进程上调用 .kill() 类似，只是传递给回调的错误将是 AbortError ：

const { execFile } = require('node:child_process');
const controller = new AbortController();
const { signal } = controller;
const child = execFile('node', ['--version'], { signal }, (error) => {
  console.log(error); // an AbortError
});
controller.abort();