DIV CSS 佈局教程網

Node.js 子進程全攻略:執行外部命令與進程間通訊
編輯:關於JavaScript     

Node 是為高效 I/O 而生的,但這不代表所有工作都適合丟給它。最典型的反例就是 CPU 密集型運算:一旦你把大量計算塞進主線程,事件迴圈會被卡住,整個服務的響應能力也跟著下降。

解法是把重活外包給另一個進程。Node 允許你建立子進程,而子進程能與父進程雙向溝通,父進程還能在某種程度上監控與管理它。

另一個常見需求更簡單:你只是想跑一條外部指令,並拿到它的輸出。 shell 指令、既有腳本、任何無法在 Node 內部直接執行的東西,都可以走這條路。本章要談的就是如何執行外部命令、建立子進程、與它通訊,以及收尾時把它結束掉。

執行外部命令

要跑一條 shell 命令或可執行檔,先引入 child_process 模組:

var child_process = require('child_process');
var exec = child_process.exec;

接著呼叫 exec:

exec(command, callback);

第一個參數是要執行的命令字串,第二個是回呼函式。回呼函式有三個參數:error、stdout、stderr。

exec('ls', function(err, stdout, stderr) {
    // Windows 使用者可把 ls 換成 dir
});

如果有錯誤發生,第一個參數會是 Error 類別的實例;若沒有錯誤,stdout 會帶著命令的標準輸出,stderr 則是錯誤輸出。

一個稍微完整一點的例子:

// 導入 child_process 模組的 exec 函式
var exec = require('child_process').exec;

// 執行 "cat *.js | wc -l"
exec('cat *.js | wc -l', function(err, stdout, stderr) {
    // 命令結束或呼叫失敗
    if (err) {
        // 啟動外部進程失敗
        console.log('child_process 退出,錯誤碼是:', err.code);
        return;
    }
    console.log(stdout);
});

你在 shell 裡用過的命令,幾乎都能原封不動地丟給 exec。

可選的設定物件

回呼函式之前還能插入第三個參數,用來傳入設定:

var exec = require('child_process').exec;

var options = {
    timeout: 1000,
    killSignal: 'SIGKILL'
};

exec('cat *.js | wc -l', options, function(err, stdout, stderr) {
    // ...
});

可用的選項包括:

  • cwd:指定子進程的當前工作目錄。
  • encoding:子進程輸出的編碼格式,預設 utf8。若子進程輸出不是 UTF-8,可用這個參數調整,支援 ascii、utf8、ucs2、base64 等(Buffer 的編碼處理是另一個主題)。
  • timeout:命令執行的逾時毫秒數,預設 0 代表不設限,一路等到子進程結束。
  • maxBuffer:stdout 與 stderr 允許輸出的最大位元組數,預設 200 × 1024。一旦超出,子進程會被強制終結。
  • killSignal:逾時或超出緩衝上限時送給子進程的終結信號,預設 SIGTERM。SIGTERM 屬於「有序關閉」,子進程收到後仍可進行善後處理,或自訂信號處理器改變預設行為。若目標進程需要,你也可以送 SIGUSR1 這類自訂信號;或者送 SIGKILL,那會交由作業系統直接強制結束,子進程的清理邏輯完全不會執行。
  • env:傳給子進程的環境變數,預設 null,也就是子進程繼承父進程當時的所有環境變數。

想對進程生命週期有更細緻的控制,請改用 spawn,後面會談。

補充一點:在 Node 裡信號是以字串形式存在的,對應一組 UNIX 信號與其預設行為:

安全地擴充環境變數

你可能想給子進程一組「父進程環境變數 + 幾個自訂變數」。請注意:直接改 process.env 會影響 Node 進程內所有模組,麻煩很大。正確做法是複製一份再改:

var env      = process.env,
    varName,
    envCopy  = {},
    exec     = require('child_process').exec;

// 將 process.env 複製到 envCopy
for (varName in env) {
    envCopy[varName] = env[varName];
}

// 設定一些自訂變數
envCopy['CUSTOM ENV VAR1'] = 'some value';
envCopy['CUSTOM ENV VAR2'] = 'some other value';

// 使用合併後的環境變數執行命令
exec('ls -la', { env: envCopy }, function(err, stdout, stderr) {
    if (err) { throw err; }
    console.log('stdout:', stdout);
    console.log('stderr:', stderr);
});

順帶記住一個容易踩的細節:環境變數是作業系統在進程之間傳遞的,所有值抵達子進程時一律是字串。我們用實測確認這件事。

先在 parent.js 建立父進程:

var exec = require('child_process').exec;

exec('node child.js', { env: { number: 123 } }, function(err, stdout, stderr) {
    if (err) { throw err; }
    console.log('stdout:\n', stdout);
    console.log('stderr:\n', stderr);
});

再在同目錄建立 child.js:

var number = process.env.number;

console.log(typeof(number));   // → "string"

number = parseInt(number, 10);

console.log(typeof(number));   // → "number"

執行 $ node parent.js,輸出大致如下:

stdout:
string
number

stderr:

父進程明明傳的是數字 123,子進程收到的卻是字串(第二行),得自己用 parseInt 轉回數字(第三行)。跨進程傳值時,這類型轉換問題值得先想清楚。

用 spawn 建立子進程

exec 用起来很簡單,但有兩個明顯限制:

  1. 除了命令列參數與環境變數,你幾乎無法與子進程雙向溝通。
  2. 子進程的輸出會被完整緩衝,既無法串流處理,也可能把記憶體吃乾。

child_process 模組提供了更細粒度的控制:你可以在應用裡啟動子進程,Node 會給你一條雙向通道,讓父子進程互傳字串資料;父進程還能對子進程送信號,甚至強制關閉它。

// 導入 child_process 模組的 spawn 函式
var spawn = require('child_process').spawn;

// 建立子進程執行 "tail -f /var/log/system.log"
var child = spawn('tail', ['-f', '/var/log/system.log']);

這裡建立的子進程會執行 tail 指令,並帶上 -f 與日誌路徑兩個參數。tail 會持續監控該檔案,把新增內容寫到標準輸出。spawn 回傳一個 ChildProcess 物件——它是真實進程的存取介面,我們把它存進 child 變數。

監聽子進程的輸出

任何帶有 stdout 屬性的子進程句柄,都能把標準輸出當成串流對待。綁上 data 事件,資料一到就被呼叫:

// 將子進程的輸出印到主控台
child.stdout.on('data', function(data) {
    console.log('tail output: ' + data);
});

除了標準輸出,進程還有一條標準錯誤串流,慣例上用來輸出錯誤訊息。若 /var/log/system.log 不存在,tail 會吐出類似「No such file or directory」的訊息,父進程可以這樣接:

child.stderr.on('data', function(data) {
    console.log('tail error output:', data);
});

stderr 和 stdout 一樣是唯讀串流,子進程一有輸出,父進程就會收到通知。

對子進程寫入資料

反過來,父進程可以透過 child.stdin 往子進程的標準輸入寫資料。子進程則用 process.stdin 監聽,但別忘了它預設處於暫停狀態,必須先 resume。

我們做一組示範:一個「加一服務」加上一個測試客戶端。

先建立 plus_one.js:

// 恢復預設處於暫停狀態的標準輸入流
process.stdin.resume();

process.stdin.on('data', function(data) {
    var number;
    try {
        // 將輸入資料解析為整數
        number = parseInt(data.toString(), 10);
        // +1
        number += 1;
        // 輸出結果
        process.stdout.write(number + "\n");
    } catch (err) {
        process.stderr.write(err.message + "\n");
    }
});

這個程式等待 stdin 的資料,收到就當它是整數解析、加一,再把結果寫回標準輸出。執行 $ node plus_one.js 後輸入整數按 Enter,就會看到加一後的數字;按 Ctrl-C 結束。

再寫一個測試客戶端 plus_one_test.js:

var spawn = require('child_process').spawn;

// 建立子進程來執行 +1 應用
var child = spawn('node', ['plus_one.js']);

// 每秒呼叫一次
setInterval(function() {
    // 產生一個小於 10000 的隨機數
    var number = Math.floor(Math.random() * 10000);

    // 把數字送給子進程
    child.stdin.write(number + "\n");

    // 取得回覆並印出
    child.stdout.once('data', function(data) {
        console.log('child replied to ' + number + ' with: ' + data);
    });
}, 1000);

child.stderr.on('data', function(data) {
    process.stdout.write(data);
});

這裡有個容易寫錯的地方:監聽回覆要用 once 而不是 on。若用 on,每秒都會註冊一個新的 data 回呼,而舊回呼並不會消失,於是同一個結果會被印出很多次——典型的監聽器洩漏。

接收子進程的結束通知

子進程結束時會觸發 exit 事件:

var spawn = require('child_process').spawn;

// 建立子進程執行 "ls -la"
var child = spawn('ls', ['-la']);

child.stdout.on('data', function(data) {
    console.log('data from child: ' + data);
});

// 子進程結束時
child.on('exit', function(code) {
    console.log('child process terminated with code ' + code);
});

退出碼會作為第一個參數傳進回呼。許多程式會用非零退出碼表示某種失敗,例如列出不存在的檔案:

var spawn = require('child_process').spawn;

// 建立子進程,執行 "ls does_not_exist.txt"
var child = spawn('ls', ['does_not_exist.txt']);

child.on('exit', function(code) {
    console.log('child process terminated with code ' + code);
});

如果子進程是被信號殺死而非正常結束,那麼信號會作為第二個參數傳入:

var spawn = require('child_process').spawn;

// 建立子進程,執行 "sleep 10"
var child = spawn('sleep', ['10']);

setTimeout(function() {
    child.kill();
}, 1000);

child.on('exit', function(code, signal) {
    if (code) {
        console.log('child process terminated with code ' + code);
    } else if (signal) {
        console.log('child process terminated because of signal ' + signal);
    }
});

這個程式啟動一個睡 10 秒的子進程,但一秒後就送訊號打斷它,於是輸出會是:

child process terminated because of signal SIGTERM

送訊號與終結進程

信號是父進程與子進程溝通、甚至終結子進程最輕量的一種手段。不同信號代表不同意義,其中最常被使用的那幾個就是用来殺進程的。若進程收到一個自己不知道怎麼處理的信號,就會被異常中斷;有些信號會被子進程攔下處理,有些則只能由作業系統執行。

一般情況下用 child.kill() 送訊號,預設送 SIGTERM:

var spawn = require('child_process').spawn;
var child = spawn('sleep', ['10']);

setTimeout(function() {
    child.kill();
}, 1000);

也可以傳入信號名稱字串來指定特定信號:

child.kill('SIGUSR2');

要注意的是,方法名叫 kill,但送出的信號不一定真的會殺掉子進程。如果子進程自己處理了這個信號,預設行為就被覆寫了。用 Node 寫的子進程可以這樣重定義處理器:

process.on('SIGUSR2', function() {
    console.log('Got a SIGUSR2 signal');
});

定義之後,這個進程再收到 SIGUSR2 就不會死,而是印出一行字。這其實是一種很省事的進程間指令通道:功能不如標準輸入豐富,但實作門檻低得多。

總結

這一章的兩條主線值得記牢。child_process.exec() 適合「跑完就好」的外部命令,參數除了命令列,也可以用環境變數傳——但記得環境變數一律以字串抵達對端。child_process.spawn() 則給你串流與信號兩套溝通管道,適合需要持續互動、串流處理或精細控制生命週期的情境。

選對工具,Node 就能既保持事件迴圈暢通,又把重活交給合適的進程去扛。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved