深入理解Node.js的程式與子程式

coder2028發表於2022-11-22

程式:process模組

process 模組是 nodejs 提供給開發者用來和當前程式互動的工具,它的提供了很多實用的 API。從文件出發,管中窺豹,進一步認識和學習 process 模組:

  • 如何處理命令引數?
  • 如何處理工作目錄?
  • 如何處理異常?
  • 如何處理程式退出?
  • process 的標準流物件
  • 深入理解 process.nextTick

如何處理命令引數?

命令列引數指的是 2 個方面:

  • 傳給 node 的引數。例如 node --harmony script.js --version 中,--harmony 就是傳給 node 的引數
  • 傳給程式的引數。例如 node script.js --version --help 中,--version --help 就是傳給程式的引數

它們分別透過 process.argvprocess.execArgv 來獲得。

如何處理工作目錄?

透過process.cwd()可以獲取當前的工作目錄。

透過process.chdir(directory)可以切換當前的工作目錄,失敗後會丟擲異常。實踐如下:

function safeChdir(dir) {
    try {
        process.chdir(dir);
        return true;
    } catch (error) {
        return false;
    }
}

如何處理異常?

uncaughtException 事件

Nodejs 可以透過 try-catch 來捕獲異常。如果異常未捕獲,則會一直從底向事件迴圈冒泡。如是冒泡到事件迴圈的異常沒被處理,那麼就會導致當前程式異常退出。

根據文件,可以透過監聽 process 的 uncaughtException 事件,來處理未捕獲的異常:

process.on("uncaughtException", (err, origin) => {
    console.log(err.message);
});

const a = 1 / b;
console.log("abc"); // 不會執行

上面的程式碼,控制檯的輸出是:b is not defined。捕獲了錯誤資訊,並且程式以0退出。開發者可以在 uncaughtException 事件中,清除一些已經分配的資源(檔案描述符、控制程式碼等),不推薦在其中重啟程式。

unhandledRejection 事件

如果一個 Promise 回撥的異常沒有被.catch()捕獲,那麼就會觸發 process 的 unhandledRejection 事件:

process.on("unhandledRejection", (err, promise) => {
    console.log(err.message);
});

Promise.reject(new Error("錯誤資訊")); // 未被catch捕獲的異常,交由unhandledRejection事件處理

warning 事件

告警不是 Node.js 和 Javascript 錯誤處理流程的正式組成部分。 一旦探測到可能導致應用效能問題,缺陷或安全隱患相關的程式碼實踐,Node.js 就可發出告警。

比如前一段程式碼中,如果出現未被捕獲的 promise 回撥的異常,那麼就會觸發 warning 事件。

如何處理程式退出?

process.exit() vs process.exitCode

一個 nodejs 程式,可以透過 process.exit() 來指定退出程式碼,直接退出。不推薦直接使用 process.exit(),這會導致事件迴圈中的任務直接不被處理,以及可能導致資料的截斷和丟失(例如 stdout 的寫入)。

setTimeout(() => {
    console.log("我不會執行");
});

process.exit(0);

正確安全的處理是,設定 process.exitCode,並允許程式自然退出。

setTimeout(() => {
    console.log("我不會執行");
});

process.exitCode = 1;

beforeExit 事件

用於處理程式退出的事件有:beforeExit 事件 和 exit 事件。

當 Node.js 清空其事件迴圈並且沒有其他工作要安排時,會觸發 beforeExit 事件。例如在退出前需要一些非同步操作,那麼可以寫在 beforeExit 事件中:

let hasSend = false;
process.on("beforeExit", () => {
    if (hasSend) return; // 避免死迴圈

    setTimeout(() => {
        console.log("mock send data to serve");
        hasSend = true;
    }, 500);
});

console.log(".......");
// 輸出:
// .......
// mock send data to serve

注意:在 beforeExit 事件中如果是非同步任務,那麼又會被新增到任務佇列。此時,任務佇列完成所有任務後,又回觸發 beforeExit 事件。因此,不處理的話,可能出現死迴圈的情況。如果是顯式呼叫 exit(),那麼不會觸發此事件。

exit 事件

在 exit 事件中,只能執行同步操作。在呼叫 'exit' 事件監聽器之後,Node.js 程式將立即退出,從而導致在事件迴圈中仍排隊的任何其他工作被放棄。參考nodejs進階影片講解:進入學習

process 的標準流物件

process 提供了 3 個標準流。需要注意的是,它們有些在某些時候是同步阻塞的(請見文件)。

  • process.stderr:WriteStream 型別,console.error的底層實現,預設對應螢幕
  • process.stdout:WriteStream 型別,console.log的底層實現,預設對應螢幕
  • process.stdin:ReadStream 型別,預設對應鍵盤輸入

下面是基於“生產者-消費者模型”的讀取控制檯輸入並且及時輸出的程式碼:

process.stdin.setEncoding("utf8");

process.stdin.on("readable", () => {
    let chunk;
    while ((chunk = process.stdin.read()) !== null) {
        process.stdout.write(`>>> ${chunk}`);
    }
});

process.stdin.on("end", () => {
    process.stdout.write("結束");
});

關於事件的含義,還是請看stream 的文件。

深入理解 process.nextTick

我第一次看到 process.nextTick 的時候是比較懵的,看文件可以知道,它的用途是:把回撥函式作為微任務,放入事件迴圈的任務佇列中。但這麼做的意義是什麼呢?

因為 nodejs 並不適合計算密集型的應用,一個程式就一個執行緒,在當下時間點上,就一個事件在執行。那麼,如果我們的事件佔用了很多 cpu 時間,那麼之後的事件就要等待非常久。所以,nodejs 的一個程式設計原則是儘量縮短每一個事件的執行事件。process.nextTick 的作用就在這,將一個大的任務分解成多個小的任務。示例程式碼如下:

// 被拆分成2個函式執行
function BigThing() {
    doPartThing();

    process.nextTick(() => finishThing());
}

在事件迴圈中,何時執行 nextTick 註冊的任務呢?請看下面的程式碼:

setTimeout(function() {
    console.log("第一個1秒");
    process.nextTick(function() {
        console.log("第一個1秒:nextTick");
    });
}, 1000);

setTimeout(function() {
    console.log("第2個1秒");
}, 1000);

console.log("我要輸出1");

process.nextTick(function() {
    console.log("nextTick");
});

console.log("我要輸出2");

輸出的結果如下,nextTick 是早於 setTimeout:

我要輸出1
我要輸出2
nextTick
第一個1秒
第一個1秒:nextTick
第2個1秒

在瀏覽器端,nextTick 會退化成 setTimeout(callback, 0)。但在 nodejs 中請使用 nextTick 而不是 setTimeout,前者效率更高,並且嚴格來說,兩者建立的事件在任務佇列中順序並不一樣(請看前面的程式碼)。

子程式:child_process模組

掌握 nodejs 的 child_process 模組能夠極大提高 nodejs 的開發能力,例如主從程式來最佳化 CPU 計算的問題,多程式開發等等。本文從以下幾個方面介紹 child_process 模組的使用:

  • 建立子程式
  • 父子程式通訊
  • 獨立子程式
  • 程式管道

建立子程式

nodejs 的 child_process 模組建立子程式的方法:spawn, fork, exec, execFile。它們的關係如下:

  • fork, exec, execFile 都是透過 spawn 來實現的。
  • exec 預設會建立 shell。execFile 預設不會建立 shell,意味著不能使用 I/O 重定向、file glob,但效率更高。
  • spawn、exec、execFile 都有同步版本,可能會造成程式阻塞。

child_process.spawn()的使用:

const { spawn } = require("child_process");
// 返回ChildProcess物件,預設情況下其上的stdio不為null
const ls = spawn("ls", ["-lh"]);

ls.stdout.on("data", data => {
    console.log(`stdout: ${data}`);
});

ls.stderr.on("data", data => {
    console.error(`stderr: ${data}`);
});

ls.on("close", code => {
    console.log(`子程式退出,退出碼 ${code}`);
});

child_process.exec()的使用:

const { exec } = require("child_process");
// 透過回撥函式來操作stdio
exec("ls -lh", (err, stdout, stderr) => {
    if (err) {
        console.error(`執行的錯誤: ${err}`);
        return;
    }
    console.log(`stdout: ${stdout}`);
    console.error(`stderr: ${stderr}`);
});

父子程式通訊

fork()返回的 ChildProcess 物件,監聽其上的 message 事件,來接受子程式訊息;呼叫 send 方法,來實現 IPC。

parent.js 程式碼如下:

const { fork } = require("child_process");
const cp = fork("./sub.js");
cp.on("message", msg => {
    console.log("父程式收到訊息:", msg);
});
cp.send("我是父程式");

sub.js 程式碼如下:

process.on("message", m => {
    console.log("子程式收到訊息:", m);
});

process.send("我是子程式");

執行後結果:

父程式收到訊息: 我是子程式
子程式收到訊息: 我是父程式

獨立子程式

在正常情況下,父程式一定會等待子程式退出後,才退出。如果想讓父程式先退出,不受到子程式的影響,那麼應該:

  • 呼叫 ChildProcess 物件上的unref()
  • options.detached 設定為 true
  • 子程式的 stdio 不能是連線到父程式

main.js 程式碼如下:

const { spawn } = require("child_process");
const subprocess = spawn(process.argv0, ["sub.js"], {
    detached: true,
    stdio: "ignore"
});

subprocess.unref();

sub.js 程式碼如下:

setInterval(() => {}, 1000);

程式管道

options.stdio 選項用於配置在父程式和子程式之間建立的管道。 預設情況下,子程式的 stdin、 stdout 和 stderr 會被重定向到 ChildProcess 物件上相應的 subprocess.stdin、subprocess.stdout 和 subprocess.stderr 流。 這意味著可以透過監聽其上的 data事件,在父程式中獲取子程式的 I/O 。

可以用來實現“重定向”:

const fs = require("fs");
const child_process = require("child_process");

const subprocess = child_process.spawn("ls", {
    stdio: [
        0, // 使用父程式的 stdin 用於子程式。
        "pipe", // 把子程式的 stdout 透過管道傳到父程式 。
        fs.openSync("err.out", "w") // 把子程式的 stderr 定向到一個檔案。
    ]
});

也可以用來實現"管道運算子":

const { spawn } = require("child_process");

const ps = spawn("ps", ["ax"]);
const grep = spawn("grep", ["ssh"]);

ps.stdout.on("data", data => {
    grep.stdin.write(data);
});

ps.stderr.on("data", err => {
    console.error(`ps stderr: ${err}`);
});

ps.on("close", code => {
    if (code !== 0) {
        console.log(`ps 程式退出,退出碼 ${code}`);
    }
    grep.stdin.end();
});

grep.stdout.on("data", data => {
    console.log(data.toString());
});

grep.stderr.on("data", data => {
    console.error(`grep stderr: ${data}`);
});

grep.on("close", code => {
    if (code !== 0) {
        console.log(`grep 程式退出,退出碼 ${code}`);
    }
});

相關文章