?
This document uses PHP Chinese website manual Release
穩(wěn)定性: 2 - 不穩(wěn)定
單個 Node 實例運行在一個線程中。為了更好的利用多核系統(tǒng)的能力,可以啟動 Node 集群來處理負載。
在集群模塊里很容易就能創(chuàng)建一個共享所有服務器接口的進程。
var cluster = require('cluster'); var http = require('http'); var numCPUs = require('os').cpus().length; if (cluster.isMaster) { // Fork workers. for (var i = 0; i < numCPUs; i++) { cluster.fork(); } cluster.on('exit', function(worker, code, signal) { console.log('worker ' + worker.process.pid + ' died'); }); } else { // Workers can share any TCP connection // In this case its a HTTP server http.createServer(function(req, res) { res.writeHead(200); res.end("hello world\n"); }).listen(8000); }
運行 Node 后,將會在所有工作進程里共享 8000 端口。
% NODE_DEBUG=cluster node server.js 23521,Master Worker 23524 online 23521,Master Worker 23526 online 23521,Master Worker 23523 online 23521,Master Worker 23528 online
這個特性是最近才引入的,大家可以試試并提供反饋。
還要注意,在 Windows 系統(tǒng)里還不能在工作進程中創(chuàng)建一個被命名的管道服務器。
child_process.fork
方法派生工作進程,所以它能通過 IPC 和父進程通訊,并相互傳遞句柄。
集群模塊通過2種分發(fā)模式來處理連接。
第一種(默認方法,除了 Windows 平臺)為循環(huán)式。主進程監(jiān)聽一個端口,接收新的連接,再輪流的分發(fā)給工作進程。
第二種,主進程監(jiān)聽 socket,并發(fā)送給感興趣的工作進程,工作進程直接接收連接。
第二種方法理論上性能最高。實際上,由于操作系統(tǒng)各式各樣,分配往往分配不均。列如,70%的連接終止于2個進程,實際上共有8個進程。
因為 server.listen()
將大部分工作交給了主進程,所以一個普通的 Node.js 進程和一個集群工作進程會在三種情況下有所區(qū)別:
server.listen({fd: 7})
由于消息被傳回主進程,所以將會監(jiān)聽主進程里的文件描述符,而不是其他工作進程里的文件描述符 7。
server.listen(handle)
監(jiān)聽一個明確地句柄,會使得工作進程使用指定句柄,而不是與主進程通訊。如果工作進程已經(jīng)擁有了該句柄,前提是您知道在做什么。
server.listen(0)
通常它會讓服務器隨機監(jiān)聽端口。然而在集群里每個工作進程 listen(0)
時會收到相同的端口。實際上僅第一次是隨機的,之后是可預測的。如果你想監(jiān)聽一個特定的端口,可以根據(jù)集群的工作進程的ID生產(chǎn)一個端口ID 。
在 Node.js 或你的程序里沒有路由邏輯,工作進程見也沒有共享狀態(tài)。因此,像登錄和會話這樣的工作,不要設計成過度依賴內(nèi)存里的對象。
因為工作線程都是獨立的,你可以根據(jù)需求來殺死或者派生而不會影響其他進程。只要仍然有工作進程,服務器還會接收連接。Node 不會自動管理工作進程的數(shù)量,這是你的責任,你可以根據(jù)自己需求來管理。
調(diào)度策略 cluster.SCHED_RR
表示輪流制,cluster.SCHED_NONE
表示操作系統(tǒng)處理。這是全局性的設定,一旦你通過 cluster.setupMaster()
派生了第一個工作進程,它就不可更改了。
SCHED_RR
是除 Windows 外所有系統(tǒng)的默認設置。只要 libuv 能夠有效地分配 IOCP 句柄并且不產(chǎn)生巨大的性能損失,Windows 也會改為 SCHED_RR 方式。
cluster.schedulingPolicy
也可通過環(huán)境變量 NODE_CLUSTER_SCHED_POLICY
來更改。有效值為 "rr"
和 "none"
。
{Object}
execArgv
{Array} 傳給可執(zhí)行的 Node 的參數(shù)列表(默認=process.execArgv
)
exec
{String} 執(zhí)行文件的路徑。 (默認=process.argv[1]
)
args
{Array} 傳給工作進程的參數(shù)列表(默認=process.argv.slice(2)
)
silent
{Boolean}是否將輸出發(fā)送給父進程的 stdio。
(默認=false
)
uid
{Number} 設置用戶進程的ID。 (See setuid(2)。)
gid
{Number} 設置進程組的ID。 (See setgid(2)。)
調(diào)用 .setupMaster()
(或 .fork()
) 方法后,這個 settings 對象會包含設置內(nèi)容,包括默認值。
設置后會立即凍結,因為.setupMaster()
只能調(diào)用一次。
這個對象不應該被手動改變或設置。
{Boolean}
如果是主進程,返回 true。如果 process.env.NODE_UNIQUE_ID
未定義,isMaster
為 true
。
{Boolean}
如果不是主進程返回 true (和 cluster.isMaster
相反)。
worker
{Worker object}
當一個新的工作進程被分支出來,集群模塊會產(chǎn)生 'fork' 事件。它可用于記錄工作進程,并創(chuàng)建自己的超時管理。
var timeouts = []; function errorMsg() { console.error("Something must be wrong with the connection ..."); } cluster.on('fork', function(worker) { timeouts[worker.id] = setTimeout(errorMsg, 2000); }); cluster.on('listening', function(worker, address) { clearTimeout(timeouts[worker.id]); }); cluster.on('exit', function(worker, code, signal) { clearTimeout(timeouts[worker.id]); errorMsg(); });
worker
{Worker object}
分支出一個新的工作進程后,它會響應在線消息。當主線程接收到在線消息后,它會觸發(fā)這個事件。'fork' 和 'online' 之間的區(qū)別在于,主進程分支一個工作進程后會調(diào)用 fork,而工作進程運行后會調(diào)用 emitted。
cluster.on('online', function(worker) { console.log("Yay, the worker responded after it was forked"); });
worker
{Worker object}
address
{Object}
工作進程調(diào)用 listen()
時,服務器會觸發(fā)'listening'事件,同時也會在主進程的集群里觸發(fā)。
事件處理函數(shù)有兩個參數(shù),worker
包含工作進程對象,address
包含以下屬性:address
, port
和 addressType
。如果工作進程監(jiān)聽多個地址的時候,這些東西非常有用。
cluster.on('listening', function(worker, address) { console.log("A worker is now connected to " + address.address + ":" + address.port); });
addressType
是以下內(nèi)容:
4
(TCPv4)
6
(TCPv6)
-1
(unix domain socket)
"udp4"
or "udp6"
(UDP v4 or v6)*
worker
{Worker object}
當一個工作進程的 IPC 通道關閉時會觸發(fā)這個事件。當工作進程正常退出,被殺死,或者手工關閉(例如worker.disconnect())時會調(diào)用。
disconnect
和 exit
事件間可能存在延遲。 這些事件可以用來檢測進程是否卡在清理過程中,或者存在長連接。
cluster.on('disconnect', function(worker) { console.log('The worker #' + worker.id + ' has disconnected'); });
worker
{Worker object}
code
{Number} 如果正常退出,則為退出代碼.
signal
{String} 使得進程被殺死的信號名 (比如. 'SIGHUP'
)
當任意一個工作進程終止的時候,集群模塊會觸發(fā) 'exit' 事件。
可以調(diào)用 .fork()
重新啟動工作進程。
cluster.on('exit', function(worker, code, signal) { console.log('worker %d died (%s). restarting...', worker.process.pid, signal || code); cluster.fork(); });
參見 <a rel="nofollow" href="https://nodejs.org/api/child_process.html#child_process_event_exit"">child_process event: 'exit'.
settings
{Object}
調(diào)用.setupMaster()
后會被觸發(fā)。
settings
對象就是 cluster.settings
對象。
詳細內(nèi)容參見 cluster.settings
。
settings
{Object}
exec
{String} 執(zhí)行文件的路徑。 (默認=process.argv[1]
)
args
{Array}傳給工作進程的參數(shù)列表(默認=process.argv.slice(2)
)
silent
{Boolean} 是否將輸出發(fā)送給父進程的 stdio.
setupMaster
用來改變默認的 'fork' 。 一旦調(diào)用,settings值將會出現(xiàn)在cluster.settings
里。
注意:
改變?nèi)魏卧O置,僅會對未來的工作進程產(chǎn)生影響,不會影響對目前已經(jīng)運行的進程
工作進程里,僅能改變傳遞給 .fork()
的 env
屬性。
以上的默認值,僅在第一次調(diào)用的時候有效,之后的默認值是調(diào)用 cluster.setupMaster()
后的值。
例如:
var cluster = require('cluster'); cluster.setupMaster({ exec: 'worker.js', args: ['--use', 'https'], silent: true }); cluster.fork(); // https worker cluster.setupMaster({ args: ['--use', 'http'] }); cluster.fork(); // http worker
僅能在主進程里調(diào)用。
env
{Object} 添加到子進程環(huán)境變量中的鍵值。
return {Worker object}
派生一個新的工作進程。
僅能在主進程里調(diào)用。
callback
{Function} 當所有工作進程都斷開連接,并且關閉句柄后被調(diào)用。
cluster.workers
里的每個工作進程可調(diào)用 .disconnect()
關閉。
關閉所有的內(nèi)部句柄連接,并且沒有任何等待處理的事件時,允許主進程優(yōu)雅的退出。
這個方法有一個可選參數(shù),會在完成時被調(diào)用。
僅能在主進程里調(diào)用。
{Object}
對當前工作進程對象的引用。主進程中不可用。
var cluster = require('cluster'); if (cluster.isMaster) { console.log('I am master'); cluster.fork(); cluster.fork(); } else if (cluster.isWorker) { console.log('I am worker #' + cluster.worker.id); }
{Object}
存儲活躍工作對象的哈希表,主鍵是 id
,能方便的遍歷所有工作進程,僅在主進程可用。
當工作進程關閉連接并退出后,將會從 cluster.workers 里移除。這兩個事件的次序無法確定,僅能保證從cluster.workers 移除會發(fā)生在 'disconnect'
或 'exit'
之后。
// Go through all workers function eachWorker(callback) { for (var id in cluster.workers) { callback(cluster.workers[id]); } } eachWorker(function(worker) { worker.send('big announcement to all workers'); });
如果希望通過通訊通道引用工作進程,那么使用工作進程的 id 來查詢最簡單。
socket.on('data', function(id) { var worker = cluster.workers[id]; });
一個 Worker 對象包含工作進程所有公開的信息和方法。在主進程里可用通過 cluster.workers
來獲取,在工作進程里可以通過 cluster.worker
來獲取。
{String}
每一個新的工作進程都有獨立的唯一標示,它就是 id
。
當工作進程可用時,id
就是 cluster.workers 里的主鍵。
{ChildProcess object}
所有工作進程都是通用 child_process.fork() 創(chuàng)建的,該函數(shù)返回的對象被儲存在 process 中。
注意,當 process
和 .suicide
不是 true
的時候,會觸發(fā) 'disconnect'
事件,并使得工作進程調(diào)用 process.exit(0)
。它會保護意外的連接關閉。
{Boolean}
調(diào)用 .kill()
或 .disconnect()
后設置,在這之前是 undefined
。
worker.suicide
能讓你區(qū)分出是自愿的還是意外退出,主進程可以根據(jù)這個值,來決定是否是重新派生成工作進程。
cluster.on('exit', function(worker, code, signal) { if (worker.suicide === true) { console.log('Oh, it was just suicide\' – no need to worry'). } }); // kill worker worker.kill();
message
{Object}
sendHandle
{Handle object}
這個函數(shù)和 child_process.fork() 提供的 send 方法相同。主進程里你必須使用這個函數(shù)給指定工作進程發(fā)消息。
在工作進程里,你也可以用 process.send(message)
。
這個例子會回應所有來自主進程的消息:
if (cluster.isMaster) { var worker = cluster.fork(); worker.send('hi there'); } else if (cluster.isWorker) { process.on('message', function(msg) { process.send(msg); }); }
signal
{String}發(fā)送給工作進程的殺死信號的名稱
這個函數(shù)會殺死工作進程。在主進程里,它會關閉 worker.process
,一旦關閉會發(fā)送殺死信號。在工作進程里,關閉通道,退出,返回代碼0
。
會導致 .suicide
被設置。
為了保持兼容性,這個方法的別名是worker.destroy()
。
注意,在工作進程里有process.kill()
,于此不同。
在工作進程里,這個函數(shù)會關閉所有服務器,等待 'close' 事件,關閉 IPC 通道。
在主進程里,發(fā)給工作進程一個內(nèi)部消息,用來調(diào)用.disconnect()
會導致 .suicide
被設置。
注意,服務器關閉后,不再接受新的連接,但可以接受新的監(jiān)聽。已經(jīng)存在的連接允許正常退出。當連接為空得時候,工作進程的 IPC 通道運行優(yōu)雅的退出。
以上僅能適用于服務器的連接,客戶端的連接由工作進程關閉。
注意,在工作進程里,存在 process.disconnect
,但并不是這個函數(shù),它是 disconnect。
由于長連接可能會阻塞進程關閉連接,有一個較好的辦法是發(fā)消息給應用,這樣應用會想辦法關閉它們。超時管理也是不錯,如果超過一定時間后還沒有觸發(fā) disconnect
事件,將會殺死進程。
if (cluster.isMaster) { var worker = cluster.fork(); var timeout; worker.on('listening', function(address) { worker.send('shutdown'); worker.disconnect(); timeout = setTimeout(function() { worker.kill(); }, 2000); }); worker.on('disconnect', function() { clearTimeout(timeout); }); } else if (cluster.isWorker) { var net = require('net'); var server = net.createServer(function(socket) { // connections never end }); server.listen(8000); process.on('message', function(msg) { if(msg === 'shutdown') { // initiate graceful close of any connections to server } }); }
工作進程結束,返回 true
, 否則返回 false
。
當工作進程通過 IPC 通道連接主進程時,返回 true
,否則 false
。工作進程創(chuàng)建后會連接到主進程。當disconnect
事件觸發(fā)后會關閉連接。
message
{Object}
該事件和 child_process.fork()
所提供的一樣。在主進程中您應當使用該事件,而在工作進程中您也可以使用 process.on('message')
。
例如,有一個集群使用消息系統(tǒng)在主進程中統(tǒng)計請求的數(shù)量:
var cluster = require('cluster'); var http = require('http'); if (cluster.isMaster) { // Keep track of http requests var numReqs = 0; setInterval(function() { console.log("numReqs =", numReqs); }, 1000); // Count requestes function messageHandler(msg) { if (msg.cmd && msg.cmd == 'notifyRequest') { numReqs += 1; } } // Start workers and listen for messages containing notifyRequest var numCPUs = require('os').cpus().length; for (var i = 0; i < numCPUs; i++) { cluster.fork(); } Object.keys(cluster.workers).forEach(function(id) { cluster.workers[id].on('message', messageHandler); }); } else { // Worker processes have a http server. http.Server(function(req, res) { res.writeHead(200); res.end("hello world\n"); // notify master about the request process.send({ cmd: 'notifyRequest' }); }).listen(8000); }
和 cluster.on('online')
事件類似, 僅能在特定工作進程里觸發(fā)。
cluster.fork().on('online', function() { // Worker is online });
不會在工作進程里觸發(fā)。
address
{Object}
和 cluster.on('listening')
事件類似, 僅能在特定工作進程里觸發(fā)。
cluster.fork().on('listening', function(address) { // Worker is listening });
不會在工作進程里觸發(fā)。
和 cluster.on('disconnect')
事件類似, 僅能在特定工作進程里觸發(fā)。
cluster.fork().on('disconnect', function() { // Worker has disconnected });
code
{Number} 正常退出時的退出代碼.
signal
{String} 使得進程被終止的信號的名稱(比如 SIGHUP
)。
和cluster.on('exit')
事件類似, 僅能在特定工作進程里觸發(fā)。
var worker = cluster.fork(); worker.on('exit', function(code, signal) { if( signal ) { console.log("worker was killed by signal: "+signal); } else if( code !== 0 ) { console.log("worker exited with error code: "+code); } else { console.log("worker success!"); } });
和 child_process.fork()
事件類似。
工作進程里,你也可以用 process.on('error')
。