在构建复杂的应用时,异步处理和解耦成为了关键所在,而发布订阅模式正好可以辅助实现这两点。在这篇文章中,我们将详细介绍在使用 NestJS 进行 Web 开发时,如何利用 @nestjs/event-emitter
包进行发布订阅模式的实现。
发布订阅模式是一种广泛使用的消息传递方式,发布者发布消息,订阅者订阅关注的消息,然后接收这些消息。
发布者和订阅者之间不存在直接联系,它们通过消息队列或者主题进行通讯。这种模式能够确保系统的解耦,异步处理以及消息的广播。
下面是如何在应用中使用?@nestjs/event-emitter
?进行事件发布和订阅。
首先需要安装 @nestjs/event-emitter
包。
npm install @nestjs/event-emitter
在你的应用模块,例如 AppModule
中引入 EventEmitterModule
:
import { Module } from '@nestjs/common';
import { EventEmitterModule } from '@nestjs/event-emitter';
@Module({
imports: [EventEmitterModule.forRoot()],
})
export class AppModule {}
定义一个事件,例如 UserCreatedEvent
:
export class UserCreatedEvent {
constructor(
public readonly userId: number,
public readonly userName: string
) {}
}
在服务中发布事件,例如在 UsersService
中:
import { EventEmitter2 } from '@nestjs/event-emitter';
import { Injectable } from '@nestjs/common';
import { UserCreatedEvent } from './user-created.event';
@Injectable()
export class UsersService {
constructor(private eventEmitter: EventEmitter2) {}
async create(userId: number, userName: string) {
// Some business logic
this.eventEmitter.emit('user.created', new UserCreatedEvent(userId, userName));
}
}
在这个例子中,当用户创建后,我们发布一个 ‘user.created’ 事件。
创建一个订阅者来监听 ‘user.created’ 事件,例如创建一个 UserCreatedListener
:
import { OnEvent } from '@nestjs/event-emitter';
import { Injectable } from '@nestjs/common';
import { UserCreatedEvent } from './user-created.event';
@Injectable()
export class UserCreatedListener {
@OnEvent('user.created')
handleUserCreatedEvent(event: UserCreatedEvent) {
console.log(event.userId, event.userName);
}
}
在这个例子中,当 user.created
事件被触发时,handleUserCreatedEvent
函数会被执行,并打印出事件的参数。确保在 EventEmitterModule.forRoot()
前 UserCreatedListener
已经被导入到模块中。
通过以上步骤,你已经成功在 NestJS 应用中使用 @nestjs/event-emitter
实现了发布订阅的流程,这将帮助你构建灵活的、可扩展的和耦合度低的应用。