Node.js之EventEmitter

Node.js 之 EventEmitter

Node.js 所有的异步 IO 操作在完成时都会发送一个事件到事件队列

EventEmitter类

events 模块只提供了一个对象：events.EventEmitter 的核心就是事件触发与事件监听功能的封装

var EventEmitter = require('events').EventEmitter;
var event = new EventEmitter();
// 注册事件  相当于注册监听器
event.on('some_event',function(){
    console.log('some_event 事件触发');
});
// 相当于调用监听器
setTimeout(function(){
    event.emit('some_event');
},1000);

• 注：运行这段代码，1秒后控制台输出了 “some_event 事件触发”。其原理是 event 对象注册了事件 some_event 的一个监听器，然后我们通过 setTimeout 在1000毫秒后向 event 对象发送事件 some_event，此时会调用 some_event 的监听器。

EventEmitter 的每个事件由一个事件名和若干个参数组成，事件名是一个字符串，对于每个事件，EventEmitter 支持若干个事件监听器。

当事件触发时，注册到这个事件的事件监听器被依次调用，事件参数作为回调函数参数传递。

var events = require('events');
var emitter = new events.EventEmitter();
// 注册第一个事件监听器
emitter.on('someEvent',function(arg1,arg2){
    console.log('listener1',arg1,arg2);
});
// 注册第二个事件监听器
emitter.on('someEvent',function(arg1,arg2){
    console.log('listener2',arg1,arg2);
});
// 触发事件，事件监听器被依次调用
emitter.emit('someEvent','arg1参数','arg2参数');

注：

• 以上例子中，emitter 为事件 someEvent 注册了两个事件监听器，然后触发了 someEvent 事件。
• 运行结果可以看到两个事件监听器回调函数被先后调用。
• EventEmitter 提供了多个属性，如 on 和 emit。on 函数用于绑定事件函数，emit 属性用于触发一个事件。

方法

addListener(event, listener) 为指定事件添加一个监听器到监听器数组的尾部

on(event , listener) 为指定事件注册一个监听器，接收一个字符串 event 和一个回调函数。 server.on("connection", function(stream){ console.log('someone connected'); });

once(event, listener) 为指定事件注册一个单次监听器，即 监听器最多只会触发一次，触发后立刻解除该监听器。

removeListener(event,listener) 移除指定事件的某个监听器，监听器必须是该事件已经注册过的监听器。它接收两个参数，第一个是事件名称，第二个是回调函数名称。 var callback = function(stream){ console.log('someone connected!'); }; server.on('connection',callback); server.removeListener('connection',callback);

removeAllListeners([event]) 移除所有事件的所有监听器，如果指定事件，则移除指定事件的所有监听器

setMaxListener(n) 默认情况下，EventEmitters 如果你添加的监听器超过 10 个就会输出警告信息。setMaxListeners函数用于提高监听器的默认限制的数量。

listeners(event) 返回指定事件的监听器数组

emit(event,[arg1],[arg2],[...]) 按监听器的顺序执行每个监听器，如果事件由注册监听返回 true，否则返回 false

listenerCount(emitter,event) 返回指定事件的监听器数量

实例

var events = require('events')
var eventEmitter = new events.EventEmitter();

// 监听器 #1
var listener1 = function listener1(){
    console.log('监听器 listener1 执行');
}

// 监听器 #2
var listener2 = function listener2(){
    console.log('监听器 listener2 执行');
}

// 绑定 connection 事件，处理函数为 listener1
eventEmitter.addListener('connection',listener1);

// 绑定 connection 事件，处理函数为 listener2
eventEmitter.on('connection',listener2);

var eventListeners = eventEmitter.listenerCount('connection');
console.log(eventListeners + "个监听器监听连接事件。");

// 处理 connection 事件
eventEmitter.emit('connection');

// 移除绑定的 listener1 函数
eventEmitter.removeListener('connection',listener1);
console.log("listener1 不再受监听。");

// 触发连接事件
eventEmitter.emit('connection');

eventListeners = eventEmitter.listenerCount('connection');
console.log(eventListeners + "个监听器监听连接事件。");

console.log("程序执行完毕");

2个监听器监听连接事件。
监听器 listener1 执行
监听器 listener2 执行
listener1 不再受监听。
监听器 listener2 执行
1个监听器监听连接事件。
程序执行完毕