NestJS 强类型事件发射器(NestEmitter)使用指南-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00536/article/details/141779711

NestJS 强类型事件发射器(NestEmitter)使用指南

nest-emitterStrongly 💪🏼 Typed Eventemitter Module For Nestjs Framework 🦁项目地址:https://gitcode.com/gh_mirrors/ne/nest-emitter

1. 项目介绍

NestEmitter 是一个专为 Nest.js 框架设计的强类型事件发射器模块。它解决了在使用事件驱动架构时常见的问题——如事件名称的拼写错误，通过提供一个简单的接口来映射事件名及其对应的负载类型，从而实现了对 EventEmitter API 的更严格版本。该库兼容任何实现了 Node.js 事件机制的 EventEmitter，确保了开发者能够以类型安全的方式处理应用程序内部的事件。

主要特点：

强类型: 通过类型定义提高编码时的准确性。
灵活性: 可与任何符合 Node.js 事件接口的发射器配合使用。
易于集成: 简化与 Nest.js 应用程序的集成过程。

2. 项目快速启动

安装

首先，确保你的开发环境已配置 TypeScript 3.0 或以上版本。然后，在你的 Nest.js 项目中安装 nest-emitter 包。

npm install nest-emitter
# 或者，如果你使用 Yarn
yarn add nest-emitter

集成 NestEmitterModule

在你的主模块（通常是 AppModule）中引入并配置 NestEmitterModule，指定使用的事件发射器实例。

import { Module } from '@nestjs/common';
import { NestEmitterModule } from 'nest-emitter';
import { EventEmitter } from 'events';

@Module({
  imports: [
    NestEmitterModule.forRoot(new EventEmitter()),
  ],
  controllers: [/* ... */],
  providers: [/* ... */],
})
export class AppModule {}

定义事件

创建事件接口来定义事件名称及相应的数据类型。

// app.events.ts
export interface AppEvents {
  notification: string;
  newRequest: (req: Request) => void; // 假设 Request 是从 express 导入的或自定义的类型
}

3. 应用案例和最佳实践

示例：发送通知事件

在服务中，你可以注入 NestEmitter 来触发事件。

import { Injectable, Inject } from '@nestjs/common';
import { NestEmitter } from 'nest-emitter';

@Injectable()
export class NotificationService {
  constructor(@Inject('NestEmitter') private readonly emitter: NestEmitter) {}

  sendMessage(message: string): void {
    this.emitter.emit('notification', message);
  }
}

在控制器或其它服务中监听此事件。

import { Controller, Get } from '@nestjs/common';
import { OnEvent } from '@nestjs/event-pattern';
import { NotificationService } from './notification.service';
import { AppEvents } from './app.events';

@Controller()
export class AppController {
  constructor(private readonly notificationService: NotificationService) {}

  @OnEvent(AppEvents.notification)
  handleNotification(message: string) {
    console.log(`Received notification: ${message}`);
  }

  @Get()
  triggerNotification() {
    this.notificationService.sendMessage('Hello, World!');
  }
}