Node.js EventEmitter

在 Node.js 中，EventEmitter 是 events 模块中的一个核心类，它允许对象发出（emit）和监听（listen to）自定义事件。这种基于事件的编程模型使得代码更加模块化和可维护。本文将介绍如何使用 EventEmitter 来创建和管理事件。

1. 引入 events 模块

首先，你需要引入 Node.js 的 events 模块，以便使用 EventEmitter 类。

const EventEmitter = require('events');

或者使用 ES6 模块语法（在 node.js 12+ 中可用）：

import EventEmitter from 'events';

2. 创建 EventEmitter 实例

你可以通过创建一个 EventEmitter 的实例来开始使用它。

const myEmitter = new EventEmitter();

3. 监听事件

使用 on 方法可以为特定事件添加一个监听器。当事件被触发时，这个监听器会被调用。

myEmitter.on('event', () => {
  console.log('an event occurred!');
});

你也可以为监听器传递参数：

myEmitter.on('data', (data) => {
  console.log(`Received data: ${data}`);
});

4. 触发事件

使用 emit 方法可以触发一个事件。所有绑定到该事件的监听器都会被调用。

myEmitter.emit('event'); // 输出: an event occurred!

myEmitter.emit('data', 'Hello, World!'); // 输出: Received data: Hello, World!

5. 一次性监听器

使用 once 方法可以添加一个监听器，该监听器在事件被触发后只会被调用一次，然后自动解除绑定。

myEmitter.once('event', () => {
  console.log('this will be logged only once');
});

myEmitter.emit('event'); // 输出: this will be logged only once
myEmitter.emit('event'); // 不会输出任何内容，因为监听器已经被解除绑定

6. 移除监听器

使用 removeListener 方法可以移除之前添加的监听器。你需要传递监听器函数本身（或者一个引用）来移除它。

const callback = () => {
  console.log('this will not be logged');
};

myEmitter.on('event', callback);
myEmitter.removeListener('event', callback);

myEmitter.emit('event'); // 不会输出任何内容，因为监听器已经被移除

7. 错误处理

你可以监听 error 事件来处理错误。如果 EventEmitter 实例上抛出了未捕获的异常，它也会自动触发 error 事件。

myEmitter.on('error', (err) => {
  console.error('An error occurred:', err);
});

// 触发错误事件
myEmitter.emit('error', new Error('Something went wrong!'));
// 或者抛出一个未捕获的异常
// throw new Error('Uncaught exception!');

8. 继承 EventEmitter

你可以通过继承 EventEmitter 类来创建自己的类，并在其中使用事件。

class MyEmitter extends EventEmitter {}

const myEmitterInstance = new MyEmitter();
myEmitterInstance.on('myEvent', () => {
  console.log('myEvent occurred!');
});

myEmitterInstance.emit('myEvent'); // 输出: myEvent occurred!

总结

EventEmitter 是 Node.js 中一个强大的工具，它允许你创建基于事件的程序。通过监听和触发事件，你可以在不同的部分之间实现松散的耦合，从而提高代码的可维护性和可扩展性。记住，合理使用事件监听器，避免内存泄漏和性能问题，特别是在处理大量事件或长时间运行的应用程序时。

本文地址：https://www.tides.cn/p_node-event-emitter