logologo
文档仓库
文档仓库
logologo
开始

概述

第一步
控制器
提供者
模块
中间件
异常过滤器
管道
守卫
拦截器
自定义装饰器

基础

自定义提供程序
异步提供者
动态模块
注入作用域
循环依赖
模块引用
懒加载模块
执行上下文
生命周期事件
发现服务
平台无关
单元测试

技术

配置
SQL
Mongo
验证
缓存
序列化
版本控制
任务调度
队列
日志
Cookies
事件
压缩
文件上传
文件流
HTTP 模块
Session
MVC
性能(Fastify)
SSE

安全

认证
授权
加密与哈希
Helmet
CORS
CSRF
速率限制

GraphQL

快速开始
解析器
变更
订阅
标量
指令
接口
联合与枚举
字段中间件
类型映射
插件
复杂度
扩展
CLI 插件
生成SDL
共享模型
其他功能
联邦

WebSocket

网关
异常过滤器
管道
守卫
拦截器
适配器

微服务

基础
Redis
MQTT
NATS
RabbitMQ
Kafka
gRPC
自定义传输
异常过滤器
管道
守卫
拦截器
部署
独立应用程序

CLI

概述
工作区
库
用法
脚本

OpenAPI

介绍
装饰器
类型映射
操作
其他特性
安全
类型与参数
CLI 插件

实用示例

REPL
CRUD生成器
SWC
Passport(认证)
热重载
MikroORM
TypeORM
Mongoose
Sequelize
路由模块
Swagger
健康检查
CQRS
Compodoc
Prisma
Sentry
静态资源
Commander
异步本地存储
Necord
套件(原Automock)

常见问题

Serverless
HTTP 适配器
长连接
全局前缀
原始请求体
混合应用
HTTPS & 多服务器
请求生命周期
错误

开发工具

概述
CI/CD
迁移指南
API参考(官方)

生态与案例

谁在用
精彩资源

支持

支持

社区

贡献者

最后更新于: 2025/11/18 02:11:37

上一页性能(Fastify)
下一页认证

#服务器发送事件

服务器发送事件(SSE)是一种服务器推送技术,允许客户端通过 HTTP 连接自动接收来自服务器的更新。每条通知都以由一对换行符终止的文本块形式发送(了解更多此处 )。

#使用方法

要在路由上启用服务器发送事件(路由注册在控制器类中),请使用 @Sse() 装饰器标注方法处理器。

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

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

警告

Server-Sent Events 路由必须返回一个 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 服务器建立持久连接,服务器以 text/event-stream 格式发送事件。该连接将保持打开状态,直到调用 EventSource.close() 方法关闭为止。

连接建立后,来自服务器的传入消息会以事件形式传递到你的代码中。如果传入消息包含事件字段,则触发的事件与该字段值相同。若未包含事件字段,则会触发通用的 message 事件( 来源 )。

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

#示例

一个可用的示例在此处查看。