如何实现一个符合ECMAScript规范的EventEmitter类？-js教程-PHP中文网

如何实现一个符合ECMAScript规范的EventEmitter类？

狼影

发布： 2025-09-26 13:39:01

原创

583人浏览过

答案是实现一个轻量且符合 Node.js 规范的 EventEmitter 类，核心包括：使用 _events 存储事件映射；提供 on/addListener 注册监听器；emit 按序触发并处理异常；off/removeListener 移除指定监听器；once 实现一次性监听；支持 removeAllListeners、eventNames、listenerCount 等扩展方法，确保链式调用与类型安全，避免内存泄漏。

如何实现一个符合ecmascript规范的eventemitter类？

要实现一个符合 ECMAScript 规范、轻量且功能完整的 EventEmitter 类，核心是管理事件监听器的注册、触发和移除。虽然 ECMAScript 标准本身不包含 EventEmitter，但 Node.js 的 EventEmitter 模式已成为事实标准。我们可以依据其行为来实现一个兼容的版本。

1. 基本结构与事件存储

使用一个对象或 Map 来存储事件名到回调函数数组的映射。每个事件可以有多个监听器。

class EventEmitter {
  constructor() {
    this._events = Object.create(null); // 避免原型污染
  }
}

2. 实现 on 和 addListener（别名）

将监听器添加到指定事件的回调列表中。支持重复添加相同监听器。

说明： on 与 addListener 是同一个方法的不同名称，应指向同一函数。

on(event, listener) {
  if (typeof listener !== 'function') {
    throw new TypeError('The listener must be a function');
  }

  if (!this._events[event]) {
    this._events[event] = [];
  }

  this._events[event].push(listener);
  return this; // 支持链式调用
}

addListener(event, listener) {
  return this.on(event, listener);
}

3. 实现 emit：触发事件

按顺序执行指定事件的所有监听器，并传入参数。注意处理监听器执行期间可能抛出的错误。

一键职达

AI全自动批量代投简历软件，自动浏览招聘网站从海量职位中用AI匹配职位并完成投递的全自动操作，真正实现'一键职达'的便捷体验。

查看详情

emit(event, ...args) {
  if (!this._events[event] || this._events[event].length === 0) {
    return false; // 无监听器返回 false
  }

  // 创建副本防止遍历中修改数组导致问题
  const listeners = this._events[event].slice();
  for (const listener of listeners) {
    listener.apply(this, args);
  }

  return true;
}

4. 实现 off 和 removeListener

从事件队列中移除指定监听器。注意只移除第一个匹配项。

off(event, listener) {
  if (typeof listener !== 'function') {
    throw new TypeError('The listener must be a function');
  }

  const listeners = this._events[event];
  if (!listeners) return this;

  const index = listeners.indexOf(listener);
  if (index > -1) {
    listeners.splice(index, 1);
    // 清理空数组
    if (listeners.length === 0) {
      delete this._events[event];
    }
  }

  return this;
}

removeListener(event, listener) {
  return this.off(event, listener);
}

5. 支持 once：一次性监听器

监听器执行一次后自动移除。关键在于包装原始监听器。

once(event, listener) {
  const wrapped = (...args) => {
    this.off(event, wrapped);
    listener.apply(this, args);
  };
  // 存储原始引用，便于 off 移除
  wrapped.listener = listener;

  this.on(event, wrapped);
  return this;
}

6. 其他常用方法（可选增强）

removeAllListeners(event?)：清除某个或所有事件的监听器
eventNames()：返回当前所有注册的事件名
listenerCount(event)：返回某事件的监听器数量
rawListeners(event)：返回某事件的监听器数组（含 once 包装）

removeAllListeners(event) {
  if (event) {
    delete this._events[event];
  } else {
    this._events = Object.create(null);
  }
  return this;
}

eventNames() {
  return Object.keys(this._events);
}

listenerCount(event) {
  return this._events[event] ? this._events[event].length : 0;
}

基本上就这些。这个实现覆盖了 EventEmitter 的核心行为，符合 Node.js 的 API 设计，同时保持代码简洁、类型安全，并避免常见陷阱如异步执行、监听器泄漏等。实际项目中可根据需要扩展更多功能，比如最大监听器警告（setMaxListeners）。

以上就是如何实现一个符合ECMAScript规范的EventEmitter类？的详细内容，更多请关注php中文网其它相关文章！