当前位置：首页 > article >正文

nodejs入门教程8：nodejs EventEmitter

article 2024/11/4 23:51:57

一、EventEmitter的基本概念

EventEmitter是Node.js事件驱动编程的核心。它允许你定义自定义事件，并监听这些事件的发生，以此来实现代码的解耦和异步通信。EventEmitter类实现了Node异步事件驱动架构的基本模式——观察者模式。在这种模式中，被观察者（主体）维护着一组其他对象派来（注册）的观察者，有新的对象对主体感兴趣就注册观察者，不感兴趣就取消订阅，主体有更新的话就依次通知观察者们。

二、EventEmitter的使用方法

1. 引入EventEmitter

要使用EventEmitter，首先需要从events模块引入它：

const EventEmitter = require('events');

2. 创建EventEmitter实例

通过实例化EventEmitter类来创建一个EventEmitter对象：

const myEmitter = new EventEmitter();

3. 注册事件监听器

使用on或addListener方法注册事件监听器。这些方法接受两个参数：事件名称和当事件触发时要执行的回调函数。

myEmitter.on('event', () => {
  console.log('事件触发了!');
});

4. 触发事件

使用emit方法触发一个事件。传递给事件处理程序的任何参数都将被传递给监听器。

myEmitter.emit('event'); // 输出: 事件触发了!

三、EventEmitter的常用方法

方法	描述
`on(eventName, listener)` 或 `addListener(eventName, listener)`	为指定事件注册一个监听器。
`once(eventName, listener)`	为指定事件注册一个单次监听器，即监听器最多只会触发一次，触发后立刻解除该监听器。
`removeListener(eventName, listener)` 或 `off(eventName, listener)`	移除指定事件的某个监听器。
`removeAllListeners([eventName])`	移除所有事件的所有监听器，如果指定事件，则移除指定事件的所有监听器。
`setMaxListeners(n)`	默认情况下，EventEmitter如果添加的监听器超过10个就会输出警告信息。此方法用于提高监听器的默认限制的数量。
`listenerCount(emitter, eventName)`	返回指定事件的监听器数量。这是一个静态方法。
`emit(eventName, [arg1], [arg2], [...])`	触发指定事件，并传递任意数量的参数给监听器。

四、EventEmitter的实例属性

events：一个对象，存储了所有事件及其对应的监听器数组。

五、EventEmitter的实例方法

prependListener(eventName, listener)：将监听器添加到指定事件监听器数组的开头。
prependOnceListener(eventName, listener)：将一次性监听器添加到指定事件监听器数组的开头。
listeners(eventName)：返回指定事件的监听器数组副本。
rawListeners(eventName)：返回指定事件的监听器数组。

六、EventEmitter的注意事项

内存泄漏：忘记移除不再使用的监听器可能导致内存泄漏。使用once或在适当的时候调用removeListener可以避免这个问题。
错误处理：EventEmitter实例发生错误时，会触发名为error的特殊事件。为防止Node.js程序崩溃，建议始终为error事件注册监听器。

七、EventEmitter的示例代码

以下是一个使用EventEmitter实现简单的消息发布/订阅模式的示例：

const EventEmitter = require('events');

class PubSub extends EventEmitter {}

const pubsub = new PubSub();

// 订阅 'message' 事件
pubsub.on('message', (data) => {
  console.log(`接收到消息: ${data}`);
});

// 发布一条消息
setTimeout(() => {
  pubsub.emit('message', 'Hello, this is a message!');
}, 2000);

console.log('等待消息...');