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

我正在将CLI库从Ruby移植到Node.js.在我的代码中,我在必要时执行几个第三方二进制文件。我不确定如何在Node中最好地完成这一点。

这是Ruby中的一个示例,我调用PrinceXML将文件转换为PDF:

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

Node中的等效代码是什么?

766637 次浏览

你在找child_process.exec

下面是一个例子:

const exec = require('child_process').exec;const child = exec('cat *.js bad_file | wc -l',(error, stdout, stderr) => {console.log(`stdout: ${stdout}`);console.log(`stderr: ${stderr}`);if (error !== null) {console.log(`exec error: ${error}`);}});

对于更新版本的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 commandreturn;}
// the *entire* stdout and stderr (buffered)console.log(`stdout: ${stdout}`);console.log(`stderr: ${stderr}`);});

您也可以将其与Promises一起使用:

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 chunkschild.stdout.on('data', (chunk) => {// data from standard output is here as buffers});
// since these are streams, you can pipe them elsewherechild.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 elsewherelet 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生成子进程的模块在留档(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 elsewherechild.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现在支持同步spawnexec。上面描述的所有方法都是异步的,并且有一个同步对应物。它们的文档可以在这里中找到。虽然它们对脚本很有用,但请注意,与用于异步生成子进程的方法不同,同步方法不返回ChildProcess的实例。

我刚刚写了一个Cli助手来轻松处理Unix/windows。

Javascript:

define(["require", "exports"], function (require, exports) {/*** Helper to use the Command Line Interface (CLI) easily with both Windows and Unix environments.* Requires underscore or lodash as global through "_".*/var Cli = (function () {function Cli() {}/*** Execute a CLI command.* Manage Windows and Unix environment and try to execute the command on both env if fails.* Order: Windows -> Unix.** @param command                   Command to execute. ('grunt')* @param args                      Args of the command. ('watch')* @param callback                  Success.* @param callbackErrorWindows      Failure on Windows env.* @param callbackErrorUnix         Failure on Unix env.*/Cli.execute = function (command, args, callback, callbackErrorWindows, callbackErrorUnix) {if (typeof args === "undefined") {args = [];}Cli.windows(command, args, callback, function () {callbackErrorWindows();
try {Cli.unix(command, args, callback, callbackErrorUnix);} catch (e) {console.log('------------- Failed to perform the command: "' + command + '" on all environments. -------------');}});};
/*** Execute a command on Windows environment.** @param command       Command to execute. ('grunt')* @param args          Args of the command. ('watch')* @param callback      Success callback.* @param callbackError Failure callback.*/Cli.windows = function (command, args, callback, callbackError) {if (typeof args === "undefined") {args = [];}try {Cli._execute(process.env.comspec, _.union(['/c', command], args));callback(command, args, 'Windows');} catch (e) {callbackError(command, args, 'Windows');}};
/*** Execute a command on Unix environment.** @param command       Command to execute. ('grunt')* @param args          Args of the command. ('watch')* @param callback      Success callback.* @param callbackError Failure callback.*/Cli.unix = function (command, args, callback, callbackError) {if (typeof args === "undefined") {args = [];}try {Cli._execute(command, args);callback(command, args, 'Unix');} catch (e) {callbackError(command, args, 'Unix');}};
/*** Execute a command no matters what's the environment.** @param command   Command to execute. ('grunt')* @param args      Args of the command. ('watch')* @private*/Cli._execute = function (command, args) {var spawn = require('child_process').spawn;var childProcess = spawn(command, args);
childProcess.stdout.on("data", function (data) {console.log(data.toString());});
childProcess.stderr.on("data", function (data) {console.error(data.toString());});};return Cli;})();exports.Cli = Cli;});

打字稿原始源文件:

 /*** Helper to use the Command Line Interface (CLI) easily with both Windows and Unix environments.* Requires underscore or lodash as global through "_".*/export class Cli {
/*** Execute a CLI command.* Manage Windows and Unix environment and try to execute the command on both env if fails.* Order: Windows -> Unix.** @param command                   Command to execute. ('grunt')* @param args                      Args of the command. ('watch')* @param callback                  Success.* @param callbackErrorWindows      Failure on Windows env.* @param callbackErrorUnix         Failure on Unix env.*/public static execute(command: string, args: string[] = [], callback ? : any, callbackErrorWindows ? : any, callbackErrorUnix ? : any) {Cli.windows(command, args, callback, function () {callbackErrorWindows();
try {Cli.unix(command, args, callback, callbackErrorUnix);} catch (e) {console.log('------------- Failed to perform the command: "' + command + '" on all environments. -------------');}});}
/*** Execute a command on Windows environment.** @param command       Command to execute. ('grunt')* @param args          Args of the command. ('watch')* @param callback      Success callback.* @param callbackError Failure callback.*/public static windows(command: string, args: string[] = [], callback ? : any, callbackError ? : any) {try {Cli._execute(process.env.comspec, _.union(['/c', command], args));callback(command, args, 'Windows');} catch (e) {callbackError(command, args, 'Windows');}}
/*** Execute a command on Unix environment.** @param command       Command to execute. ('grunt')* @param args          Args of the command. ('watch')* @param callback      Success callback.* @param callbackError Failure callback.*/public static unix(command: string, args: string[] = [], callback ? : any, callbackError ? : any) {try {Cli._execute(command, args);callback(command, args, 'Unix');} catch (e) {callbackError(command, args, 'Unix');}}
/*** Execute a command no matters what's the environment.** @param command   Command to execute. ('grunt')* @param args      Args of the command. ('watch')* @private*/private static _execute(command, args) {var spawn = require('child_process').spawn;var childProcess = spawn(command, args);
childProcess.stdout.on("data", function (data) {console.log(data.toString());});
childProcess.stderr.on("data", function (data) {console.error(data.toString());});}}
Example of use:
Cli.execute(Grunt._command, args, function (command, args, env) {console.log('Grunt has been automatically executed. (' + env + ')');
}, function (command, args, env) {console.error('------------- Windows "' + command + '" command failed, trying Unix... ---------------');
}, function (command, args, env) {console.error('------------- Unix "' + command + '" command failed too. ---------------');});

节点JSv15.8.0、LTSv14.15.4v12.20.1---2021年2月

异步方法(Unix):

'use strict';
const { spawn } = require( 'child_process' );const ls = spawn( 'ls', [ '-lh', '/usr' ] );
ls.stdout.on( 'data', ( data ) => {console.log( `stdout: ${ data }` );} );
ls.stderr.on( 'data', ( data ) => {console.log( `stderr: ${ data }` );} );
ls.on( 'close', ( code ) => {console.log( `child process exited with code ${ code }` );} );

异步方法(Windows):

'use strict';
const { spawn } = require( 'child_process' );// NOTE: Windows Users, this command appears to be differ for a few users.// You can think of this as using Node to execute things in your Command Prompt.// If `cmd` works there, it should work here.// If you have an issue, try `dir`:// const dir = spawn( 'dir', [ '.' ] );const dir = spawn( 'cmd', [ '/c', 'dir' ] );
dir.stdout.on( 'data', ( data ) => console.log( `stdout: ${ data }` ) );dir.stderr.on( 'data', ( data ) => console.log( `stderr: ${ data }` ) );dir.on( 'close', ( code ) => console.log( `child process exited with code ${code}` ) );

同步:

'use strict';
const { spawnSync } = require( 'child_process' );const ls = spawnSync( 'ls', [ '-lh', '/usr' ] );
console.log( `stderr: ${ ls.stderr.toString() }` );console.log( `stdout: ${ ls.stdout.toString() }` );

Node.jsv15.8.0文档

Node.jsv14.15.4文档Node.jsv12.20.1文档也是如此

@赫斯特亚尼德的答案几乎是一个完整的答案。在Windows上,命令prince可以是prince.exeprince.cmdprince.bat或只是prince(我不知道gem是如何捆绑的,但npm bins带有sh脚本和批处理脚本-npmnpm.cmd)。如果您想编写可在Unix和Windows上运行的可移植脚本,则必须生成正确的可执行文件。

这是一个简单但可移植的生成函数:

function spawn(cmd, args, opt) {var isWindows = /win/.test(process.platform);
if ( isWindows ) {if ( !args ) args = [];args.unshift(cmd);args.unshift('/c');cmd = process.env.comspec;}
return child_process.spawn(cmd, args, opt);}
var cmd = spawn("prince", ["-v", "builds/pdf/book.html", "-o", "builds/pdf/book.pdf"])
// Use these props to get execution results:// cmd.stdin;// cmd.stdout;// cmd.stderr;

从版本4开始,最接近的替代方案是child_process.execSync方法

const {execSync} = require('child_process');
let output = execSync('prince -v builds/pdf/book.html -o builds/pdf/book.pdf');

⚠️注意execSync调用阻塞事件循环。

const exec = require("child_process").execexec("ls", (error, stdout, stderr) => {//do whatever here})

如果你想要的东西非常类似于最高答案,但也是同步的,那么这将工作。

var execSync = require('child_process').execSync;var cmd = "echo 'hello world'";
var options = {encoding: 'utf8'};
console.log(execSync(cmd, options));

如果你不介意依赖并想使用Promise,child-process-promise可以:

安装

npm install child-process-promise --save

exec用法

var exec = require('child-process-promise').exec; 
exec('echo hello').then(function (result) {var stdout = result.stdout;var stderr = result.stderr;console.log('stdout: ', stdout);console.log('stderr: ', stderr);}).catch(function (err) {console.error('ERROR: ', err);});

产卵使用

var spawn = require('child-process-promise').spawn; 
var promise = spawn('echo', ['hello']); 
var childProcess = promise.childProcess; 
console.log('[spawn] childProcess.pid: ', childProcess.pid);childProcess.stdout.on('data', function (data) {console.log('[spawn] stdout: ', data.toString());});childProcess.stderr.on('data', function (data) {console.log('[spawn] stderr: ', data.toString());}); 
promise.then(function () {console.log('[spawn] done!');}).catch(function (err) {console.error('[spawn] ERROR: ', err);});

ECMAScript模块importfrom语法

import {exec} from 'child-process-promise';let result = await exec('echo hi');console.log(result.stdout);

现在您可以使用shelljs(来自节点v4),如下所示:

var shell = require('shelljs');
shell.echo('hello world');shell.exec('node --version');

安装与

npm install shelljs

https://github.com/shelljs/shelljs

使用这个轻量级的npm包:system-commands

看看它这里

像这样导入:

const system = require('system-commands')

运行这样的命令:

system('ls').then(output => {console.log(output)}).catch(error => {console.error(error)})