TypeScript实现类型安全的EventEmitter

下面是 TypeScript 实现类型安全的 EventEmitter 的完整攻略。

什么是 TypeScript EventEmitter？

EventEmitter 是 Node.js 中常用的一个模块，用于实现事件机制。可以通过绑定事件来监听对象或函数的状态变化，从而实现异步回调。

TypeScript 在 EventEmitter 的基础上实现了类型安全，能够避免一些类型错误，让代码更加健壮。

实现方式

通过 TypeScript 的泛型特性，我们可以在定义 EventEmitter 类时规定事件名和事件数据的类型，从而实现类型安全。下面是一个示例：

interface Events {
  [eventName: string]: any
}

type Listener<T> = (arg: T) => void

class TypedEventEmitter<Events> {
  private map = new Map<keyof Events, Listener<Events[keyof Events]>[]>()

  on<K extends keyof Events>(eventName: K, listener: Listener<Events[K]>) {
    const listeners = this.map.get(eventName) || []
    listeners.push(listener as Listener<Events[K]>)
    this.map.set(eventName, listeners)
  }

  emit<K extends keyof Events>(eventName: K, arg: Events[K]) {
    const listeners = this.map.get(eventName) || []
    listeners.forEach(listener => listener(arg))
  }
}

这里我们定义了一个泛型类 TypedEventEmitter，Events 类型定义了事件名和事件数据类型的键值对。Listener 是事件回调函数的类型，它接收一个参数为泛型类型 T，返回值为空。

在 TypedEventEmitter 类中，我们使用了 Map 来保存事件名与事件回调函数的数组之间的映射关系。在 on 方法中，我们向数组中添加回调函数，并根据事件名将它们存放到 map 中。在 emit 方法中，我们根据事件名获取所有回调函数并依次执行。

示例

下面是一个使用 TypedEventEmitter 实现服务端 WebSocket 的示例：

interface WSEvents {
  close: void
  message: string
}

class WebSocketServer {
  private emitter = new TypedEventEmitter<WSEvents>()
  private server: WebSocket.Server

  constructor(port: number) {
    this.server = new WebSocket.Server({ port })
    this.server.on('connection', socket => {
      socket.on('close', () => this.emitter.emit('close', undefined))
      socket.on('message', data => this.emitter.emit('message', data))
    })
  }

  on<K extends keyof WSEvents>(eventName: K, listener: Listener<WSEvents[K]>) {
    this.emitter.on(eventName, listener)
  }
}

这里我们定义了一个 WebSocketServer 类来封装 socket 实例。使用 TypedEventEmitter 来发送和处理消息。在 on 方法中，我们可以很方便地指定需要监听的事件名和对应的回调，避免了类型错误的风险，代码更加清晰易懂。

总结

在 TypeScript 中实现类型安全的 EventEmitter，除了增强了代码可维护性和可读性之外，还让我们不必担心类型推断错误，提升了代码的可靠性。现在，你已经学会了如何使用 TypeScript 的泛型和类来实现 EventEmitter，可以在你的开发中尝试使用。