Node.js中的EventEmitter类使用小结_Node.js

1.eventemitter类说明

eventemitter 是 node.js 中的一个核心模块，它提供了一种实现事件驱动编程的机制。它是一个基于观察者模式的类，用于在应用程序中处理事件和触发事件。
node.js 所有的异步 i/o 操作在完成时都会发送一个事件到事件队列。
node.js 里面的许多对象都会分发事件：一个 net.server 对象会在每次有新连接时触发一个事件，一个 fs.readstream 对象会在文件被打开的时候触发一个事件。所有这些产生事件的对象都是 events.eventemitter 的实例。

2.eventemitter类使用

2.1事件注册和触发

通过 on 方法可以注册事件监听器，监听特定的事件。当事件触发时，所有注册的监听器将按照顺序执行。例如：

const eventemitter = require('events');
const myemitter = new eventemitter();
myemitter.on('event', () => {
  console.log('event occurred');
});
myemitter.emit('event'); // 执行事件并触发监听器

当 event 事件触发时，eventemitter 将调用相应的监听器函数，并输出 'event occurred'。

2.2一次性事件监听器

使用 once 方法可以注册一次性事件监听器，它只会在当前事件触发的第一次执行。例如：

const eventemitter = require('events');
const myemitter = new eventemitter();
myemitter.once('event', () => {
  console.log('event occurred once');
});
myemitter.emit('event'); // 执行事件并触发监听器
myemitter.emit('event'); // 不再触发监听器

在上述示例中，once 方法注册的监听器只会在第一次触发事件时执行。第二次触发事件时，不会调用该监听器。

2.3传递参数

可以在事件触发时向监听器传递参数。例如：

const eventemitter = require('events');
const myemitter = new eventemitter();
myemitter.on('event', (arg1, arg2) => {
  console.log(`received ${arg1} and ${arg2}`);
});
myemitter.emit('event', 'hello', 'world'); // 执行事件并触发监听器，并传递参数

在上述示例中，emit 方法触发了 event 事件，并将 'hello' 和 'world' 作为参数传递给监听器函数。

2.4错误处理

eventemitter 具有内置的错误处理机制。可以通过监听 'error' 事件来处理错误。如果没有针对 'error' 事件注册监听器，将会输出一个未处理的错误堆栈。例如：

const eventemitter = require('events');
const myemitter = new eventemitter();
myemitter.on('error', (error) => {
  console.error('error occurred:', error);
});
myemitter.emit('error', new error('something went wrong')); // 触发 'error' 事件并传递错误对象

在上述示例中，当 'error' 事件触发时，注册的监听器将打印出错误信息。

eventemitter 类还具有其他方法，如 removelistener、removealllisteners 等，用于添加、删除或清除事件监听器。通过使用 eventemitter，可以轻松实现事件驱动的编程范式，以构建灵活、可扩展的应用程序。

3.eventemitter类方法说明

3.1 方法

addlistener(event, listener)：为指定事件添加一个监听器到监听器数组的尾部。
on(event, listener)：为指定事件注册一个监听器，接受一个字符串 event 和一个回调函数。

server.on('connection', function (stream) {
  console.log('someone connected!');
});

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

server.once('connection', function (stream) {
  console.log('ah, we have our first user!');
});

removelistener(event, listener)：移除指定事件的某个监听器，监听器必须是该事件已经注册过的监听器。它接受两个参数，第一个是事件名称，第二个是回调函数名称。

var callback = function(stream) {
  console.log('someone connected!');
};
server.on('connection', callback);
// ...
server.removelistener('connection', callback);

removealllisteners([event])：移除所有事件的所有监听器，如果指定事件，则移除指定事件的所有监听器。
setmaxlisteners(n)：默认情况下， eventemitters 如果你添加的监听器超过 10 个就会输出警告信息。 setmaxlisteners 函数用于改变监听器的默认限制的数量。
listeners(event)：返回指定事件的监听器数组。
emit(event, [arg1], [arg2], […])：按监听器的顺序执行执行每个监听器，如果事件有注册监听返回 true，否则返回 false。

3.2类方法

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

events.eventemitter.listenercount(emitter, eventname) //已废弃，不推荐
events.emitter.listenercount(eventname) //推荐

3.3 事件

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

3.4 eventemitter子类

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

为什么要这样做呢？原因有两点：

首先，具有某个实体功能的对象实现事件符合语义，事件的监听和发生应该是一个对象的方法。

其次 javascript 的对象机制是基于原型的，支持部分多重继承，继承 eventemitter 不会打乱对象原有的继承关系。

4.举例说明

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("程序执行完毕。");

终端执行结果：