## 服務器端事件發送
服務器端事件發送(`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?