## 服务器端事件发送
服务器端事件发送(`SSE`)是一个服务器推送技术,用来使客户端在`HTTP`连接下自动接收服务器更新消息。每个消息以一个由一对新行符号作为结束的文字块发送(参见[这里](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events))。
### 使用
要在路径中使能服务器端事件发送(路径在控制器类中注册),用`@Sse()`装饰器注释该方法处理程序。
```TypeScript
@Sse('sse')
sse(): Observable<MessageEvent> {
return interval(1000).pipe(map((_) => ({ data: { hello: 'world' } })));
}
```
?> `@Sse()`装饰器从`@nestjs/common`中导入,`Observable, interval, 和 map`从`rxjs`中导入。
!> 服务器端事件发送路径必须返回`Observable`流。
在上述示例中,我们定义了一个命名的`sse`来生成实时更新,这些事件可以通过 [EventSource API](https://developer.mozilla.org/en-US/docs/Web/API/EventSource) 监听。
`sse`方法返回一个`Observable`并发送多个`MessageEvent`(在本例中,它每秒发射一个新的`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`事件(参见[这里](https://developer.mozilla.org/en-US/docs/Web/API/EventSource))。
```TypeScript
const eventSource = new EventSource('/sse');
eventSource.onmessage = ({ data }) => {
console.log('New message', JSON.parse(data));
};
```
[这里](https://github.com/nestjs/nest/tree/master/sample/28-sse)有一个可用的例子。
- 介绍
- 概述
- 第一步
- 控制器
- 提供者
- 模块
- 中间件
- 异常过滤器
- 管道
- 守卫
- 拦截器
- 自定义装饰器
- 基础知识
- 自定义提供者
- 异步提供者
- 动态模块
- 注入作用域
- 循环依赖
- 模块参考
- 懒加载模块
- 应用上下文
- 生命周期事件
- 跨平台
- 测试
- 技术
- 数据库
- Mongo
- 配置
- 验证
- 缓存
- 序列化
- 版本控制
- 定时任务
- 队列
- 日志
- Cookies
- 事件
- 压缩
- 文件上传
- 流式处理文件
- HTTP模块
- Session(会话)
- MVC
- 性能(Fastify)
- 服务器端事件发送
- 安全
- 认证(Authentication)
- 授权(Authorization)
- 加密和散列
- Helmet
- CORS(跨域请求)
- CSRF保护
- 限速
- GraphQL
- 快速开始
- 解析器(resolvers)
- 变更(Mutations)
- 订阅(Subscriptions)
- 标量(Scalars)
- 指令(directives)
- 接口(Interfaces)
- 联合类型
- 枚举(Enums)
- 字段中间件
- 映射类型
- 插件
- 复杂性
- 扩展
- CLI插件
- 生成SDL
- 其他功能
- 联合服务
- 迁移指南
- Websocket
- 网关
- 异常过滤器
- 管道
- 守卫
- 拦截器
- 适配器
- 微服务
- 概述
- Redis
- MQTT
- NATS
- RabbitMQ
- Kafka
- gRPC
- 自定义传输器
- 异常过滤器
- 管道
- 守卫
- 拦截器
- 独立应用
- Cli
- 概述
- 工作空间
- 库
- 用法
- 脚本
- Openapi
- 介绍
- 类型和参数
- 操作
- 安全
- 映射类型
- 装饰器
- CLI插件
- 其他特性
- 迁移指南
- 秘籍
- CRUD 生成器
- 热重载
- MikroORM
- TypeORM
- Mongoose
- 序列化
- 路由模块
- Swagger
- 健康检查
- CQRS
- 文档
- Prisma
- 静态服务
- Nest Commander
- 问答
- Serverless
- HTTP 适配器
- 全局路由前缀
- 混合应用
- HTTPS 和多服务器
- 请求生命周期
- 常见错误
- 实例
- 迁移指南
- 发现
- 谁在使用Nest?