javascript - 使用 Node.js 执行命令行二进制文件

Question

我正在将 CLI 库从 Ruby 移植到 Node.js。在我的代码中，我会在必要时执行多个第三方二进制文件。我不确定如何在 Node 中最好地完成此任务。

下面是一个 Ruby 示例，我在其中调用 PrinceXML 将文件转换为 PDF:

cmd = system("prince -v builds/pdf/book.html -o builds/pdf/book.pdf")

Node 中的等效代码是什么？

Answer 1

对于较新版本的 Node.js (v8.1.4)，事件和调用与旧版本类似或相同，但鼓励使用标准的较新语言功能。示例:

对于缓冲的、非流格式的输出(您一次获得所有内容)，请使用 child_process.exec :

const { exec } = require('child_process');
exec('cat *.js bad_file | wc -l', (err, stdout, stderr) => {
  if (err) {
    // node couldn't execute the command
    return;
  }

  // the *entire* stdout and stderr (buffered)
  console.log(`stdout: ${stdout}`);
  console.log(`stderr: ${stderr}`);
});

您还可以将它与 Promise 一起使用:

const util = require('util');
const exec = util.promisify(require('child_process').exec);

async function ls() {
  const { stdout, stderr } = await exec('ls');
  console.log('stdout:', stdout);
  console.log('stderr:', stderr);
}
ls();

如果您希望分块逐渐接收数据(作为流输出)，请使用 child_process.spawn :

const { spawn } = require('child_process');
const child = spawn('ls', ['-lh', '/usr']);

// use child.stdout.setEncoding('utf8'); if you want text chunks
child.stdout.on('data', (chunk) => {
  // data from standard output is here as buffers
});

// since these are streams, you can pipe them elsewhere
child.stderr.pipe(dest);

child.on('close', (code) => {
  console.log(`child process exited with code ${code}`);
});

这两个函数都有一个同步对应函数。 child_process.execSync 的示例:

const { execSync } = require('child_process');
// stderr is sent to stderr of parent process
// you can set options.stdio if you want it to go elsewhere
let stdout = execSync('ls');

以及 child_process.spawnSync :

const { spawnSync} = require('child_process');
const child = spawnSync('ls', ['-lh', '/usr']);

console.log('error', child.error);
console.log('stdout ', child.stdout);
console.log('stderr ', child.stderr);

<小时/>

注意:以下代码仍然有效，但主要针对 ES5 及之前版本的用户。

使用 Node.js 生成子进程的模块在 documentation 中有详细记录。 (v5.0.0)。要执行命令并将其完整输出作为缓冲区获取，请使用 child_process.exec :

var exec = require('child_process').exec;
var cmd = 'prince -v builds/pdf/book.html -o builds/pdf/book.pdf';

exec(cmd, function(error, stdout, stderr) {
  // command output is in stdout
});

如果您需要使用流处理进程 I/O，例如当您期望大量输出时，请使用 child_process.spawn :

var spawn = require('child_process').spawn;
var child = spawn('prince', [
  '-v', 'builds/pdf/book.html',
  '-o', 'builds/pdf/book.pdf'
]);

child.stdout.on('data', function(chunk) {
  // output will be here in chunks
});

// or if you want to send output elsewhere
child.stdout.pipe(dest);

如果您正在执行文件而不是命令，您可能需要使用 child_process.execFile ，这些参数与 spawn 几乎相同，但有第四个回调参数，如 exec 用于检索输出缓冲区。这可能看起来有点像这样:

var execFile = require('child_process').execFile;
execFile(file, args, options, function(error, stdout, stderr) {
  // command output is in stdout
});

<小时/>

截至v0.11.12 ，Node 现在支持同步 spawn 和 exec。上述所有方法都是异步的，并且有一个同步的对应方法。可以找到它们的文档 here 。虽然它们对于编写脚本很有用，但请注意，与用于异步生成子进程的方法不同，同步方法不会返回 ChildProcess 的实例。 .