Node.js EventEmitter 核心用法：on、once、error 事件处理指南

EventEmitter 概述与核心机制

本文详细介绍 Node.js 中 EventEmitter 事件监听器的具体应用方法，旨在为开发者提供实用的参考指南。

在 Node.js 中，所有异步 I/O 操作完成时，都会向事件队列发送一个对应的事件信号。

events 模块仅暴露一个核心对象：events.EventEmitter。EventEmitter 的核心功能即是对事件触发与监听器机制的封装。该模块已内置于 Node.js 环境中，无需通过 require() 进行显式引入。

若 EventEmitter 实例化过程中出现错误，系统将触发 'error' 事件；当新增监听器时，会触发 'newListener' 事件；而当监听器被移除时，则触发 'removeListener' 事件。

事件监听器注册方法

一、on(event, listener)

该方法用于为指定事件注册一个监听器，接收两个参数：表示事件名的字符串 event 以及回调函数 listener。


var myEvent = new events.EventEmitter();
var listener = function() {
  console.log('someEvent emit');
}
myEvent.on('someEvent', listener);
//这里是lambda表达式
setTimeout(() => myEvent.emit('someEvent'), 1000);

EventEmitter 中的每个事件由事件名和若干参数构成，事件名通常为表达特定语义的字符串。针对同一事件，EventEmitter 支持注册多个监听器。当事件触发时，所有注册到该事件的监听器将按顺序依次执行，并将事件参数作为回调函数的参数传递。


var myEvent = new events.EventEmitter();
myEvent.on('someEvent', function(arg1,arg2) { console.log('someEvent 1 emit', arg1, arg2);});
myEvent.on('someEvent', (arg1,arg2) => console.log('someEvent 2 emit', arg1, arg2));
myEvent.emit('someEvent', 'arg1', 'arg2');
/*
输出
someEvent 1 emit arg1 arg2
someEvent 2 emit arg1 arg2
*/

二、once(event, listener)

该方法用于为指定事件注册一个单次监听器。此监听器在触发一次后会自动解除注册，确保后续相同事件不再触发该回调。


var myEvent = new events.EventEmitter();
myEvent.once('someEvent', function () {
  console.log('someEvent emit');
});
myEvent.emit('someEvent');
/*
返回 true
输出 someEvent emit
*/
myEvent.emit('someEvent');
//返回 false

三、removeListener(event, listener)

该方法用于移除指定事件的特定监听器。需注意的是，被移除的监听器必须是之前已注册在该事件上的有效监听器。


var myEvent = new events.EventEmitter();
var listener = () => console.log('someEvent emit');
myEvent.on('someEvent', listener);
myEvent.removeListener('someEvent', listener);
myEvent.emit('someEvent');
//返回 false

四、removeAllListeners([event])

该方法用于移除所有事件的所有监听器。若传入指定事件参数，则仅移除该指定事件下的所有监听器。

监听器管理与限制设置

五、setMaxListeners(n)

默认情况下，若 EventEmitter 添加的监听器数量超过 10 个，系统将输出警告信息。setMaxListeners 函数可用于提高监听器默认限制的数量，以消除警告。

六、listenerCount(emitter, event)

该方法用于返回指定事件当前注册的监听器数量。


var myEvent = new events.EventEmitter();
myEvent.listenerCount();
//输出 0
events.EventEmitter.listenerCount(myEvent);
//输出 0
events.EventEmitter.listenerCount(myEvent, 'someEvent');
//输出 0
myEvent.on('someEvent', () => console.log('someEvent emit'));
myEvent.listenerCount();
//输出 0
events.EventEmitter.listenerCount(myEvent);
//输出 0
events.EventEmitter.listenerCount(myEvent, 'someEvent');
//输出 1

错误处理与最佳实践

七、error 事件

EventEmitter 定义了一个特殊的 'error' 事件，用于处理错误语义。在遇到异常时，通常会触发此事件。当 'error' 事件被触发且未设置响应监听器时，Node.js 会将其视为未捕获异常，导致程序退出并输出错误信息。因此，建议为可能触发 'error' 事件的对象设置监听器，以防止程序因错误而崩溃。


var myEvent = new events.EventEmitter();
myEvent.on('uncaughtException', (err) => {
 console.log('whoops! there was an error');
});
myEvent.emit('error', new Error('whoops!'));
//输出 Error: whoops!
myEvent.on('error', (err) => {
 console.log('whoops! there was an error');
});
myEvent.emit('error', new Error('whoops!'));
//输出 whoops! there was an error

注意

在实际开发中，我们通常不直接使用 EventEmitter，而是在自定义对象中继承它。包括 fs、net、http 在内的众多支持事件响应的核心模块，均为 EventEmitter 的子类。

采用继承方式的原因主要有两点：

1. 具有特定功能的对象实现事件机制更符合语义，事件的监听与发射应作为对象的方法存在。 2. JavaScript 的对象机制基于原型链，支持部分多重继承。继承 EventEmitter 不会破坏对象原有的继承关系。

Events（事件）模块是 Node.js 的核心组件，许多其他模块基于此构建事件架构。由于 Node.js 运行在单线程环境中，同步代码会阻塞执行流，若存在长时间运行的代码，事件循环将被阻塞。因此，编写高效的 Node.js 代码需仔细规划编程风格，并遵循以下简单规则。

避免阻塞——Node.js 是单线程的，若代码发生阻塞，所有其他操作都将停止。
快速返回——操作应当尽快返回结果。若无法快速返回，应将其移至其他进程处理。

希望本文所述内容能对大家的 Node.js 程序设计有所帮助。

Node.js EventEmitter 事件监听器用法详解

EventEmitter 概述与核心机制

事件监听器注册方法

监听器管理与限制设置

错误处理与最佳实践

实用工具推荐