本文基于 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);