5.node.js的EventEmitter（事件发射器类）

node.js的EventEmitter（事件发射器类）

EventEmitter类的简单介绍

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

• 如果在实例化时发生错误，会触发 error 事件。
• 添加新的监听器时，newListener 事件会触发，
• 当监听器被移除时，removeListener 事件被触发。

举个简单的例子，代码：

//引入events模块
const events = require('events');
// 创建eventEmitter对象
let eventEmitter = new events.EventEmitter();

//绑定‘some_event’事件
eventEmitter.on('some_event', function () {
    console.log('SOME_EVENT 被触发');
});

//隔1s后发送触发‘some_event’事件
setTimeout(function () {
    eventEmitter.emit('some_event');
},1000);

在cmd运行结果如下：

解释一下他的原理吧：首先eventEmitter对象注册了事件 some_event 的一个监听器，然后我们通过 setTimeout 在 1000 毫秒以后向 eventEmitter 对象发送事件 some_event，此时会调用some_event 的监听器，然后就在控制台输出了’SOME_EVENT 被触发’。

一个事件绑定多个监听器

EventEmitter支持一个事件绑定多个监听器，当事件触发时，注册到这个事件的事件监听器被依次调用，事件参数作为回调函数参数传递。
废话少说，代码撸起：

const events = require('events');
let emitter = new events.EventEmitter();

//绑定第一个监听器
emitter.on('event',function (a,b) {
    console.log('第一个监听器被触发',a,b)
});

//绑定第二个监听器
emitter.on('event',function (a,b) {
    console.log('第二个监听器被触发',a,b)
});

emitter.emit('event','参数1','参数2');

执行结果如下：

可见，同一个时间绑定的监听器从上往下依次被执行。

EventEmitter的方法、类方法及其事件

EventEmitter的方法

方法	描述
addListener(event, listener)	为指定事件添加一个监听器到监听器数组的尾部。
on(event, listener)	为指定事件注册一个监听器，接受一个字符串 event 和一个回调函数。
once(event, listener)	为指定事件注册一个单次监听器，即 监听器最多只会触发一次，触发后立刻解除该监听器。
removeListener(event, listener)	移除指定事件的某个监听器，监听器必须是该事件已经注册过的监听器。(它接受两个参数，第一个是事件名称，第二个是回调函数名称)
removeAllListeners([event])	移除所有事件的所有监听器， 如果指定事件，则移除指定事件的所有监听器
setMaxListeners(n)	默认情况下， EventEmitters 如果你添加的监听器超过 10 个就会输出警告信息。 setMaxListeners 函数用于改变监听器的默认限制的数量
listeners(event)	返回指定事件的监听器数组
emit(event, [arg1], [arg2], […])	按监听器的顺序执行执行每个监听器，如果事件有注册监听返回 true，否则返回 false

EventEmitter的类方法

类方法只有一个：

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

EventEmitter的事件

事件	参数	描述
newListener	event - 字符串，事件名称 ；listener - 处理事件函数	该事件在添加新监听器时被触发。
removeListener	event - 字符串，事件名称 ；listener - 处理事件函数	从指定监听器数组中删除一个监听器。需要注意的是，此操作将会改变处于被删监听器之后的那些监听器的索引。

强大的实例

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

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

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

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

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

//获取监听'connection'事件的监听器的个数
let 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("程序执行完毕。");

运行结果如下：

好像还蛮好理解的，这里就不多做解释了。

error事件

EventEmitter 定义了一个特殊的事件 error，它包含了错误的语义，我们在遇到 异常的时候通常会触发 error 事件。

当 error 被触发时，EventEmitter 规定如果没有响 应的监听器，Node.js 会把它当作异常，退出程序并输出错误信息。

我们一般要为会触发 error 事件的对象设置监听器，避免遇到错误后整个程序崩溃。例如：

const events = require('events'); 
const emitter = new events.EventEmitter(); 
emitter.emit('error'); 

结果显示如下：

EventEmitter的继承

大多数时候我们不会直接使用 EventEmitter，而是在对象中继承它。包括 fs、net、 http 在内的，只要是支持事件响应的核心模块都是 EventEmitter 的子类。

这么做的原因主要有两点：

• 首先，具有某个实体功能的对象实现事件符合语义， 事件的监听和发生应该是一个对象的方法。
• 其次 JavaScript 的对象机制是基于原型的，支持 部分多重继承，继承 EventEmitter 不会打乱对象原有的继承关系。