跟我學(xué)Nodejs（二）--- Node.js事件模塊

更新時(shí)間：2014年05月21日 09:32:03 作者：

events是node.js 最重要的模塊，events模塊只提供了一個(gè)對(duì)象events.EventEmitter，EventEmitter 的核心是事件發(fā)射與事件監(jiān)聽(tīng)器。

簡(jiǎn)介及資料

　　http://www.infoq.com/cn/articles/tyq-nodejs-event

events是node.js 最重要的模塊，events模塊只提供了一個(gè)對(duì)象events.EventEmitter，EventEmitter 的核心是事件發(fā)射與事件監(jiān)聽(tīng)器。

Node.js中大部分的模塊，都繼承自Event模塊。

與DOM樹(shù)上事件不同，不存在事件冒泡、逐層捕獲等行為。

EventEmitter 支持若干個(gè)事件監(jiān)聽(tīng)器。當(dāng)事件發(fā)射時(shí)，注冊(cè)到這個(gè)事件的事件監(jiān)聽(tīng)器被依次調(diào)用，事件參數(shù)作為回調(diào)函數(shù)參數(shù)傳遞。　　

　　如何訪問(wèn)：

復(fù)制代碼代碼如下:

require('events');

emitter.on(event, listener)

復(fù)制代碼代碼如下:

/*
    調(diào)用events模塊，獲取events.EventEmitter對(duì)象
*/
var EventEmitter = require('events').EventEmitter;   
var ee = new EventEmitter();
/*
    EventEmitter.on(event, listener) 為事件注冊(cè)一個(gè)監(jiān)聽(tīng)
    參數(shù)1：event  字符串，事件名
    參數(shù)2：回調(diào)函數(shù)
*/
ee.on('some_events', function(foo, bar) {
    console.log("第1個(gè)監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
});
console.log('第一輪');
ee.emit('some_events', 'Wilson', 'Zhong');
console.log('第二輪');
ee.emit('some_events', 'Wilson', 'Z');
EventEmitter.on(event, listener) 示例源碼

emitter.emit(event, [arg1], [arg2], [...])

復(fù)制代碼代碼如下:

var EventEmitter = require('events').EventEmitter;   
var ee = new EventEmitter();
ee.on('some_events', function(foo, bar) {         
    console.log("第1個(gè)監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
});
/*
    EventEmitter.emit(event, [arg1], [arg2], [...])   觸發(fā)指定事件
    參數(shù)1：event  字符串，事件名
    參數(shù)2：可選參數(shù)，按順序傳入回調(diào)函數(shù)的參數(shù)
    返回值：該事件是否有監(jiān)聽(tīng)
*/
var isSuccess = ee.emit('some_events', 'Wilson', 'Zhong');
ee.on('some_events', function(foo, bar) {         
    console.log("第2個(gè)監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
});
ee.emit('some_events', 'zhong', 'wei');
var isSuccess2 = ee.emit('other_events', 'Wilson', 'Zhong');
console.log(isSuccess);
console.log(isSuccess2);
emitter.emit(event, [arg1], [arg2], [...]) 示例源碼

示例進(jìn)行了三次觸發(fā)事件操作，其中some_events注冊(cè)了監(jiān)聽(tīng)，調(diào)用時(shí)emit函數(shù)會(huì)返回一個(gè)true,而other_events并沒(méi)有注冊(cè)監(jiān)聽(tīng)，emit函數(shù)會(huì)返回一個(gè)false，表示該事件沒(méi)有監(jiān)聽(tīng)；當(dāng)然也可以不用管這個(gè)返回值！

emitter.once(event, listener)

復(fù)制代碼代碼如下:

var EventEmitter = require('events').EventEmitter;   
var ee = new EventEmitter();
/*
    EventEmitter.once(event, listener)  為事件注冊(cè)一次性監(jiān)聽(tīng)，觸發(fā)一次后移除監(jiān)聽(tīng)
    參數(shù)1：event  字符串，事件名
    參數(shù)2：回調(diào)函數(shù)
*/
ee.once('some_events', function(foo, bar) {
    console.log("第1個(gè)監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
});
console.log('第一輪');
ee.emit('some_events', 'Wilson', 'Zhong');
console.log('第二輪');
var isSuccess =  ee.emit('some_events', 'Wilson', 'Zhong');
console.log(isSuccess);
emitter.once(event, listener) 示例源碼

從上面示例代碼執(zhí)行結(jié)果可以看出，用emitter.once給some_events注冊(cè)一個(gè)監(jiān)聽(tīng)后，分兩輪調(diào)用emitter.emit觸發(fā)，第二輪會(huì)返回false；這表示用emitter.once注冊(cè)監(jiān)聽(tīng)和用前面講的emitter.on注冊(cè)監(jiān)聽(tīng)略有不同，

emitter.once注冊(cè)監(jiān)聽(tīng)是一次性監(jiān)聽(tīng)，當(dāng)觸發(fā)一次后，會(huì)移除該監(jiān)聽(tīng)！當(dāng)然，從名字上就看就比較明顯了^_^!

emitter.removeListener(event, listener)

先來(lái)看一個(gè)失敗的場(chǎng)景~~~

復(fù)制代碼代碼如下:

var EventEmitter = require('events').EventEmitter;   
var ee = new EventEmitter();
ee.on('some_events', function(foo, bar) {
    console.log("第1個(gè)監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
});
/*
    看到API中removeListener移除方法時(shí)，以為應(yīng)該是這樣
    但是結(jié)果^_^!!!!!
*/
ee.removeListener('some_events', function(){
    console.log('成功移除事件some_events監(jiān)聽(tīng)!');        
});
console.log('第一輪');
ee.emit('some_events', 'Wilson', 'Zhong');
emitter.removeListener(event, listener) 示例失敗場(chǎng)景源碼

當(dāng)我用emitter.on給some_events注冊(cè)了一個(gè)監(jiān)聽(tīng)后，我用emiiter.removeListener移除some_events的監(jiān)聽(tīng)，隨后再調(diào)用emitter.emit去觸發(fā)，最后發(fā)現(xiàn)不是按我想像的在進(jìn)行！為什么呢？

我理所當(dāng)然的認(rèn)為emiiter.removeListener第二個(gè)參數(shù)是個(gè)回調(diào)函數(shù)，API還是要認(rèn)真看清楚?。。?！

下面再看個(gè)成功的場(chǎng)景～～～

復(fù)制代碼代碼如下:

var EventEmitter = require('events').EventEmitter;   
var ee = new EventEmitter();
var listener = function(foo,bar)
{
    console.log("第1個(gè)監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
}
var listener2= function(foo,bar)
{
    console.log("第2個(gè)監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
}
var listener3= function(foo,bar)
{
    console.log("第3個(gè)監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
}
ee.on('some_events', listener);
ee.on('some_events', listener2);
ee.on('some_events', listener3);
/*
    EventEmitter.removeListener(event, listener)  移除指定事件的監(jiān)聽(tīng)器
    注意：該監(jiān)聽(tīng)器必須是注冊(cè)過(guò)的
    PS：上一個(gè)例子之后以會(huì)失敗，很大原因就是忽略了監(jiān)聽(tīng)器，理所當(dāng)然的認(rèn)為傳個(gè)事件名就OK了，所以就悲劇了!
*/
ee.removeListener('some_events', listener);
ee.removeListener('some_events', listener3);
ee.emit('some_events', 'Wilson', 'Zhong');
emitter.removeListener(event, listener) 示例成功場(chǎng)景源碼

我用示例中寫(xiě)法，給some_events添加了三個(gè)監(jiān)聽(tīng)，又移除了第一個(gè)和第三個(gè)監(jiān)聽(tīng)，最后再用emitter.emit觸發(fā)some_events，輸出結(jié)果不難發(fā)現(xiàn)，用emitter.removeListener移除的第一個(gè)和第三個(gè)監(jiān)聽(tīng)都沒(méi)有再起作用，

想當(dāng)然是害人地，原來(lái)emitter.removeListener的第二個(gè)參數(shù)是要移除的監(jiān)聽(tīng)，而非移除成功后的回調(diào)函數(shù)……^_^!

emitter.removeAllListeners([event])

emitter.removeListener用過(guò)了，但一個(gè)事件可以有多個(gè)監(jiān)聽(tīng)，需要全部移除時(shí)，一個(gè)個(gè)移除明顯不是愉快的做法，不符合偷懶的天性！

讓我們來(lái)體驗(yàn)一下emitter.removeAllListeners帶來(lái)的便捷!

復(fù)制代碼代碼如下:

var EventEmitter = require('events').EventEmitter;   
var ee = new EventEmitter();
var listener = function(foo,bar)
{
    console.log("第1個(gè)監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
}
var listener2= function(foo,bar)
{
    console.log("第2個(gè)監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
}
ee.on('some_events', listener);
ee.on('some_events', listener2);
ee.on('other_events',function(foo,bar)
{
    console.log("其它監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
});
/*
    EventEmitter.removeAllListeners([event])   移除（批定事件）所有監(jiān)聽(tīng)器
    參數(shù)1：可選參數(shù)，event  字符串，事件名
*/
ee.removeAllListeners('some_events');
ee.emit('some_events', 'Wilson', 'Zhong');
ee.emit('other_events', 'Wilson', 'Zhong');
emitter.removeAllListeners 傳入事件名參數(shù)示例源碼

看看上面的執(zhí)行結(jié)果，你會(huì)發(fā)現(xiàn)給some_events注冊(cè)了兩個(gè)監(jiān)聽(tīng)；給other_events注冊(cè)了一個(gè)監(jiān)聽(tīng)；我調(diào)用emitter.removeAllListeners傳了some_events事件名；

最后使用emitter.on函數(shù)觸發(fā)some_events和other_events兩個(gè)事件，最后發(fā)現(xiàn)some_events注冊(cè)的兩個(gè)監(jiān)聽(tīng)都不存在，而other_events注冊(cè)的監(jiān)聽(tīng)還存在；

這表示當(dāng) emitter.removeAllListeners傳用事件名作為參數(shù)時(shí)，為移除傳入事件名的所有監(jiān)聽(tīng)，而不會(huì)影響其它事件監(jiān)聽(tīng)！

emitter.removeAllListeners可以不傳用事件名參數(shù)；直接執(zhí)行

復(fù)制代碼代碼如下:

var EventEmitter = require('events').EventEmitter;   
var ee = new EventEmitter();
var listener = function(foo,bar)
{
    console.log("第1個(gè)監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
}
var listener2= function(foo,bar)
{
    console.log("第2個(gè)監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
}
ee.on('some_events', listener);
ee.on('some_events', listener2);
ee.on('other_events',function(foo,bar)
{
    console.log("其它監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
});
/*
    EventEmitter.removeAllListeners([event])   移除（批定事件）所有監(jiān)聽(tīng)器
    參數(shù)1：可選參數(shù)，event  字符串，事件名
*/
ee.removeAllListeners();
ee.emit('some_events', 'Wilson', 'Zhong');
ee.emit('other_events', 'Wilson', 'Zhong');
emitter.removeAllListeners 不傳參數(shù)示例源碼

示例代碼和傳入?yún)?shù)時(shí)幾乎一樣，只是在調(diào)用emitter.removeAllListeners并沒(méi)有傳入指定事件名；

運(yùn)行結(jié)果會(huì)發(fā)現(xiàn)some_events和other_events所有監(jiān)聽(tīng)都不存在了，它會(huì)移除所有監(jiān)聽(tīng)！（比較暴力的方法一般要慎用~~）

emitter.listeners(event)

復(fù)制代碼代碼如下:

var EventEmitter = require('events').EventEmitter;   
var ee = new EventEmitter();
var listener = function(foo,bar)
{
    console.log("第1個(gè)監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
}
var listener2= function(foo,bar)
{
    console.log("第2個(gè)監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
}
ee.on('some_events', listener);
ee.on('some_events', listener2);
ee.on('other_events',function(foo,bar)
{
    console.log("其它監(jiān)聽(tīng)事件,參數(shù)foo=" + foo + ",bar="+bar );
});
/*
    EventEmitter.listeners(event)   //返回指定事件的監(jiān)聽(tīng)數(shù)組
    參數(shù)1：event  字符串，事件名    
*/
var listenerEventsArr = ee.listeners('some_events');
console.log(listenerEventsArr.length)
for (var i = listenerEventsArr.length - 1; i >= 0; i--) {
    console.log(listenerEventsArr[i]); 
};
emitter.listeners(event) 示例源碼

給some_events注冊(cè)兩個(gè)監(jiān)聽(tīng)，調(diào)用emitter.listeners函數(shù)，傳入some_events事件名，接收函數(shù)返回值；

從結(jié)果可以看出，返回值接收到some_events所有注冊(cè)監(jiān)聽(tīng)的集合！

emitter.setMaxListeners(n)

一個(gè)事件可以添加多個(gè)監(jiān)聽(tīng)是沒(méi)錯(cuò)，但Nodejs默認(rèn)最大值是多少呢？

復(fù)制代碼代碼如下:

var EventEmitter = require('events').EventEmitter;   
var ee = new EventEmitter();
/*
     給EventEmitter 添加11個(gè)監(jiān)聽(tīng)
*/
for (var i = 10; i >= 0; i--) {
    ee.on('some_events',function()
    {
        console.log('第'+ (i +1) +'個(gè)監(jiān)聽(tīng)');
    });
};
添加N個(gè)監(jiān)聽(tīng)示例源碼

上面示例中我用個(gè)循環(huán)給some_events添加11個(gè)監(jiān)聽(tīng)，執(zhí)行代碼，發(fā)現(xiàn)warning信息出現(xiàn)，并且提示的比較詳細(xì)了，需要用emitter.setMaxListeners()去提升限值

復(fù)制代碼代碼如下:

var EventEmitter = require('events').EventEmitter;   
var ee = new EventEmitter();
/*
    EventEmitter.setMaxListeners (n)   給EventEmitter設(shè)置最大監(jiān)聽(tīng)
    參數(shù)1： n 數(shù)字類(lèi)型，最大監(jiān)聽(tīng)數(shù)

    超過(guò)10個(gè)監(jiān)聽(tīng)時(shí)，不設(shè)置EventEmitter的最大監(jiān)聽(tīng)數(shù)會(huì)提示：
    (node) warning: possible EventEmitter memory leak detected. 11 listeners added.
     Use emitter.setMaxListeners() to increase limit.
    設(shè)計(jì)者認(rèn)為偵聽(tīng)器太多，可能導(dǎo)致內(nèi)存泄漏，所以存在這樣一個(gè)警告
*/
ee.setMaxListeners(15);
/*
     給EventEmitter 添加11個(gè)監(jiān)聽(tīng)
*/
for (var i = 10; i >= 0; i--) {
    ee.on('some_events',function()
    {
        console.log('第'+ (i +1) +'個(gè)監(jiān)聽(tīng)');
    });
};
emitter.setMaxListeners 示例源碼

當(dāng)我調(diào)用emitter.setMaxListeners傳入15時(shí)，執(zhí)行代碼，warning信息不再出現(xiàn)；

emitter.setMaxListeners的作用是給EventEmitter設(shè)置最大監(jiān)聽(tīng)數(shù)，感覺(jué)一般是不需要設(shè)置這個(gè)值，10個(gè)還不夠用的情況應(yīng)該是比較少了！

設(shè)計(jì)者認(rèn)為偵聽(tīng)器太多會(huì)導(dǎo)致內(nèi)存泄漏，所有就給出了一個(gè)警告！

其它...

用的比較少的就不詳細(xì)說(shuō)了

EventEmitter.defaultMaxListeners

    EventEmitter.defaultMaxListeners功能與setMaxListeners類(lèi)似，
    給所有EventEmitter設(shè)置最大監(jiān)聽(tīng)
    setMaxListeners優(yōu)先級(jí)大于defaultMaxListeners

EventEmitter.listenerCount(emitter, event)

返回指定事件的監(jiān)聽(tīng)數(shù)

特殊的事件Error

引用自Node.js開(kāi)發(fā)指南：EventEmitter 定義了一個(gè)特殊的事件 error，它包含了“錯(cuò)誤”的語(yǔ)義，我們?cè)谟龅?異常的時(shí)候通常會(huì)發(fā)射 error 事件。當(dāng) error 被發(fā)射時(shí)，EventEmitter 規(guī)定如果沒(méi)有響應(yīng)的監(jiān)聽(tīng)器，Node.js 會(huì)把它當(dāng)作異常，退出程序并打印調(diào)用棧。我們一般要為會(huì)發(fā)射 error 事件的對(duì)象設(shè)置監(jiān)聽(tīng)器，避免遇到錯(cuò)誤后整個(gè)程序崩潰。

事件的繼承

以后歸到util里再講一下吧，有興趣的可以自已看看 http://nodejs.org/api/util.html#util_util_inherits_constructor_superconstructor

您可能感興趣的文章: