Nodejs Nestjs事件发射器event-emitter的使用

NestJS 提供了强大的依赖注入系统和模块化架构，它还集成了 @nestjs/event-emitter 模块，使得事件驱动编程变得更加容易。以下是如何在 NestJS 应用中使用事件发射器的基本步骤。

1. 安装必要的包

首先，你需要安装 @nestjs/event-emitter 包：

npm install @nestjs/event-emitter

如果你还没有使用 rxjs（默认情况下 NestJS 已经包含了这个库），你也可能需要手动安装它：

npm install rxjs

2. 创建事件和事件处理器

定义一个事件名称，并创建相应的事件处理器。

事件接口

// src/events/interfaces/my-event.interface.ts
export interface MyEvent {
  message: string;
}

事件处理器

// src/events/event.handler.ts
import { Injectable } from '@nestjs/common';
import { OnEvent } from '@nestjs/event-emitter';

@Injectable()
export class MyEventHandler {
  @OnEvent('my.event')
  handle(event: MyEvent) {
    console.log('Event received:', event.message);
  }
}

3. 在服务中触发事件

在你的服务中，你可以通过注入 EventEmitter2 来触发事件。

// src/app.service.ts
import { Injectable, OnModuleInit } from '@nestjs/common';
import { EventEmitter2 } from '@nestjs/event-emitter';

@Injectable()
export class AppService implements OnModuleInit {
  constructor(private readonly eventEmitter: EventEmitter2) {}

  onModuleInit() {
    // 你也可以在这里注册事件监听器
  }

  triggerMyEvent(message: string) {
    this.eventEmitter.emit('my.event', { message });
  }
}

4. 配置模块

确保在你的模块中启用事件发射器。

// src/app.module.ts
import { Module } from '@nestjs/common';
import { EventEmitterModule } from '@nestjs/event-emitter';
import { AppService } from './app.service';
import { MyEventHandler } from './events/event.handler';

@Module({
  imports: [EventEmitterModule.forRoot()],
  providers: [AppService, MyEventHandler],
})
export class AppModule {}

5. 使用事件

最后，在控制器或其他服务中调用 triggerMyEvent 方法来触发事件。

// src/app.controller.ts
import { Controller, Get } from '@nestjs/common';
import { AppService } from './app.service';

@Controller()
export class AppController {
  constructor(private readonly appService: AppService) {}

  @Get()
  async triggerEvent() {
    this.appService.triggerMyEvent('Hello, World!');
    return { message: 'Event triggered' };
  }
}

以上就是如何在 NestJS 中使用事件发射器的基本示例。这种模式非常适合解耦应用程序的不同部分，特别是在处理异步操作或多个组件需要响应相同事件时。