詳解Node.js：events事件模組

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);
});

  

執行結果如下：

E:developmentdocumentnodejsdemo>node event-example.js

receive the data:1

2、向事件監聽回調函數傳遞參數

2、向事件監聽回調函數傳遞參數

從上面的例子可以看出傳遞任意的參數集合給回呼函數，需要注意的一點是this關鍵字指向的是呼叫emit方法的EventEmiter實例，但在箭頭函數中例外，this指向的是全域this，因為箭頭函數中的this是在定義時綁定。如下圖所示：

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:developmentdocumentnodejsdemo>node event-example.js

: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.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:developmentdocumentnodejsdemo>node event-example.jso

data事件執行了: 4721.40121.當然我們可以在回呼函數中使用非同步操作，例如setTimeout，setImmediate或process.nextTick()等，從而實現非同步操作，例如setTimeout，setImmediate或process.nextTick()等，從而實現非同步的效果，如下所示：

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(&#39;data事件执行了&#39;);
});
myEmitterIns.on(&#39;data1&#39;,(data1)=>{
  console.log("data1事件开始执行...");
});
myEmitterIns.emit(&#39;data&#39;,{a:1});
myEmitterIns.emit(&#39;data1&#39;,{a:1});

   

的執行結果node event-example.js

data1事件執行了...
data事件執行了...

4、一次性事件監聽

EventEmiter可以使用once監聽某個事件，則該事件處理程序只會觸發一次，之後emit該事件都會被忽略，因為監聽程式被註銷了，如下所示：

myEmitterIns.on('data',function(data){
  setImmediate(()=>{
    console.log('data事件执行了...');
  });
});

   

執行結果如下：

E:developmentdocumentnodejsdemonode

從上面的結果看出，'one'事件只執行了一次。

5、移除事件綁定

類似DOM事件監聽，EventEmiter也可以移除事件綁定，利用removeListener(eventName,listener)方法解除某個事件的綁定，因此回呼函數listenerener必須是命名函數，不然找不到該函數，因為函數是引用類型，就算函數體是一樣，也不是同一個函數，如下：

myEmitterIns.once('one',(data)=>{
  console.log(data);
});
myEmitterIns.emit('one','this is first call!');
myEmitterIns.emit('one','this is second call!');

   

執行結果如下：

E:deopmentdocumnodejsdeopmentdocumnode event-example.js

hello data!

E:developmentdocumentnodejsdemo>

從執行結果可以看出，data事件使用的是匿名函數，因此沒有被移除掉，而data1事件則成功解除綁定了。這裡需要注意一點的是emit觸發某個事件後，所有跟該事件綁定的回調函數都會被調用，即使你在某個回調函數中使用removeListener函數移除掉另一個回調也沒有用，但是隨後的事件隊列是移除了該回呼的。如下所示：

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!');

6、取得事件監聽數量和監聽函數

使用emitter.listenerCount(eventName)函數取得指定事件的監聽數量，函數emitter.listeners(eventName)則可以用來取得指定事件的所有監聽函數，使用如下所示：

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()解除所有事件的绑定。

   

執行結果如下：

E:developmentdocumentnodejsdemo>node event-example.js Function: cbA], [Function: cbB] ]

7、獲取和設定emitter的最大監聽數量

nodejs對同一事件的監聽數量建議不宜超過10個，這個可以查看EventEmitter.defaultMaxListeners屬性便可得知，如下所示：

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'));

   

emitter透過getMaxListeners()方法取得最大監聽數量以及setMaxListeners(n)方法設定最大監聽數量,如下所示：

console.log(EventEmitter.defaultMaxListeners);//结果为10个

   

執行結果如下：

E:developmentdocumentnodejsdemo>node event-example.js
emitter的事件最大監聽數是：1
(node:6808) Warning: Possible EventEmitter memory
(node:6808) Warning: Possible EventEmitter memory leakdata .m .setMaxListeners() to increase limit

如上結果所示，如果設定了最大監聽數量，則同一事件的監聽最好不要超過該最大值，否則很可能發送記憶體洩漏。