服务器发送事件

服务器发送事件（SSE）是一种服务器推送技术，使客户端能够通过 HTTP 连接从服务器接收自动更新。每个通知作为一个以一对换行符终止的文本块发送（了解更多请参阅这里）。

用法

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

typescript

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

提示

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

警告

服务器发送事件路由必须返回一个 Observable 流。

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

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

typescript

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

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

EventSource 实例会打开一个到 HTTP 服务器的持久连接，服务器以 text/event-stream 格式发送事件。连接保持打开状态，直到调用 EventSource.close() 关闭。

一旦连接打开，来自服务器的传入消息将以事件的形式传递给你的代码。如果传入消息中有事件字段，触发的事件与事件字段值相同。如果没有事件字段，则触发通用的 message 事件（来源）。

javascript

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

一个可用的示例在这里。