如何实现一个类型安全的Event Emitter？-js教程-PHP中文网

如何实现一个类型安全的Event Emitter？

夜晨

发布： 2025-09-26 12:52:02

原创

766人浏览过

答案是使用泛型和索引类型实现类型安全的 Event Emitter。通过定义 Events 接口明确事件名与参数类型，结合 TypedEmitter 泛型类约束 on、emit 方法的事件名和参数类型，确保编译时检查正确性，避免拼写错误或参数不匹配问题，提升代码健壮性。

如何实现一个类型安全的event emitter？

实现一个类型安全的 Event Emitter，核心是让事件名称和对应的回调函数参数类型在编译时就能被正确约束。使用 TypeScript 可以通过泛型和索引类型来做到这一点，避免运行时因拼错事件名或传错参数导致的问题。

定义事件类型映射

先为所有可能触发的事件建立一个接口，键是事件名，值是该事件回调函数的参数类型数组。

例如：

interface Events {
  add: [number, number];
  error: [Error];
  message: [string, Date];
}

登录后复制

这样，监听 add 事件的回调必须接收两个 number 类型参数，而 error 事件只接受一个 Error 对象。

实现类型安全的 Emitter 类

使用泛型约束事件名必须是 Events 的 key，并确保 on、emit 等方法的参数与事件定义匹配。

class TypedEmitter<EventsMap> {
  private events = new Map<keyof EventsMap, Array<Function>>();

  on<K extends keyof EventsMap>(event: K, listener: (...args: EventsMap[K]) => void) {
    const listeners = this.events.get(event) || [];
    listeners.push(listener);
    this.events.set(event, listeners);
  }

  emit<K extends keyof EventsMap>(event: K, ...args: EventsMap[K]) {
    const listeners = this.events.get(event);
    if (listeners) {
      listeners.forEach(fn => fn(...args));
    }
  }

  off<K extends keyof EventsMap>(event: K, listener: (...args: EventsMap[K]) => void) {
    const listeners = this.events.get(event);
    if (listeners) {
      const index = listeners.indexOf(listener);
      if (index > -1) {
        listeners.splice(index, 1);
      }
    }
  }
}

登录后复制

这个类的关键在于用 EventsMap[K] 获取对应事件的参数类型元组，从而让 TypeScript 校验传参是否正确。

一键职达

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

查看详情

使用示例

将具体事件类型传入泛型，即可获得完整的类型提示和错误检查。

const emitter = new TypedEmitter<Events>();

emitter.on('add', (a, b) => {
  console.log(a + b); // 正确：a 和 b 是 number
});

emitter.emit('add', 1, 2); // ✅ 类型安全

// emitter.emit('add', '1', '2'); // ❌ 编译报错：类型不匹配

emitter.on('error', (err) => {
  console.error(err.message);
});

emitter.emit('error', new Error('Boom!')); // ✅ 正确

登录后复制

如果尝试监听一个不存在的事件名，TypeScript 也会立即报错。

基本上就这些。通过定义事件结构和合理使用泛型约束，就能在开发阶段捕获大多数事件相关的类型错误，提升代码健壮性。

以上就是如何实现一个类型安全的Event Emitter？的详细内容，更多请关注php中文网其它相关文章！