本文基于 Node.js v7.2.0 文檔解析 , 官方文檔https://nodejs.org/api/util.html
events 模塊的是為了解決什么問題等浊?
Node 的大部分核心事件API 都是異步事件驅(qū)動(dòng)的把篓。為此需要一個(gè)監(jiān)聽異步的操作來了解情況屹逛。為此events 模塊就誕生了,可以監(jiān)聽I/O的情況
引入event
var event = require('events');
這個(gè) event 是一個(gè)類(JS中類即函數(shù))涤垫,它還有幾個(gè)成員漾肮,其中EventEmitter
這個(gè)類跟events類是一樣的谤狡,這樣寫的目的是為了跨版本兼容(Node 自身的 API 版本變動(dòng))
event === event.EventEmitter; // true
先展示一個(gè)簡單的關(guān)于EventEmitter 的 demo.其中實(shí)現(xiàn)了繼承灸眼,通過on方法監(jiān)聽事件,emit觸發(fā)事件墓懂,如下所示:
class MyEmitter extends event {}
const EventEmitter = require('events');
//實(shí)現(xiàn)繼承類
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
myEmitter.on('event', () => {
console.log('an event occurred!');
});
myEmitter.emit('event');
//an event occurred!
向事件監(jiān)聽回調(diào)函數(shù)傳遞參數(shù)焰宣,如下所示:
const MyEmitter = require('events').EventEmitter;
//直接生成類
const MyEmitter = require('events').EventEmitter;
const myEmitter = new MyEmitter();
myEmitter.on('event', function(a, b) {
console.log(a, b, this);
});
myEmitter.emit('event', 'a', 'b');
一次性事件監(jiān)聽
EventEmiter可以使用once監(jiān)聽某個(gè)事件,則該事件處理程序只會(huì)觸發(fā)一次捕仔,之后emit該事件都會(huì)被忽略匕积,因?yàn)楸O(jiān)聽程序被注銷了,如下所示:
var event = require('events')
class MyEmitter extends event {}
const myEmitter = new MyEmitter();
var m = 0;
myEmitter.on('event', () => {
console.log(++m);
});
myEmitter.emit('event');
// Prints: 1
myEmitter.emit('event');
// Prints: 2
使用once
var event = require('events')
class MyEmitter extends event {}
const myEmitter = new MyEmitter();
var m = 0;
myEmitter.once('event', () => {
console.log(++m);
});
myEmitter.emit('event');
// Prints: 1
myEmitter.emit('event');
// Ignored
class EventEmitter
監(jiān)聽事件和分發(fā)事件
EventEmitter實(shí)例可以使用on 或addListener 監(jiān)聽事件榜跌,emit 方法觸發(fā)事件
上面有demo 可查看闪唆,不贅述
事件監(jiān)聽程序的執(zhí)行順序
EventEmiter實(shí)例可以綁定多個(gè)事件,當(dāng)我們順序觸發(fā)這些事件時(shí)钓葫,EventEmiter會(huì)以同步模式執(zhí)行悄蕾,既第一個(gè)事件處理函數(shù)沒有完成,便不會(huì)觸發(fā)下一個(gè)事件 , 如下所示
var event = require('events')
console.log(event === event.EventEmitter);
class myEmiter extends event{}
const myEmitterData = new myEmiter();
myEmitterData.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í)行了');
});
myEmitterData.on('data1',(data1)=>{
console.log("data1事件開始執(zhí)行...");
});
myEmitterData.emit('data',{a:1});
myEmitterData.emit('data1',{a:1});
當(dāng)然我們可以在回調(diào)函數(shù)中使用異步操作,例如setTimeout帆调,setImmediate或者process.nextTick()等 , 不管位置在前面還是后面添加奠骄,都是最后觸發(fā) , 如下所示:
myEmitterData.on('data',(data1)=>{
setTimeout(function(){
console.log("事件開始執(zhí)行...");
},2000)
});
移除事件綁定
類似DOM事件監(jiān)聽,EventEmiter也可以移除事件綁定番刊,利用removeListener(eventName,listener)
方法解除某個(gè)事件的綁定含鳞,因此回調(diào)函數(shù)listener必須是命名函數(shù),要不然找不到該函數(shù)芹务,因?yàn)楹瘮?shù)是引用型類型蝉绷,就算函數(shù)體是一樣,也不是同一個(gè)函數(shù) 锄禽, 這里和瀏覽器的監(jiān)聽事件一樣潜必,匿名函數(shù)是不能被移除的
獲取事件監(jiān)聽數(shù)量和監(jiān)聽函數(shù) , 獲取和設(shè)置emitter的最大監(jiān)聽數(shù)量
emitter通過getMaxListeners()
方法獲取最大監(jiān)聽數(shù)量以及setMaxListeners(n)
方法設(shè)置最大監(jiān)聽數(shù)量,如果設(shè)置了最大監(jiān)聽數(shù)量,則同一事件的監(jiān)聽最好不要超過該最大值沃但,否則很可能發(fā)送內(nèi)存泄漏
var event = require('events')
console.log(event === event.EventEmitter);
class myEmiter extends event{}
const myEmitterData = new myEmiter();
var b = () => {
console.log('max config');
}
myEmitterData.on('data',function(e){
console.log(e);
});
// myEmitterData.removeListener('data');
function deal(e){
console.log(e);
}
myEmitterData.on('data',b);
myEmitterData.setMaxListeners(1);
console.log(myEmitterData.getMaxListeners());
myEmitterData.emit('data','hello data!');
myEmitterData.on('data1',deal);
myEmitterData.removeListener('data1',deal);
myEmitterData.emit('data1','hello data1!');
console.log(myEmitterData.listeners('data'));
console.log(myEmitterData.listenerCount('data'));
console.log(myEmiter.defaultMaxListeners);