Nodejs的大部分核心API都是基于異步事件驅(qū)動(dòng)設(shè)計(jì)的，所有可以分發(fā)事件的對(duì)象都是EventEmitter類(lèi)的實(shí)例。

大家知道，由于nodejs是單線(xiàn)程運(yùn)行的，所以nodejs需要借助事件輪詢(xún)，不斷去查詢(xún)事件隊(duì)列中的事件消息，然后執(zhí)行該事件對(duì)應(yīng)的回調(diào)函數(shù)，有點(diǎn)類(lèi)似windows的消息映射機(jī)制。至于更細(xì)的實(shí)現(xiàn)環(huán)節(jié)，可以另行查找資料。

下面介紹EventEmitter的使用。

1、監(jiān)聽(tīng)事件和分發(fā)事件

EventEmitter實(shí)例可以使用on或addListener監(jiān)聽(tīng)事件，emit()方法分發(fā)事件，如下所示：

const events = require('events'),
   EventEmitter = events.EventEmitter,
   util = require('util');
function myEmiter(){
  EventEmitter.call(this);
};
util.inherits(myEmiter,EventEmitter);//繼承EventEmitter類(lèi)
const myEmitterIns = new myEmiter();
myEmitterIns.on('data',(o)=>{
  console.log('receive the data:'+o.a);
});

或者使用class類(lèi)

class myEmiter extends EventEmitter{}//繼承EventEmitter類(lèi)
const myEmitterIns = new myEmiter();

myEmitterIns.on('data',(o)=>{
  console.log('receive the data:'+o.a);
});
myEmitterIns.emit('data',{a:1});

執(zhí)行結(jié)果如下：

E:\developmentdocument\nodejsdemo>node event-example.js
receive the data:1

2、向事件監(jiān)聽(tīng)回調(diào)函數(shù)傳遞參數(shù)

從上面的例子可以看出，emit()方法可以傳遞任意的參數(shù)集合給回調(diào)函數(shù)，需要注意的一點(diǎn)是this關(guān)鍵字指向的是調(diào)用emit方法的EventEmiter實(shí)例，但在箭頭函數(shù)中例外，this指向的是全局this，因?yàn)榧^函數(shù)中的this是在定義時(shí)綁定。如下所示：

class myEmiter extends EventEmitter{}
const myEmitterIns = new myEmiter();
myEmitterIns.on('data',function(data){
  console.log("普通回調(diào)函數(shù)中this：");
  console.log(this);
});
myEmitterIns.on('data1',(data1)=>{
  console.log("箭頭回調(diào)函數(shù)中this：");
  console.log(this);
});
myEmitterIns.emit('data',{a:1});
myEmitterIns.emit('data1',{a:1});

執(zhí)行結(jié)果如下：

E:\developmentdocument\nodejsdemo>node event-example.js
普通回調(diào)函數(shù)中this：
myEmiter {
domain: null,
_events: { data: [Function], data1: [Function] },
_eventsCount: 2,
_maxListeners: undefined }
箭頭回調(diào)函數(shù)中this：
{}

這里講到箭頭函數(shù)中的this，就順便說(shuō)一下，為什么箭頭函數(shù)能夠?qū)崿F(xiàn)定義時(shí)綁定this，就是因?yàn)榧^函數(shù)內(nèi)部根本就沒(méi)有綁定this的機(jī)制，它使用的是外層作用域的this，因此它也不能作為構(gòu)造函數(shù)。

3、事件監(jiān)聽(tīng)程序的執(zhí)行順序

EventEmiter實(shí)例可以綁定多個(gè)事件，當(dāng)我們順序觸發(fā)這些事件時(shí)，EventEmiter會(huì)以同步模式執(zhí)行，既第一個(gè)事件處理函數(shù)沒(méi)有完成，便不會(huì)觸發(fā)下一個(gè)事件，如下所示：

class myEmiter extends EventEmitter{}
const myEmitterIns = new myEmiter();
myEmitterIns.on('data',function(data){
  console.time('data事件執(zhí)行了');
  for(var i = 0 ; i< 100000; i++)
    for(var j = 0 ; j< 100000; j++)
      ;
  console.timeEnd('data事件執(zhí)行了');
});
myEmitterIns.on('data1',(data1)=>{
  console.log("data1事件開(kāi)始執(zhí)行...");
});
myEmitterIns.emit('data',{a:1});
myEmitterIns.emit('data1',{a:1});

執(zhí)行結(jié)果如下：

E:\developmentdocument\nodejsdemo>node event-example.js
data事件執(zhí)行了: 4721.401ms
data1事件開(kāi)始執(zhí)行...

當(dāng)然我們可以在回調(diào)函數(shù)中使用異步操作，例如setTimeout，setImmediate或者process.nextTick()等，從而實(shí)現(xiàn)異步的效果，如下所示：

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

執(zhí)行結(jié)果如下：

E:\developmentdocument\nodejsdemo>node event-example.js
data1事件執(zhí)行了...
data事件執(zhí)行了...

4、一次性事件監(jiān)聽(tīng)

EventEmiter可以使用once監(jiān)聽(tīng)某個(gè)事件，則該事件處理程序只會(huì)觸發(fā)一次，之后emit該事件都會(huì)被忽略，因?yàn)楸O(jiān)聽(tīng)程序被注銷(xiāo)了，如下所示：

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

執(zhí)行結(jié)果如下：

E:\developmentdocument\nodejsdemo>node event-example.js
this is first call!

從上面的結(jié)果看出，'one'事件只執(zhí)行了一次。

5、移除事件綁定

類(lèi)似DOM事件監(jiān)聽(tīng)，EventEmiter也可以移除事件綁定，利用removeListener(eventName,listener)方法解除某個(gè)事件的綁定，因此回調(diào)函數(shù)listener必須是命名函數(shù)，要不然找不到該函數(shù)，因?yàn)楹瘮?shù)是引用型類(lèi)型，就算函數(shù)體是一樣，也不是同一個(gè)函數(shù)，如下所示：

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

執(zhí)行結(jié)果如下：

E:\developmentdocument\nodejsdemo>node event-example.js
hello data!
E:\developmentdocument\nodejsdemo>

從執(zhí)行結(jié)果可以看出，data事件使用的是匿名函數(shù)，因此沒(méi)有被移除掉，而data1事件則成功解除綁定了。這里需要注意一點(diǎn)的是emit觸發(fā)某個(gè)事件后，所有跟該事件綁定的回調(diào)函數(shù)都會(huì)被調(diào)用，即使你在某個(gè)回調(diào)函數(shù)中使用removeListener函數(shù)移除掉另一個(gè)回調(diào)也沒(méi)有用，但是隨后的事件隊(duì)列是移除了該回調(diào)的。如下所示：

function dealData1(e){
  console.log('data事件執(zhí)行了...A');
}
myEmitterIns.on('data',function(e){
  console.log(e);
  myEmitterIns.removeListener('data',dealData1);//這里解除dealData1的綁定
});
myEmitterIns.on('data',dealData1);
myEmitterIns.emit('data','data事件執(zhí)行了...B');
/*執(zhí)行結(jié)果為：
 data事件執(zhí)行了...B
 data事件執(zhí)行了...A
*/
//再次觸發(fā)該事件時(shí),dealData1回調(diào)已經(jīng)被解除綁定了
myEmitterIns.emit('data','data事件執(zhí)行了...');
//data事件執(zhí)行了...

另外可以使用removeAllListeners()解除所有事件的綁定。

6、獲取事件監(jiān)聽(tīng)數(shù)量和監(jiān)聽(tīng)函數(shù)

使用emitter.listenerCount(eventName)函數(shù)獲取指定事件的監(jiān)聽(tīng)數(shù)量，函數(shù)emitter.listeners(eventName)則可以用來(lái)獲取指定事件的所有監(jiān)聽(tīng)函數(shù)，使用如下所示：

var cbA = ()=>{},
  cbB = ()=>{};
var emitter = new myEmiter();
emitter.on('data',cbA);
emitter.on('data',cbB);
console.log('emitter實(shí)例的data事件綁定了%d個(gè)回調(diào)函數(shù)',emitter.listenerCount('data'));
console.log('它們是：',emitter.listeners('data'));

執(zhí)行結(jié)果如下：

E:\developmentdocument\nodejsdemo>node event-example.js
emitter實(shí)例的data事件綁定了2個(gè)回調(diào)函數(shù)
它們是： [ [Function: cbA], [Function: cbB] ]

7、獲取和設(shè)置emitter的最大監(jiān)聽(tīng)數(shù)量
nodejs對(duì)同一事件的監(jiān)聽(tīng)數(shù)量建議不宜超過(guò)10個(gè)，這個(gè)可以查看EventEmitter.defaultMaxListeners屬性便可得知，如下所示：

console.log(EventEmitter.defaultMaxListeners);//結(jié)果為10個(gè)

emitter通過(guò)getMaxListeners()方法獲取最大監(jiān)聽(tīng)數(shù)量以及setMaxListeners(n)方法設(shè)置最大監(jiān)聽(tīng)數(shù)量,如下所示：

var cbA = ()=>{},
  cbB = ()=>{};
var emitter = new myEmiter();
emitter.setMaxListeners(1);
emitter.on('data',cbA);
emitter.on('data',cbB);
console.log(emitter.getMaxListeners());

執(zhí)行結(jié)果如下：

E:\developmentdocument\nodejsdemo>node event-example.js
emitter的事件最大監(jiān)聽(tīng)數(shù)是：1
(node:6808) Warning: Possible EventEmitter memory leak detected. 2 data listener
s added. Use emitter.setMaxListeners() to increase limit

如上結(jié)果所示，如果設(shè)置了最大監(jiān)聽(tīng)數(shù)量，則同一事件的監(jiān)聽(tīng)最好不要超過(guò)該最大值，否則很可能發(fā)送內(nèi)存泄漏。

events模塊便介紹到這。希望對(duì)大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評(píng)論