NestJS 中使用服务器端事件进行批量操作的轻松通知

使用 NestJS 中的服务器端事件 (SSE) 批量发送通知

该解决方案演示了使用 NestJS 与 Prisma 和服务器端事件 (SSE) 进行批量操作的后端方法。它包括事件驱动的架构和排队系统。

// Backend: AllocateVoucherController
import { Controller, Post, Body, Sse, OnEvent } from '@nestjs/common';
import { AllocateVoucherService } from './allocate-voucher.service';
import { EventEmitter2 } from '@nestjs/event-emitter';
import { Observable } from 'rxjs';
import { map, fromEvent } from 'rxjs';
@Controller('allocate-voucher')
export class AllocateVoucherController {
  constructor(
    private readonly allocateVoucherService: AllocateVoucherService,
    private readonly eventEmitter: EventEmitter2
  ) {}
  @Post()
  async create(@Body() createDto: any) {
    const result = await this.allocateVoucherService.create(createDto);
    return result;
  }
  @Sse('vouchered-employee')
  updatedEmployeeEvent(): Observable<MessageEvent> {
    return fromEvent(this.eventEmitter, 'after-added-voucher').pipe(
      map((data) => new MessageEvent('after-added-voucher', { data })),
    );
  }
}

使用 NestJS 和 React 进行批量插入的实时更新

此前端示例使用 React 来侦听服务器端事件并在收到数据时动态更新 UI。它确保员工在批量插入后实时收到通知。

// Frontend: React Component for SSE
import React, { useEffect, useState } from 'react';
const EmployeeUpdates = () => {
  const [employees, setEmployees] = useState([]);
  useEffect(() => {
    const eventSource = new EventSource('http://localhost:3000/allocate-voucher/vouchered-employee');
    eventSource.onmessage = (event) => {
      const newEmployee = JSON.parse(event.data);
      setEmployees((prev) => [...prev, newEmployee]);
    };
    return () => eventSource.close();
  }, []);
  return (
    <table>
      <thead>
        <tr><th>Name</th><th>Voucher</th></tr>
      </thead>
      <tbody>
        {employees.map((emp) => (
          <tr key={emp.id}><td>{emp.name}</td><td>{emp.voucher}</td></tr>
        ))}
      </tbody>
    </table>
  );
};
export default EmployeeUpdates;

批量插入操作的单元测试通知

此 Jest 测试确保事件发射和通知机制在 NestJS 中服务器端事件的后端正常工作。

// Jest Test: AllocateVoucherService
import { Test, TestingModule } from '@nestjs/testing';
import { AllocateVoucherService } from './allocate-voucher.service';
import { EventEmitter2 } from '@nestjs/event-emitter';
describe('AllocateVoucherService', () => {
  let service: AllocateVoucherService;
  let eventEmitter: EventEmitter2;
  beforeEach(async () => {
    const module: TestingModule = await Test.createTestingModule({
      providers: [AllocateVoucherService, EventEmitter2],
    }).compile();
    service = module.get(AllocateVoucherService);
    eventEmitter = module.get(EventEmitter2);
  });
  it('should emit after-allocate-voucher event', async () => {
    jest.spyOn(eventEmitter, 'emit');
    const result = await service.create({ someData: 'test' });
    expect(eventEmitter.emit).toHaveBeenCalledWith('after-allocate-voucher', result);
  });
});

关于 NestJS 中的 SSE 的常见问题

1. 通过 WebSocket 使用服务器端事件有哪些好处？
2. SSE 实现起来更简单，并且使用 HTTP，因此对防火墙友好。与 WebSocket 不同，它只需要单个单向连接，这对于实时更新非常有效。
3. 我可以使用吗 @Sse 控制器中有多个端点？
4. 是的，您可以定义多个 @Sse 同一控制器中的端点可根据特定需求向客户端提供不同的数据流。
5. 如何处理队列处理过程中的错误？
6. 使用 BullMQ，您可以定义重试选项并使用事件侦听器，例如 @OnWorkerEvent('failed') 记录错误并在必要时重新处理作业。
7. Prisma 有吗 createMany 方法支持事务回滚吗？
8. 是的，棱镜的 createMany 可以封装在交易中。如果事务中的任何操作失败，则回滚所有操作以保持一致性。
9. 如果客户端在 SSE 流期间断开连接会发生什么？
10. 一旦检测到断开连接，服务器就会停止发送更新。您可以使用以下方法在客户端上实现重新连接逻辑 EventSource API。
11. SSE可以用于双向通信吗？
12. 不，SSE 是单向的（服务器到客户端）。对于双向通信，请使用 WebSocket 或 HTTP2 流。
13. 如何保护 NestJS 中的 SSE 端点？
14. 使用警卫或中间件，例如 @UseGuards，对您的 SSE 端点实施身份验证和授权。
15. SSE 可以与非浏览器客户端一起使用吗？
16. 是的，任何支持 HTTP 和事件流的客户端（例如 Node.js、cURL）都可以使用 SSE 流。
17. 可以连接到 SSE 端点的最大客户端数量是多少？
18. 这取决于您的服务器的配置和资源限制。负载平衡和集群可以帮助扩展以支持更多客户端。
19. 是否可以通过 SSE 发送 JSON 数据？
20. 是的，您可以将对象序列化为 JSON 字符串并使用 new MessageEvent 在 NestJS 中。

NestJS 中有效的实时通知

使用实现实时系统 上证所 NestJS 简化了服务器和客户端之间的通信。与持续轮询相比，此方法减少了服务器负载，并实现了通知的精确定位。例如，HR 工具可以向销售部门的 200 名员工通知新优惠券，而不会干扰其他人。 🎯

借助 BullMQ 和 Prisma 等工具，此设置可确保异步任务处理和高效的数据库操作。基于事件的架构的灵活性使其成为满足各种实时要求的可扩展解决方案，从而增强用户参与度和系统可靠性。