ดำเนินการไบนารีบรรทัดคำสั่งด้วย Node.js

ฉันอยู่ระหว่างการย้ายไลบรารี CLI จาก Ruby ไปยัง Node.js ในรหัสของฉันฉันรันไบนารีบุคคลที่สามหลายครั้งเมื่อจำเป็น ฉันไม่แน่ใจว่าวิธีที่ดีที่สุดในการบรรลุผลในโหนด

นี่คือตัวอย่างใน Ruby ที่ฉันเรียก PrinceXML เพื่อแปลงไฟล์เป็น PDF:

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

รหัสเทียบเท่าในโหนดคืออะไร?

สำหรับรุ่นที่ใหม่กว่าของ 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}`);
});

คุณยังสามารถใช้กับสัญญา:

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 มีเอกสารที่ดีในเอกสาร (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วิธีการทั้งหมดที่อธิบายข้างต้นเป็นแบบอะซิงโครนัสและมีวิธีการแบบซิงโครนัส เอกสารสำหรับพวกเขาสามารถพบได้ที่นี่ ในขณะที่พวกเขามีประโยชน์สำหรับการเขียนสคริปต์ทำทราบว่าแตกต่างจากวิธีการที่ใช้กับเด็กวางไข่กระบวนการถ่ายทอดสด, ChildProcessวิธีการซิงโครไม่กลับตัวอย่างของ

โหนด JS v13.9.0, LTS v12.16.1และv10.19.0 --- มี.ค. 2020

วิธี Async (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}` );
} );

วิธีการ Async (Windows):

'use strict';

const { spawn } = require( 'child_process' );
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.js v13.9.0 เอกสารประกอบ

เช่นเดียวกันกับNode.js v12.16.1 DocumentationและNode.js v10.19.0 Documentation

คุณกำลังมองหา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}`);
        }
});

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

ตั้งแต่รุ่น 4 ทางเลือกที่ใกล้เคียงที่สุดคือchild_process.execSyncวิธีการ:

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

let output = execSync('prince -v builds/pdf/book.html -o builds/pdf/book.pdf');

โปรดทราบว่าการexecSyncเรียกบล็อกเหตุการณ์วนรอบ

หากคุณต้องการบางสิ่งที่คล้ายกับคำตอบอันดับต้น ๆแต่ก็เป็นแบบซิงโครนัสก็จะได้ผล

var execSync = require('child_process').execSync;
var cmd = "echo 'hello world'";

var options = {
  encoding: 'utf8'
};

console.log(execSync(cmd, options));

ฉันเพิ่งเขียนผู้ช่วย 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;
});

ไฟล์ต้นฉบับต้นฉบับของ typescript:

 /**
 * 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. ---------------');
    });

ตอนนี้คุณสามารถใช้ shelljs (จากโหนด v4) ดังต่อไปนี้:

var shell = require('shelljs');

shell.echo('hello world');
shell.exec('node --version')

หากคุณไม่รังเกียจการพึ่งพาและต้องการใช้สัญญา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);
    });

ใช้npmแพ็คเกจน้ำหนักเบานี้:system-commands

มองไปที่มันนี่

นำเข้าแบบนี้:

const system = require('system-commands')

เรียกใช้คำสั่งเช่นนี้:

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

คำตอบของ @ hexacyanide เกือบจะสมบูรณ์ บน Windows คำสั่งprinceอาจจะprince.exe, prince.cmd, prince.batหรือเพียงแค่prince(ฉันไม่ทราบว่าจะมีการรวมอัญมณี แต่ถังขยะ NPM มาพร้อมกับสคริปต์การดวลจุดโทษและสคริปต์ชุด - npmและnpm.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;