Node.js process 模組解讀

Randal發表於2018-05-30
Node.js

process存在於全域性物件上，不需要使用require()載入即可使用，process模組主要做兩方面的事情

  • 獲取程式資訊（資源使用、執行環境、執行狀態）
  • 執行程式操作（監聽事件、排程任務、發出警告）

資源使用

資源使用指執行此程式所消耗的機器資源。例如記憶體、cpu

記憶體

process.memoryUsage())

{ rss: 21848064,
  heapTotal: 7159808,
  heapUsed: 4431688,
  external: 8224 
 }
複製程式碼

rss(常駐記憶體)的組成見下圖

Node.js process 模組解讀

code segment對應當前執行的程式碼

external對應的是C++物件（與V8管理的JS物件繫結）的佔用的記憶體，比如Buffer的使用

Buffer.allocUnsafe(1024 * 1024 * 1000);
console.log(process.memoryUsage());

{ rss: 22052864,
  heapTotal: 6635520,
  heapUsed: 4161376,
  external: 1048584224 }
複製程式碼

cpu

const startUsage = process.cpuUsage();
console.log(startUsage);

const now = Date.now();
while (Date.now() - now < 500);

console.log(process.cpuUsage());
console.log(process.cpuUsage(startUsage)); //相對時間

// { user: 59459, system: 18966 }
// { user: 558135, system: 22312 }
// { user: 498432, system: 3333 }
複製程式碼

user對應使用者時間，system代表系統時間

執行環境

執行環境指此程式執行的宿主環境包括執行目錄、node環境、CPU架構、使用者環境、系統平臺

執行目錄

console.log(`Current directory: ${process.cwd()}`);

// Current directory: /Users/xxxx/workspace/learn/node-basic/process
複製程式碼

node環境

console.log(process.version)

// v9.1.0
複製程式碼

如果不僅僅希望獲得node的版本資訊，還希望v8、zlib、libuv版本等資訊的話就需要使用process.versions了

console.log(process.versions);
{ http_parser: '2.7.0',
  node: '9.1.0',
  v8: '6.2.414.32-node.8',
  uv: '1.15.0',
  zlib: '1.2.11',
  ares: '1.13.0',
  modules: '59',
  nghttp2: '1.25.0',
  openssl: '1.0.2m',
  icu: '59.1',
  unicode: '9.0',
  cldr: '31.0.1',
  tz: '2017b' }
複製程式碼

cpu架構

console.log(`This processor architecture is ${process.arch}`);

// This processor architecture is x64
複製程式碼

支援的值包括：'arm', 'arm64', 'ia32', 'mips', 'mipsel', 'ppc', 'ppc64', 's390', 's390x', 'x32' 'x64'

使用者環境

console.log(process.env.NODE_ENV); // dev

NODE_ENV=dev node b.js

複製程式碼

除了啟動時的自定義資訊之外，process.env還可以獲得其他的使用者環境資訊（比如PATH、SHELL、HOME等），感興趣的可以自己列印一下試試

系統平臺

console.log(`This platform is ${process.platform}`);

This platform is darwin
複製程式碼

支援的系統平臺包括：'aix' 'darwin' 'freebsd' 'linux' 'openbsd' 'sunos' 'win32'

android目前還處於試驗階段

執行狀態

執行狀態指當前程式的執行相關的資訊包括啟動引數、執行目錄、主檔案、PID資訊、執行時間

啟動引數

獲取啟動引數有三個方法，execArgv獲取Node.js的命令列選項（見官網文件）

argv獲取非命令列選項的資訊，argv0則獲取argv[0]的值（略有差異)

console.log(process.argv)
console.log(process.argv0)
console.log(process.execArgv)

node --harmony  b.js foo=bar --version

// 輸出結果
[ '/Users/xiji/.nvm/versions/node/v9.1.0/bin/node',
  '/Users/xiji/workspace/learn/node-basic/process/b.js',
  'foo=bar',
  '--version' ]
node
[ '--harmony' ]
複製程式碼

執行目錄

console.log(process.execPath);

// /Users/xxxx/.nvm/versions/node/v9.1.0/bin/node
複製程式碼

執行時間

var date = new Date();
while(new Date() - date < 500) {}
console.log(process.uptime()); // 0.569
複製程式碼

主檔案

除了require.main之外也可以通過process.mainModule來判斷一個模組是否是主檔案

//a.js
console.log(`module A: ${process.mainModule === module}`);

//b.js
require('./a');
console.log(`module B: ${process.mainModule === module}`);

node b.js
// 輸出
module A: false
module B: true
複製程式碼

PID資訊

console.log(`This process is pid ${process.pid}`); //This process is pid 12554
複製程式碼

監聽事件

process是EventEmiiter的例項物件，因此可以使用process.on('eventName', () => {})來監聽事件。 常用的事件型別分兩種：

  • 程式狀態 比如：beforeExit、exit、uncaughtException、message
  • 訊號事件 比如：SIGTERM、SIGKILL、SIGUSR1

beforeExit與exit的區別有兩方面：

  • beforeExit裡面可以執行非同步程式碼、exit只能是同步程式碼
  • 手動呼叫process.exit()或者觸發uncaptException導致程式退出不會觸發beforeExit事件、exit事件會觸發。

因此下面的程式碼console都不會被執行

process.on('beforeExit', function(code) {
  console.log('before exit: '+ code);
});
process.on('exit', function(code) {
  setTimeout(function() {
    console.log('exit: ' + code);
  }, 0);
});
a.b();
複製程式碼

當異常一直沒有被捕獲處理的話，最後就會觸發'uncaughtException'事件。預設情況下，Node.js會列印堆疊資訊到stderr然後退出程式。不要試圖阻止uncaughtException退出程式，因此此時程式的狀態可能已經不穩定了，建議的方式是及時捕獲處理程式碼中的錯誤，uncaughtException裡面只做一些清理工作。

注意：node的9.3版本增加了process.setUncaughtExceptionCaptureCallback方法

當process.setUncaughtExceptionCaptureCallback(fn)指定了監聽函式的時候，uncaughtException事件將會不再被觸發。

process.on('uncaughtException', function() {
  console.log('uncaught listener');
});

process.setUncaughtExceptionCaptureCallback(function() {
  console.log('uncaught fn');
});

a.b();
// uncaught fn
複製程式碼

message適用於父子程式之間傳送訊息，關於如何建立父子程式請參見child_process模組解讀。

SIGTERM訊號雖然也是用於請求終止Node.js程式，但是它與SIGKILL有所不同，程式可以選擇響應還是忽略此訊號。 SIGTERM會以一種友好的方式來結束程式，在程式結束之前先釋放已分配的資源（比如資料庫連線），因此這種方式被稱為優雅關閉(graceful shutdown) 具體的執行步驟如下：

  • 應用程式被通知需要關閉（接收到SIGTERM訊號）
  • 應用程式通知負載均衡不再接收新的請求
  • 應用程式完成正在進行中的請求
  • 釋放資源（例如資料庫連線）
  • 應用程式正常退出，退出狀態碼為0

SIGUSR1 Node.js當接收到SIGUSR1訊號時會啟動內建的偵錯程式，當執行下列操作時

kill -USR1 PID_OF_THE_NODE_JS_PROCESS
複製程式碼

可以看到node.js會啟動偵錯程式代理，埠是9229

server is listening 8089
Debugger listening on ws://127.0.0.1:9229/7ef98ccb-02fa-451a-8954-4706bd74105f
For help, see: https://nodejs.org/en/docs/inspector
複製程式碼

也可以在服務啟動時使用--inspect 來啟動除錯代理

node --inspect index.js
複製程式碼

排程任務

process.nextTick(fn)

通過process.nextTick排程的任務是非同步任務，EventLoop是分階段的，每個階段執行特定的任務，而nextTick的任務在階段切換的時候就會執行，因此nextTick會比setTimeout(fn, 0)更快的執行，關於EventLoop見下圖，後面會做進一步詳細的講解

Node.js process 模組解讀

發出警告

process.emitWarning('Something warning happened!', {
  code: 'MY_WARNING',
  type: 'XXXX'
});

// (node:14771) [MY_WARNING] XXXX: Something warning happened!
複製程式碼

當type為DeprecationWarning時，可以通過命令列選項施加影響

  • --throw-deprecation 會丟擲異常
  • --no-deprecation 不輸出DeprecationWarning
  • --trace-deprecation 列印詳細堆疊資訊
process.emitWarning('Something warning happened!', {
  type: 'DeprecationWarning'
});
console.log(4);

node --throw-deprecation index.js
node --no-deprecation index.js
node --trace-deprecation index.js
複製程式碼

參考資料

blog.risingstack.com/mastering-t…

相關文章