Node.js / 系统课时

使用 EventEmitter

使用 EventEmitter

EventEmitter 适合在同一进程内发布和订阅离散事件。本课用一个可直接运行的例子完成监听、触发、一次性监听与移除,并说明监听器执行顺序、emit() 返回值和 error 事件这几个最容易踩坑的边界。

学习目标

  • 使用 on()、once()、emit() 和 off() 完成事件的完整生命周期。
  • 根据监听器执行顺序与 emit() 返回值验证事件是否被消费。
  • 避免把同步事件机制误当成异步任务队列。

注册、触发与移除监听器

Node.js 的 node:events 模块导出 EventEmitter。on(eventName, listener) 注册持续监听器,once() 只执行一次,off() 按函数引用移除监听器。监听器默认按注册顺序同步执行,因此下面的输出顺序是确定的。

js
import { EventEmitter } from 'node:events';

const bus = new EventEmitter();

function onData(value) {
  console.log(`on:${value}`);
}

bus.on('data', onData);
bus.once('data', (value) => {
  console.log(`once:${value}`);
});

console.log('emit#1:', bus.emit('data', 10));
console.log('emit#2:', bus.emit('data', 20));

// off() 必须拿到注册时的同一个函数引用。
bus.off('data', onData);
console.log('emit#3:', bus.emit('data', 30));

预期输出:

text
on:10
once:10
emit#1: true
on:20
emit#2: true
emit#3: false

emit() 返回 true 表示触发时至少存在一个监听器,返回 false 表示没有监听器处理该事件。它不会返回监听器自己的返回值,所以不能把 emit() 当成函数调用结果收集器。

理解同步执行顺序

一次 emit('data') 会在当前调用栈中依次调用已注册的监听器。若第一个监听器执行 200 ms 的同步计算,第二个监听器也会被阻塞约 200 ms;EventEmitter 本身不会自动并行或排队。

可以用一个简单规则检查代码:如果事件处理器里包含 CPU 密集循环、同步文件 I/O 或长时间阻塞操作,就不要假设“用了事件就异步了”。需要延后执行时,可在监听器内部显式使用 setImmediate()、Promise 或把任务交给工作线程。

一次性监听与批量清理

once() 适合“只关心第一次”的场景,例如连接建立、初始化完成或一次性授权结果。触发后 Node.js 会自动移除该包装监听器,不需要手动 off()。

如果需要查看当前监听器数量,可调用 listenerCount();在测试和排查重复注册时很实用。例如连续初始化同一模块 3 次,却看到 listenerCount('ready') 为 3,通常说明初始化缺少幂等保护。

js
import { EventEmitter } from 'node:events';

const bus = new EventEmitter();
const handler = () => {};

bus.on('ready', handler);
console.log(bus.listenerCount('ready'));

bus.removeAllListeners('ready');
console.log(bus.listenerCount('ready'));

预期输出:

text
1
0

removeAllListeners() 会移除指定事件的全部监听器,适合测试清理或对象销毁阶段;业务代码中应谨慎使用,因为它可能误删其他模块注册的监听器。

处理 error 事件

error 是 EventEmitter 的特殊事件名。如果触发 error 时没有注册任何 error 监听器,Node.js 会把该错误抛出,进程可能因此退出。对会产生运行时错误的事件源,应明确注册错误处理器。

js
import { EventEmitter } from 'node:events';

const bus = new EventEmitter();

bus.on('error', (err) => {
  console.log('handled:', err.message);
});

bus.emit('error', new Error('disk unavailable'));
console.log('still running');

预期输出:

text
handled: disk unavailable
still running

这套 API 最适合“一个对象发生了某件事,零到多个监听者需要立即收到通知”的场景。只要记住监听器同步执行、移除时需要同一函数引用,以及 error 的特殊语义,就能避免多数基础问题。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

使用 EventEmitter

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通