本文基于 Node.js v7.2.0 文檔解析 , 官方文檔https://nodejs.org/api/util.html
events 模塊的是為了解決什么問題?
Node 的大部分核心事件API 都是異步事件驅動的。為此需要一個監聽異步的操作來了解情況。為此events 模塊就誕生了,可以監聽I/O的情況
引入event
var event = require('events');
這個 event 是一個類(JS中類即函數),它還有幾個成員,其中EventEmitter
這個類跟events類是一樣的,這樣寫的目的是為了跨版本兼容(Node 自身的 API 版本變動)
event === event.EventEmitter; // true
先展示一個簡單的關于EventEmitter 的 demo.其中實現了繼承,通過on方法監聽事件,emit觸發事件,如下所示:
class MyEmitter extends event {}
const EventEmitter = require('events');
//實現繼承類
class MyEmitter extends EventEmitter {}
const myEmitter = new MyEmitter();
myEmitter.on('event', () => {
console.log('an event occurred!');
});
myEmitter.emit('event');
//an event occurred!
向事件監聽回調函數傳遞參數,如下所示:
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');
一次性事件監聽
EventEmiter可以使用once監聽某個事件,則該事件處理程序只會觸發一次,之后emit該事件都會被忽略,因為監聽程序被注銷了,如下所示:
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
監聽事件和分發事件
EventEmitter實例可以使用on 或addListener 監聽事件,emit 方法觸發事件
上面有demo 可查看,不贅述
事件監聽程序的執行順序
EventEmiter實例可以綁定多個事件,當我們順序觸發這些事件時,EventEmiter會以同步模式執行,既第一個事件處理函數沒有完成,便不會觸發下一個事件 , 如下所示
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事件執行了');
for(var i = 0 ; i< 100000; i++)
for(var j = 0 ; j< 100000; j++);
console.timeEnd('data事件執行了');
});
myEmitterData.on('data1',(data1)=>{
console.log("data1事件開始執行...");
});
myEmitterData.emit('data',{a:1});
myEmitterData.emit('data1',{a:1});
當然我們可以在回調函數中使用異步操作,例如setTimeout,setImmediate或者process.nextTick()等 , 不管位置在前面還是后面添加,都是最后觸發 , 如下所示:
myEmitterData.on('data',(data1)=>{
setTimeout(function(){
console.log("事件開始執行...");
},2000)
});
移除事件綁定
類似DOM事件監聽,EventEmiter也可以移除事件綁定,利用removeListener(eventName,listener)
方法解除某個事件的綁定,因此回調函數listener必須是命名函數,要不然找不到該函數,因為函數是引用型類型,就算函數體是一樣,也不是同一個函數 , 這里和瀏覽器的監聽事件一樣,匿名函數是不能被移除的
獲取事件監聽數量和監聽函數 , 獲取和設置emitter的最大監聽數量
emitter通過getMaxListeners()
方法獲取最大監聽數量以及setMaxListeners(n)
方法設置最大監聽數量,如果設置了最大監聽數量,則同一事件的監聽最好不要超過該最大值,否則很可能發送內存泄漏
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);