EventEmitter

Posted 2020-09-10

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

Node.js里面的许多对象都会分发事件：一个net.Server对象会在每次有新连接时分发一个事件， 一个fs.readStream对象会在文件被打开的时候发出一个事件。 所有这些产生事件的对象都是 events.EventEmitter 的实例。

 

 

 

1、EventEmitter 类
EventEmitter 的核心是事件触发与事件监听器功能的封装。
通过require("events");来访问该模块。

 

 

 

2、EventEmitter属性

 

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。

 

类方法
listenerCount(emitter, event)
返回指定事件的监听器数量（Number类型）。

 

 

 

实例：

var events = require(‘events‘);

var eventEmitter = new events.EventEmitter();

var listener_1 = function(){
    console.log("监听器1执行");
}

var listener_1_1 = function(){
    console.log("监听器1_1执行");
}

var listener_2 = function(){
    console.log("监听器2执行");
}

eventEmitter.addListener(‘event_1‘, listener_1);
eventEmitter.addListener(‘event_1‘, listener_1_1);

eventEmitter.addListener(‘event_2‘, listener_2);

// eventEmitter.on(‘event_1‘, listener_1);
// eventEmitter.on(‘event_2‘, listener_2);


var lisiten_count = require(‘events‘).EventEmitter.listenerCount(eventEmitter, ‘event_1‘);
console.log("event_1事件绑定了：" + lisiten_count + "个监听器");


eventEmitter.emit(‘event_1‘);
eventEmitter.emit(‘event_2‘);


eventEmitter.removeListener(‘event_1‘, listener_1);

console.log("event_1事件绑定了：" +require(‘events‘).EventEmitter.listenerCount(eventEmitter, ‘event_1‘)+ "个监听器");

 

 

 

3、error 事件
EventEmitter定义了一个特殊的事件error，它包含了错误的语义，在遇到异常的时候通常会触发 error事件。
当 error 被触发时，EventEmitter规定如果没有响应的监听器，Node.js会把它当作异常，退出程序并输出错误信息。
我们一般要为会触发 error事件的对象设置监听器，避免遇到错误后整个程序崩溃。例如：

var events = require(‘events‘);

var eventEmitter = new events.EventEmitter();

eventEmitter.emit(‘error‘);　　//直接发射一个error事件会抛出一个错误

 

var events = require(‘events‘);

var eventEmitter = new events.EventEmitter();

var listener_err = function(){
    console.log("error监听器运行");
}

eventEmitter.on(‘error‘, listener_err);
eventEmitter.emit(‘error‘);　　//添加监听器后不再抛出错误，直接调用监听器函数