Nest.js Server-Sent 事件

Server-Sent 事件 (SSE) 是一种服务器推送技术，使客户端能够通过 HTTP 连接从服务器接收自动更新。 每个通知都作为由一对换行符终止的文本块发送。

使用

要在路由（在控制器类中注册的路由）上启用 Server-Sent 事件，请使用 @Sse() 装饰器注解方法处理程序。

@Sse('sse')
sse(): Observable<MessageEvent> {
  return interval(1000).pipe(map((_) => ({ data: { hello: 'world' } })));
}

提示 ：@Sse() 装饰器和 MessageEvent 接口是从 @nestjs/common 导入的，而 Observable、interval 和 map 是从 rxjs 包中导入的。

警告 : Server-Sent 事件路由必须返回一个 Observable 流。

在上面的示例中，我们定义了一个名为 sse 的路由，它将允许我们发送实时更新。 可以使用 EventSource API 监听这些事件。

sse 方法返回一个发出多个 MessageEvent 的 Observable（在此示例中，它每秒发出一个新的 MessageEvent）。 MessageEvent 对象应遵循以下接口以匹配规范：

export interface MessageEvent {
  data: string | object;
  id?: string;
  type?: string;
  retry?: number;
}

有了这个，我们现在可以在我们的客户端应用程序中创建 EventSource 类的实例，将 /sse 路由（它与我们传递给上面的 @Sse() 装饰器的端点匹配）作为构造函数参数传递。

EventSource 实例打开与 HTTP 服务器的持久连接，该服务器以文本/事件流格式发送事件。 连接保持打开状态，直到通过调用 EventSource.close() 关闭。

一旦打开连接，来自服务器的传入消息就会以事件的形式传递给我们的代码。 如果传入消息中有事件字段，则触发的事件与事件字段值相同。 如果不存在事件字段，则触发通用消息事件。

const eventSource = new EventSource('/sse');
eventSource.onmessage = ({ data }) => {
  console.log('New message', JSON.parse(data));
};