簡介及資料 http://www./cn/articles/tyq-nodejs-event events是node.js 最重要的模塊,events模塊只提供了一個對象events.EventEmitter,EventEmitter 的核心是事件發(fā)射與事件監(jiān)聽器。 Node.js中大部分的模塊,都繼承自Event模塊。 與DOM樹上事件不同,不存在事件冒泡、逐層捕獲等行為。 EventEmitter 支持若干個事件監(jiān)聽器。當事件發(fā)射時,注冊到這個事件的事件監(jiān)聽器被依次調用,事件參數(shù)作為回調函數(shù)參數(shù)傳遞。 如何訪問: 復制代碼 代碼如下: require('events');
emitter.on(event, listener)
復制代碼 代碼如下: /* 調用events模塊,獲取events.EventEmitter對象 */ var EventEmitter = require('events').EventEmitter; var ee = new EventEmitter(); /* EventEmitter.on(event, listener) 為事件注冊一個監(jiān)聽 參數(shù)1:event 字符串,事件名 參數(shù)2:回調函數(shù) */ ee.on('some_events', function(foo, bar) { console.log("第1個監(jiān)聽事件,參數(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], [...])
復制代碼 代碼如下: var EventEmitter = require('events').EventEmitter; var ee = new EventEmitter(); ee.on('some_events', function(foo, bar) { console.log("第1個監(jiān)聽事件,參數(shù)foo=" + foo + ",bar="+bar ); }); /* EventEmitter.emit(event, [arg1], [arg2], [...]) 觸發(fā)指定事件 參數(shù)1:event 字符串,事件名 參數(shù)2:可選參數(shù),按順序傳入回調函數(shù)的參數(shù) 返回值:該事件是否有監(jiān)聽 */ var isSuccess = ee.emit('some_events', 'Wilson', 'Zhong'); ee.on('some_events', function(foo, bar) { console.log("第2個監(jiān)聽事件,參數(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], [...]) 示例源碼
示例進行了三次觸發(fā)事件操作,其中some_events注冊了監(jiān)聽,調用時emit函數(shù)會返回一個true,而other_events并沒有注冊監(jiān)聽,emit函數(shù)會返回一個false,表示該事件沒有監(jiān)聽;當然也可以不用管這個返回值! emitter.once(event, listener)
復制代碼 代碼如下: var EventEmitter = require('events').EventEmitter; var ee = new EventEmitter(); /* EventEmitter.once(event, listener) 為事件注冊一次性監(jiān)聽,觸發(fā)一次后移除監(jiān)聽 參數(shù)1:event 字符串,事件名 參數(shù)2:回調函數(shù) */ ee.once('some_events', function(foo, bar) { console.log("第1個監(jiān)聽事件,參數(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í)行結果可以看出,用emitter.once給some_events注冊一個監(jiān)聽后,分兩輪調用emitter.emit觸發(fā),第二輪會返回false;這表示用emitter.once注冊監(jiān)聽和用前面講的emitter.on注冊監(jiān)聽略有不同, emitter.once注冊監(jiān)聽是一次性監(jiān)聽,當觸發(fā)一次后,會移除該監(jiān)聽!當然,從名字上就看就比較明顯了^_^! emitter.removeListener(event, listener) 先來看一個失敗的場景~~~
復制代碼 代碼如下: var EventEmitter = require('events').EventEmitter; var ee = new EventEmitter(); ee.on('some_events', function(foo, bar) { console.log("第1個監(jiān)聽事件,參數(shù)foo=" + foo + ",bar="+bar ); }); /* 看到API中removeListener移除方法時,以為應該是這樣 但是結果^_^!!!!! */ ee.removeListener('some_events', function(){ console.log('成功移除事件some_events監(jiān)聽!'); }); console.log('第一輪'); ee.emit('some_events', 'Wilson', 'Zhong'); emitter.removeListener(event, listener) 示例失敗場景源碼
當我用emitter.on給some_events注冊了一個監(jiān)聽后,我用emiiter.removeListener移除some_events的監(jiān)聽,隨后再調用emitter.emit去觸發(fā),最后發(fā)現(xiàn)不是按我想像的在進行!為什么呢? 我理所當然的認為emiiter.removeListener第二個參數(shù)是個回調函數(shù),API還是要認真看清楚?。。。?/p> 下面再看個成功的場景~~~
復制代碼 代碼如下: var EventEmitter = require('events').EventEmitter; var ee = new EventEmitter(); var listener = function(foo,bar) { console.log("第1個監(jiān)聽事件,參數(shù)foo=" + foo + ",bar="+bar ); } var listener2= function(foo,bar) { console.log("第2個監(jiān)聽事件,參數(shù)foo=" + foo + ",bar="+bar ); } var listener3= function(foo,bar) { console.log("第3個監(jiān)聽事件,參數(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)聽器 注意:該監(jiān)聽器必須是注冊過的 PS:上一個例子之后以會失敗,很大原因就是忽略了監(jiān)聽器,理所當然的認為傳個事件名就OK了,所以就悲劇了! */ ee.removeListener('some_events', listener); ee.removeListener('some_events', listener3); ee.emit('some_events', 'Wilson', 'Zhong'); emitter.removeListener(event, listener) 示例成功場景源碼
我用示例中寫法,給some_events添加了三個監(jiān)聽,又移除了第一個和第三個監(jiān)聽,最后再用emitter.emit觸發(fā)some_events,輸出結果不難發(fā)現(xiàn),用emitter.removeListener移除的第一個和第三個監(jiān)聽都沒有再起作用, 想當然是害人地,原來emitter.removeListener的第二個參數(shù)是要移除的監(jiān)聽,而非移除成功后的回調函數(shù)……^_^! emitter.removeAllListeners([event]) emitter.removeListener用過了,但一個事件可以有多個監(jiān)聽,需要全部移除時,一個個移除明顯不是愉快的做法,不符合偷懶的天性! 讓我們來體驗一下emitter.removeAllListeners帶來的便捷!
復制代碼 代碼如下: var EventEmitter = require('events').EventEmitter; var ee = new EventEmitter(); var listener = function(foo,bar) { console.log("第1個監(jiān)聽事件,參數(shù)foo=" + foo + ",bar="+bar ); } var listener2= function(foo,bar) { console.log("第2個監(jiān)聽事件,參數(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)聽事件,參數(shù)foo=" + foo + ",bar="+bar ); }); /* EventEmitter.removeAllListeners([event]) 移除(批定事件)所有監(jiān)聽器 參數(shù)1:可選參數(shù),event 字符串,事件名 */ ee.removeAllListeners('some_events'); ee.emit('some_events', 'Wilson', 'Zhong'); ee.emit('other_events', 'Wilson', 'Zhong'); emitter.removeAllListeners 傳入事件名參數(shù)示例源碼
看看上面的執(zhí)行結果,你會發(fā)現(xiàn)給some_events注冊了兩個監(jiān)聽;給other_events注冊了一個監(jiān)聽;我調用emitter.removeAllListeners傳了some_events事件名; 最后使用emitter.on函數(shù)觸發(fā)some_events和other_events兩個事件,最后發(fā)現(xiàn)some_events注冊的兩個監(jiān)聽都不存在,而other_events注冊的監(jiān)聽還存在; 這表示當 emitter.removeAllListeners傳用事件名作為參數(shù)時,為移除傳入事件名的所有監(jiān)聽,而不會影響其它事件監(jiān)聽! emitter.removeAllListeners可以不傳用事件名參數(shù);直接執(zhí)行
復制代碼 代碼如下: var EventEmitter = require('events').EventEmitter; var ee = new EventEmitter(); var listener = function(foo,bar) { console.log("第1個監(jiān)聽事件,參數(shù)foo=" + foo + ",bar="+bar ); } var listener2= function(foo,bar) { console.log("第2個監(jiān)聽事件,參數(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)聽事件,參數(shù)foo=" + foo + ",bar="+bar ); }); /* EventEmitter.removeAllListeners([event]) 移除(批定事件)所有監(jiān)聽器 參數(shù)1:可選參數(shù),event 字符串,事件名 */ ee.removeAllListeners(); ee.emit('some_events', 'Wilson', 'Zhong'); ee.emit('other_events', 'Wilson', 'Zhong'); emitter.removeAllListeners 不傳參數(shù)示例源碼
示例代碼和傳入?yún)?shù)時幾乎一樣,只是在調用emitter.removeAllListeners并沒有傳入指定事件名; 運行結果會發(fā)現(xiàn)some_events和other_events所有監(jiān)聽都不存在了,它會移除所有監(jiān)聽?。ū容^暴力的方法一般要慎用~~) emitter.listeners(event) 復制代碼 代碼如下: var EventEmitter = require('events').EventEmitter; var ee = new EventEmitter(); var listener = function(foo,bar) { console.log("第1個監(jiān)聽事件,參數(shù)foo=" + foo + ",bar="+bar ); } var listener2= function(foo,bar) { console.log("第2個監(jiān)聽事件,參數(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)聽事件,參數(shù)foo=" + foo + ",bar="+bar ); }); /* EventEmitter.listeners(event) //返回指定事件的監(jiān)聽數(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注冊兩個監(jiān)聽,調用emitter.listeners函數(shù),傳入some_events事件名,接收函數(shù)返回值; 從結果可以看出,返回值接收到some_events所有注冊監(jiān)聽的集合! emitter.setMaxListeners(n) 一個事件可以添加多個監(jiān)聽是沒錯,但Nodejs默認最大值是多少呢?
復制代碼 代碼如下: var EventEmitter = require('events').EventEmitter; var ee = new EventEmitter(); /* 給EventEmitter 添加11個監(jiān)聽 */ for (var i = 10; i >= 0; i--) { ee.on('some_events',function() { console.log('第'+ (i +1) +'個監(jiān)聽'); }); }; 添加N個監(jiān)聽示例源碼
上面示例中我用個循環(huán)給some_events添加11個監(jiān)聽,執(zhí)行代碼,發(fā)現(xiàn)warning信息出現(xiàn),并且提示的比較詳細了,需要用emitter.setMaxListeners()去提升限值 復制代碼 代碼如下: var EventEmitter = require('events').EventEmitter; var ee = new EventEmitter(); /* EventEmitter.setMaxListeners (n) 給EventEmitter設置最大監(jiān)聽 參數(shù)1: n 數(shù)字類型,最大監(jiān)聽數(shù) 超過10個監(jiān)聽時,不設置EventEmitter的最大監(jiān)聽數(shù)會提示: (node) warning: possible EventEmitter memory leak detected. 11 listeners added. Use emitter.setMaxListeners() to increase limit. 設計者認為偵聽器太多,可能導致內(nèi)存泄漏,所以存在這樣一個警告 */ ee.setMaxListeners(15); /* 給EventEmitter 添加11個監(jiān)聽 */ for (var i = 10; i >= 0; i--) { ee.on('some_events',function() { console.log('第'+ (i +1) +'個監(jiān)聽'); }); }; emitter.setMaxListeners 示例源碼
當我調用emitter.setMaxListeners傳入15時,執(zhí)行代碼,warning信息不再出現(xiàn); emitter.setMaxListeners的作用是給EventEmitter設置最大監(jiān)聽數(shù),感覺一般是不需要設置這個值,10個還不夠用的情況應該是比較少了! 設計者認為偵聽器太多會導致內(nèi)存泄漏,所有就給出了一個警告! 其它... 用的比較少的就不詳細說了 EventEmitter.defaultMaxListeners EventEmitter.defaultMaxListeners功能與setMaxListeners類似, EventEmitter.listenerCount(emitter, event) 返回指定事件的監(jiān)聽數(shù) 特殊的事件Error 引用自Node.js開發(fā)指南:EventEmitter 定義了一個特殊的事件 error,它包含了“錯誤”的語義,我們在遇到 異常的時候通常會發(fā)射 error 事件。當 error 被發(fā)射時,EventEmitter 規(guī)定如果沒有響 應的監(jiān)聽器,Node.js 會把它當作異常,退出程序并打印調用棧。我們一般要為會發(fā)射 error 事件的對象設置監(jiān)聽器,避免遇到錯誤后整個程序崩潰。 事件的繼承 以后歸到util里再講一下吧,有興趣的可以自已看看 http:///api/util.html#util_util_inherits_constructor_superconstructor |
|