概述
基本用法
Node.js默認(rèn)單進(jìn)程運(yùn)行,對(duì)于32位系統(tǒng)最高可以使用512MB內(nèi)存空民,對(duì)于64位最高可以使用1GB內(nèi)存烦却。對(duì)于多核CPU的計(jì)算機(jī)來說豌鹤,這樣做效率很低,因?yàn)橹挥幸粋€(gè)核在運(yùn)行,其他核都在閑置凤薛。cluster模塊就是為了解決這個(gè)問題而提出的郊霎。
cluster模塊允許設(shè)立一個(gè)主進(jìn)程和若干個(gè)worker進(jìn)程槐沼,由主進(jìn)程監(jiān)控和協(xié)調(diào)worker進(jìn)程的運(yùn)行阶冈。worker之間采用進(jìn)程間通信交換消息,cluster模塊內(nèi)置一個(gè)負(fù)載均衡器葫慎,采用Round-robin算法協(xié)調(diào)各個(gè)worker進(jìn)程之間的負(fù)載衔彻。運(yùn)行時(shí),所有新建立的鏈接都由主進(jìn)程完成偷办,然后主進(jìn)程再把TCP連接分配給指定的worker進(jìn)程艰额。
var cluster = require('cluster');
var os = require('os');
if (cluster.isMaster){
for (var i = 0, n = os.cpus().length; i < n; i += 1){
cluster.fork();
}
} else {
http.createServer(function(req, res) {
res.writeHead(200);
res.end("hello world\n");
}).listen(8000);
}
上面代碼先判斷當(dāng)前進(jìn)程是否為主進(jìn)程(cluster.isMaster),如果是的椒涯,就按照CPU的核數(shù)柄沮,新建若干個(gè)worker進(jìn)程;如果不是废岂,說明當(dāng)前進(jìn)程是worker進(jìn)程祖搓,則在該進(jìn)程啟動(dòng)一個(gè)服務(wù)器程序。
上面這段代碼有一個(gè)缺點(diǎn)湖苞,就是一旦work進(jìn)程掛了拯欧,主進(jìn)程無法知道。為了解決這個(gè)問題财骨,可以在主進(jìn)程部署online事件和exit事件的監(jiān)聽函數(shù)镐作。
var cluster = require('cluster');
if(cluster.isMaster) {
var numWorkers = require('os').cpus().length;
console.log('Master cluster setting up ' + numWorkers + ' workers...');
for(var i = 0; i < numWorkers; i++) {
cluster.fork();
}
cluster.on('online', function(worker) {
console.log('Worker ' + worker.process.pid + ' is online');
});
cluster.on('exit', function(worker, code, signal) {
console.log('Worker ' + worker.process.pid + ' died with code: ' + code + ', and signal: ' + signal);
console.log('Starting a new worker');
cluster.fork();
});
}
上面代碼中,主進(jìn)程一旦監(jiān)聽到worker進(jìn)程的exit事件隆箩,就會(huì)重啟一個(gè)worker進(jìn)程滑肉。worker進(jìn)程一旦啟動(dòng)成功,可以正常運(yùn)行了摘仅,就會(huì)發(fā)出online事件。
worker對(duì)象
worker對(duì)象是cluster.fork()
的返回值问畅,代表一個(gè)worker進(jìn)程娃属。
它的屬性和方法如下六荒。
(1)worker.id
worker.id返回當(dāng)前worker的獨(dú)一無二的進(jìn)程編號(hào)。這個(gè)編號(hào)也是cluster.workers中指向當(dāng)前進(jìn)程的索引值矾端。
(2)worker.process
所有的worker進(jìn)程都是用child_process.fork()生成的掏击。child_process.fork()返回的對(duì)象,就被保存在worker.process之中秩铆。通過這個(gè)屬性砚亭,可以獲取worker所在的進(jìn)程對(duì)象。
(3)worker.send()
該方法用于在主進(jìn)程中殴玛,向子進(jìn)程發(fā)送信息捅膘。
if (cluster.isMaster) {
var worker = cluster.fork();
worker.send('hi there');
} else if (cluster.isWorker) {
process.on('message', function(msg) {
process.send(msg);
});
}
上面代碼的作用是,worker進(jìn)程對(duì)主進(jìn)程發(fā)出的每個(gè)消息滚粟,都做回聲寻仗。
在worker進(jìn)程中,要向主進(jìn)程發(fā)送消息凡壤,使用process.send(message)
署尤;要監(jiān)聽主進(jìn)程發(fā)出的消息,使用下面的代碼亚侠。
process.on('message', function(message) {
console.log(message);
});
發(fā)出的消息可以字符串曹体,也可以是JSON對(duì)象。下面是一個(gè)發(fā)送JSON對(duì)象的例子硝烂。
worker.send({
type: 'task 1',
from: 'master',
data: {
// the data that you want to transfer
}
});
cluster.workers對(duì)象
該對(duì)象只有主進(jìn)程才有箕别,包含了所有worker進(jìn)程。每個(gè)成員的鍵值就是一個(gè)worker進(jìn)程對(duì)象钢坦,鍵名就是該worker進(jìn)程的worker.id屬性究孕。
function eachWorker(callback) {
for (var id in cluster.workers) {
callback(cluster.workers[id]);
}
}
eachWorker(function(worker) {
worker.send('big announcement to all workers');
});
上面代碼用來遍歷所有worker進(jìn)程。
當(dāng)前socket的data事件爹凹,也可以用id屬性識(shí)別worker進(jìn)程厨诸。
socket.on('data', function(id) {
var worker = cluster.workers[id];
});
cluster模塊的屬性與方法
isMaster,isWorker
isMaster屬性返回一個(gè)布爾值禾酱,表示當(dāng)前進(jìn)程是否為主進(jìn)程微酬。這個(gè)屬性由process.env.NODE_UNIQUE_ID決定,如果process.env.NODE_UNIQUE_ID為未定義颤陶,就表示該進(jìn)程是主進(jìn)程颗管。
isWorker屬性返回一個(gè)布爾值,表示當(dāng)前進(jìn)程是否為work進(jìn)程滓走。它與isMaster屬性的值正好相反垦江。
fork()
fork方法用于新建一個(gè)worker進(jìn)程,上下文都復(fù)制主進(jìn)程搅方。只有主進(jìn)程才能調(diào)用這個(gè)方法比吭。
該方法返回一個(gè)worker對(duì)象绽族。
kill()
kill方法用于終止worker進(jìn)程。它可以接受一個(gè)參數(shù)衩藤,表示系統(tǒng)信號(hào)吧慢。
如果當(dāng)前是主進(jìn)程,就會(huì)終止與worker.process的聯(lián)絡(luò)赏表,然后將系統(tǒng)信號(hào)法發(fā)向worker進(jìn)程检诗。如果當(dāng)前是worker進(jìn)程,就會(huì)終止與主進(jìn)程的通信瓢剿,然后退出逢慌,返回0。
在以前的版本中跋选,該方法也叫做 worker.destroy() 涕癣。
listening事件
worker進(jìn)程調(diào)用listening方法以后,“l(fā)istening”事件就傳向該進(jìn)程的服務(wù)器前标,然后傳向主進(jìn)程坠韩。
該事件的回調(diào)函數(shù)接受兩個(gè)參數(shù),一個(gè)是當(dāng)前worker對(duì)象炼列,另一個(gè)是地址對(duì)象只搁,包含網(wǎng)址、端口俭尖、地址類型(IPv4氢惋、IPv6、Unix socket稽犁、UDP)等信息焰望。這對(duì)于那些服務(wù)多個(gè)網(wǎng)址的Node應(yīng)用程序非常有用。
cluster.on('listening', function (worker, address) {
console.log("A worker is now connected to " + address.address + ":" + address.port);
});
不中斷地重啟Node服務(wù)
思路
重啟服務(wù)需要關(guān)閉后再啟動(dòng)已亥,利用cluster模塊熊赖,可以做到先啟動(dòng)一個(gè)worker進(jìn)程,再把原有的所有work進(jìn)程關(guān)閉虑椎。這樣就能實(shí)現(xiàn)不中斷地重啟Node服務(wù)震鹉。
首先,主進(jìn)程向worker進(jìn)程發(fā)出重啟信號(hào)捆姜。
workers[wid].send({type: 'shutdown', from: 'master'});
worker進(jìn)程監(jiān)聽message事件传趾,一旦發(fā)現(xiàn)內(nèi)容是shutdown,就退出泥技。
process.on('message', function(message) {
if(message.type === 'shutdown') {
process.exit(0);
}
});
下面是一個(gè)關(guān)閉所有worker進(jìn)程的函數(shù)浆兰。
function restartWorkers() {
var wid, workerIds = [];
for(wid in cluster.workers) {
workerIds.push(wid);
}
workerIds.forEach(function(wid) {
cluster.workers[wid].send({
text: 'shutdown',
from: 'master'
});
setTimeout(function() {
if(cluster.workers[wid]) {
cluster.workers[wid].kill('SIGKILL');
}
}, 5000);
});
};
實(shí)例
下面是一個(gè)完整的實(shí)例,先是主進(jìn)程的代碼master.js。
var cluster = require('cluster');
console.log('started master with ' + process.pid);
// 新建一個(gè)worker進(jìn)程
cluster.fork();
process.on('SIGHUP', function () {
console.log('Reloading...');
var new_worker = cluster.fork();
new_worker.once('listening', function () {
// 關(guān)閉所有其他worker進(jìn)程
for(var id in cluster.workers) {
if (id === new_worker.id.toString()) continue;
cluster.workers[id].kill('SIGTERM');
}
});
});
上面代碼中镊讼,主進(jìn)程監(jiān)聽SIGHUP事件宽涌,如果發(fā)生該事件就關(guān)閉其他所有worker進(jìn)程。之所以是SIGHUP事件蝶棋,是因?yàn)閚ginx服務(wù)器監(jiān)聽到這個(gè)信號(hào),會(huì)創(chuàng)造一個(gè)新的worker進(jìn)程忽妒,重新加載配置文件玩裙。另外,關(guān)閉worker進(jìn)程時(shí)段直,主進(jìn)程發(fā)送SIGTERM信號(hào)吃溅,這是因?yàn)镹ode允許多個(gè)worker進(jìn)程監(jiān)聽同一個(gè)端口。
下面是worker進(jìn)程的代碼server.js鸯檬。
var cluster = require('cluster');
if (cluster.isMaster) {
require('./master');
return;
}
var express = require('express');
var http = require('http');
var app = express();
app.get('/', function (req, res) {
res.send('ha fsdgfds gfds gfd!');
});
http.createServer(app).listen(8080, function () {
console.log('http://localhost:8080');
});
使用時(shí)代碼如下决侈。
$ node server.js
started master with 10538
http://localhost:8080
然后,向主進(jìn)程連續(xù)發(fā)出兩次SIGHUP信號(hào)喧务。
$ kill -SIGHUP 10538
$ kill -SIGHUP 10538
主進(jìn)程會(huì)連續(xù)兩次新建一個(gè)worker進(jìn)程赖歌,然后關(guān)閉所有其他worker進(jìn)程,顯示如下功茴。
Reloading...
http://localhost:8080
Reloading...
http://localhost:8080
最后庐冯,向主進(jìn)程發(fā)出SIGTERM信號(hào),關(guān)閉主進(jìn)程坎穿。
$ kill 10538
PM2模塊
PM2模塊是cluster模塊的一個(gè)包裝層展父。它的作用是盡量將cluster模塊抽象掉,讓用戶像使用單進(jìn)程一樣玲昧,部署多進(jìn)程N(yùn)ode應(yīng)用栖茉。
// app.js
var http = require('http');
http.createServer(function(req, res) {
res.writeHead(200);
res.end("hello world");
}).listen(8080);
上面代碼是標(biāo)準(zhǔn)的Node架設(shè)Web服務(wù)器的方式,然后用PM2從命令行啟動(dòng)這段代碼孵延。
$ pm2 start app.js -i 4
上面代碼的i參數(shù)告訴PM2吕漂,這段代碼應(yīng)該在cluster_mode啟動(dòng),且新建worker進(jìn)程的數(shù)量是4個(gè)隙袁。如果i參數(shù)的值是0痰娱,那么當(dāng)前機(jī)器有幾個(gè)CPU內(nèi)核,PM2就會(huì)啟動(dòng)幾個(gè)worker進(jìn)程菩收。
如果一個(gè)worker進(jìn)程由于某種原因掛掉了梨睁,會(huì)立刻重啟該worker進(jìn)程。
# 重啟所有worker進(jìn)程
$ pm2 reload all
每個(gè)worker進(jìn)程都有一個(gè)id娜饵,可以用下面的命令查看單個(gè)worker進(jìn)程的詳情坡贺。
$ pm2 show <worker id>
正確情況下,PM2采用fork模式新建worker進(jìn)程,即主進(jìn)程fork自身遍坟,產(chǎn)生一個(gè)worker進(jìn)程拳亿。pm2 reload
命令則會(huì)用spawn方式啟動(dòng),即一個(gè)接一個(gè)啟動(dòng)worker進(jìn)程愿伴,一個(gè)新的worker啟動(dòng)成功肺魁,再殺死一個(gè)舊的worker進(jìn)程。采用這種方式隔节,重新部署新版本時(shí)鹅经,服務(wù)器就不會(huì)中斷服務(wù)。
$ pm2 reload <腳本文件名>
關(guān)閉worker進(jìn)程的時(shí)候怎诫,可以部署下面的代碼瘾晃,讓worker進(jìn)程監(jiān)聽shutdown消息。一旦收到這個(gè)消息幻妓,進(jìn)行完畢收尾清理工作再關(guān)閉蹦误。
process.on('message', function(msg) {
if (msg === 'shutdown') {
close_all_connections();
delete_logs();
server.close();
process.exit(0);
}
});