Nodejs的大部分核心API都是基于異步事件驅動設計的,所有可以分發事件的對象都是EventEmitter類的實例。
大家知道,由于nodejs是單線程運行的,所以nodejs需要借助事件輪詢,不斷去查詢事件隊列中的事件消息,然后執行該事件對應的回調函數,有點類似windows的消息映射機制。至于更細的實現環節,可以另行查找資料。
下面介紹EventEmitter的使用。
1、監聽事件和分發事件
EventEmitter實例可以使用on
或addListener
監聽事件,emit()
方法分發事件,如下所示:
const events = require('events'), EventEmitter = events.EventEmitter, util = require('util');function myEmiter(){ EventEmitter.call(this);};util.inherits(myEmiter,EventEmitter);//繼承EventEmitter類const myEmitterIns = new myEmiter();myEmitterIns.on('data',(o)=>{ console.log('receive the data:'+o.a);});
或者使用class類
class myEmiter extends EventEmitter{}//繼承EventEmitter類const myEmitterIns = new myEmiter();myEmitterIns.on('data',(o)=>{ console.log('receive the data:'+o.a);});myEmitterIns.emit('data',{a:1});
執行結果如下:
E:/developmentdocument/nodejsdemo>node event-example.js
receive the data:1
2、向事件監聽回調函數傳遞參數
從上面的例子可以看出,emit()
方法可以傳遞任意的參數集合給回調函數,需要注意的一點是this關鍵字指向的是調用emit方法的EventEmiter實例,但在箭頭函數中例外,this指向的是全局this,因為箭頭函數中的this是在定義時綁定。如下所示:
class myEmiter extends EventEmitter{}const myEmitterIns = new myEmiter();myEmitterIns.on('data',function(data){ console.log("普通回調函數中this:"); console.log(this);});myEmitterIns.on('data1',(data1)=>{ console.log("箭頭回調函數中this:"); console.log(this);});myEmitterIns.emit('data',{a:1});myEmitterIns.emit('data1',{a:1});
執行結果如下:
E:/developmentdocument/nodejsdemo>node event-example.js
普通回調函數中this:
myEmiter {
domain: null,
_events: { data: [Function], data1: [Function] },
_eventsCount: 2,
_maxListeners: undefined }
箭頭回調函數中this:
{}
這里講到箭頭函數中的this,就順便說一下,為什么箭頭函數能夠實現定義時綁定this,就是因為箭頭函數內部根本就沒有綁定this的機制,它使用的是外層作用域的this,因此它也不能作為構造函數。
3、事件監聽程序的執行順序
EventEmiter實例可以綁定多個事件,當我們順序觸發這些事件時,EventEmiter會以同步模式執行,既第一個事件處理函數沒有完成,便不會觸發下一個事件,如下所示:
class myEmiter extends EventEmitter{}const myEmitterIns = new myEmiter();myEmitterIns.on('data',function(data){ console.time('data事件執行了'); for(var i = 0 ; i< 100000; i++) for(var j = 0 ; j< 100000; j++) ; console.timeEnd('data事件執行了');});myEmitterIns.on('data1',(data1)=>{ console.log("data1事件開始執行...");});myEmitterIns.emit('data',{a:1});myEmitterIns.emit('data1',{a:1});
執行結果如下:
E:/developmentdocument/nodejsdemo>node event-example.js
data事件執行了: 4721.401ms
data1事件開始執行...
當然我們可以在回調函數中使用異步操作,例如setTimeout,setImmediate或者process.nextTick()等,從而實現異步的效果,如下所示:
myEmitterIns.on('data',function(data){ setImmediate(()=>{ console.log('data事件執行了...'); });});
執行結果如下:
E:/developmentdocument/nodejsdemo>node event-example.js
data1事件執行了...
data事件執行了...
4、一次性事件監聽
EventEmiter可以使用once監聽某個事件,則該事件處理程序只會觸發一次,之后emit該事件都會被忽略,因為監聽程序被注銷了,如下所示:
myEmitterIns.once('one',(data)=>{ console.log(data);});myEmitterIns.emit('one','this is first call!');myEmitterIns.emit('one','this is second call!');
執行結果如下:
E:/developmentdocument/nodejsdemo>node event-example.js
this is first call!
從上面的結果看出,'one'事件只執行了一次。
5、移除事件綁定
類似DOM事件監聽,EventEmiter也可以移除事件綁定,利用removeListener(eventName,listener)
方法解除某個事件的綁定,因此回調函數listener必須是命名函數,要不然找不到該函數,因為函數是引用型類型,就算函數體是一樣,也不是同一個函數,如下所示:
myEmitterIns.on('data',function(e){ console.log(e);});myEmitterIns.removeListener('data',function(e){ console.log(e);});myEmitterIns.emit('data','hello data!');function deal(e){ console.log(e);}myEmitterIns.on('data1',deal);myEmitterIns.removeListener('data1',deal);myEmitterIns.emit('data1','hello data1!');
執行結果如下:
E:/developmentdocument/nodejsdemo>node event-example.js
hello data!
E:/developmentdocument/nodejsdemo>
從執行結果可以看出,data事件使用的是匿名函數,因此沒有被移除掉,而data1事件則成功解除綁定了。這里需要注意一點的是emit觸發某個事件后,所有跟該事件綁定的回調函數都會被調用,即使你在某個回調函數中使用removeListener函數移除掉另一個回調也沒有用,但是隨后的事件隊列是移除了該回調的。如下所示:
function dealData1(e){ console.log('data事件執行了...A');}myEmitterIns.on('data',function(e){ console.log(e); myEmitterIns.removeListener('data',dealData1);//這里解除dealData1的綁定});myEmitterIns.on('data',dealData1);myEmitterIns.emit('data','data事件執行了...B');/*執行結果為: data事件執行了...B data事件執行了...A*///再次觸發該事件時,dealData1回調已經被解除綁定了myEmitterIns.emit('data','data事件執行了...');//data事件執行了...
另外可以使用removeAllListeners()
解除所有事件的綁定。
6、獲取事件監聽數量和監聽函數
使用emitter.listenerCount(eventName)
函數獲取指定事件的監聽數量,函數emitter.listeners(eventName)
則可以用來獲取指定事件的所有監聽函數,使用如下所示:
var cbA = ()=>{}, cbB = ()=>{};var emitter = new myEmiter();emitter.on('data',cbA);emitter.on('data',cbB);console.log('emitter實例的data事件綁定了%d個回調函數',emitter.listenerCount('data'));console.log('它們是:',emitter.listeners('data'));
執行結果如下:
E:/developmentdocument/nodejsdemo>node event-example.js
emitter實例的data事件綁定了2個回調函數
它們是: [ [Function: cbA], [Function: cbB] ]
7、獲取和設置emitter的最大監聽數量
nodejs對同一事件的監聽數量建議不宜超過10個,這個可以查看EventEmitter.defaultMaxListeners
屬性便可得知,如下所示:
console.log(EventEmitter.defaultMaxListeners);//結果為10個
emitter通過getMaxListeners()
方法獲取最大監聽數量以及setMaxListeners(n)
方法設置最大監聽數量,如下所示:
var cbA = ()=>{}, cbB = ()=>{};var emitter = new myEmiter();emitter.setMaxListeners(1);emitter.on('data',cbA);emitter.on('data',cbB);console.log(emitter.getMaxListeners());
執行結果如下:
E:/developmentdocument/nodejsdemo>node event-example.js
emitter的事件最大監聽數是:1
(node:6808) Warning: Possible EventEmitter memory leak detected. 2 data listener
s added. Use emitter.setMaxListeners() to increase limit
如上結果所示,如果設置了最大監聽數量,則同一事件的監聽最好不要超過該最大值,否則很可能發送內存泄漏。
events模塊便介紹到這。希望對大家的學習有所幫助,也希望大家多多支持武林網。
新聞熱點
疑難解答