客户端

## 前言

服务端消息推送**SSE**是常用的服务器消息通信手段，适用于服务器主动给客户端发送消息的场景，例如私信通知，扫描登录等都可以使用SSE实现。SSE的底层原理是客户端与服务端建立 HTTP 长链接。

Nestjs 框架内置了对SSE的支持，本文详细介绍Nestjs服务端推送服务的实战步骤。

## 使用步骤

### 一、创建 SSE 接口服务

跟普通的 HTTP 方法相同，在 `@nestjs/common` 中引入 `@Sse` 装饰器，在处理服务器推送的方法上使用 `@See`装饰器。

```javascript
import { Controller, Param, Sse } from '@nestjs/common';
import { ApiTags } from '@nestjs/swagger';
import { Observable, interval, map } from 'rxjs';

export interface MessageEvent {
  message: string;
}

@Controller({ path: '/admin/message' })
export class AdminMessageController {
  @Sse('sse')
  sendServerMessage(@Param() params): Observable<MessageEvent> {
    return interval(5000).pipe(map((_) => ({ message: '你好乐闻' })));
  }
}
```

上面的程序目的是服务器每5s向客户端发送一次消息。

### 二、使用 Postman 调试服务端推送接口

由于SSE本质就是 HTTP 连接，在Postman中使用get请求发起请求即可。

会发现每 `5s`收到一条「你好乐闻」的消息。

![Untitled.png](https://cdn.portal.levenx.com/levenx-world/vSIwn4Jg7gOT4DUV.png)

### 三、浏览器前端建立链接

SSE 是客户端和服务端之间的单向通行，即服务端向客户端发送信息。客户端使用 `EventSource` 发送连接。

以 React 为例，实现前端页面与服务端建立SSE连接。服务端推送过来的消息会触发 `EventSource`的 `onmessage`回调事件，所以我们可以在 `onmessage`中自定义业务逻辑。

```javascript
useEffect(() => {
    const eventSource = new EventSource(
      "http://localhost:8822/admin/message/sse",
    );
    eventSource.onmessage = ({ data }) => {
      console.log("New message", JSON.parse(data));
    };
  }, []);
```

当我触发了自定义消息推送接口后，发现在浏览器的控制台可以看到日志输出

![Untitled.png](https://cdn.portal.levenx.com/levenx-world/SIpfsScRyDzp7ypD.png)

## 进阶使用

### 如何自定义推送的内容

由于 Nestjs 底层是依赖 `rxjs` 实现数据流，Nest 的 SSE 方法返回的是 `Observable` ,在SSE服务长链接时，希望在中途能够通知 `Observable`

返回不同的数据。

基于 `rxjs`的 `Subject`可以实现上述形式的数据推送。

1. 安装相关依赖

   ```javascript
   npm install @nestjs/event-emitter
   ```
2. nestjs 注册发布订阅模块

   ```javascript
   import { Module } from '@nestjs/common';
   import { EventEmitterModule } from '@nestjs/event-emitter';

   @Module({
     imports: [
       EventEmitterModule.forRoot()
     ],
   })
   export class AppModule {}
   ```
3. 实现SSE自定义消息逻辑以及发送自定义内容

   ```javascript
   import { Controller, Inject, Get, Sse } from '@nestjs/common';
   import { ApiTags } from '@nestjs/swagger';
   import { EventEmitter2 } from '@nestjs/event-emitter';
   import { Observable, Subject, map } from 'rxjs';

   export interface MessageEventData {
     userId: number;
     message: Record<string, string>;
   }

   export interface MessageEvent {
     message: MessageEventData;
   }

   @Controller({ path: '/admin/message' })
   export class AdminMessageController {
     @Inject(EventEmitter2)
     private readonly eventEmitterService: EventEmitter2;

     @Sse('sse')
     sendServerEvent(): Observable<MessageEvent> {
       const subject = new Subject();

       // 监听CUSTOM_MESSAGE事件
       this.eventEmitterService.on('CUSTOM_MESSAGE', (data) => {
         // subject 处理事件
         subject.next(data);
       });

       return subject.pipe(
         map((data: MessageEventData): MessageEvent => ({ message: data })),
       );
     }

   	// 发送自定义发送消息
     @Get('send')
     emitMessage() {
       const messageEventData: MessageEventData = {
         userId: 123456,
         message: { hi: '你好乐闻' },
       };
       // 发送 CUSTOM_MESSAGE 事件
       this.eventEmitterService.emit('CUSTOM_MESSAGE', messageEventData);
     }
   }
   ```
4. Postman 调试效果

   ![Untitled.png](https://cdn.portal.levenx.com/levenx-world/0VfS5TNXC4ezSybF.png)

   ![Untitled.png](https://cdn.portal.levenx.com/levenx-world/faKXabGdCWorx0P4.png)

## 总结

服务端推送SSE在业务开发中经常使用到的通信手段，Nestjs 是目前比较流行通用的node框架，Nestjs 支持了SSE，本文也大致介绍了使用步骤，希望能够对有需要的同学有所帮助。


服务端消息推送SSE是常用的服务器消息通信手段，适用于服务器主动给客户端发送消息的场景，例如私信通知，扫描登录等都可以使用SSE实现。SSE的底层原理是客户端与服务端建立HTTP长链接。Nestjs框架内置了对SSE的支持，本文详细介绍Nestjs服务端推送服务的实战步骤。使用步骤一、创建SSE接口服务跟普通的HTTP方法相同，在@nestjs/common中引入@Sse装饰器，在处理服务器推送的

NestJS 如何进行服务端推送SSE、自定义服务端推送内容

Git是一个由林纳斯·托瓦兹为了更好地管理linux内核开发而创立的分布式版本控制／软件配置管理软件。需要注意的是和GNU Interactive Tools，一个类似Norton Commander界面的文件管理器相区分。



C 语言，是一种通用的、过程式的编程语言，广泛用于系统与应用软件的开发。具有高效、灵活、功能丰富、表达力强和较高的移植性等特点，在程序员中备受青睐。

C 语言是由 UNIX 的研制者丹尼斯·里奇（Dennis Ritchie）和肯·汤普逊（Ken Thompson）于 1970 年研制出的B语言的基础上发展和完善起来的。目前，C 语言编译器普遍存在于各种不同的操作系统中，例如 UNIX、MS-D

C语言

C++ 是一种通用的、静态类型的编程语言，它具有高效性、灵活性和可移植性等特点。C++ 基于 C 语言，同时支持面向对象编程和泛型编程，可以用于开发各种类型的应用程序，如系统软件、游戏、桌面应用程序、移动应用程序等。

C++ 的主要特点包括：

高效性：C++ 是一种编译型语言，可以生成高效的本地代码，在性能要求高的应用程序中得到广泛应用；
面向对象编程：C++ 支持面向对象编程，包括封装、继承

React 是一个由 Facebook 开发的流行的 JavaScript 库，用于构建交互式用户界面。它采用了一种基于组件化的开发模式，使得开发人员可以将 UI 拆分为独立的、可复用的组件，并由这些组件构建复杂的用户界面。

React 的主要特点包括：

组件化开发：React 将 UI 拆分为独立的、可复用的组件，开发人员可以将这些组件组合在一起构建复杂的用户界面；
虚拟 DOM：React

React

Web前端开发是从网页制作演变而来的，名称上有很明显的时代特征。在互联网的演化进程中，网页制作是Web 1.0时代的产物，那时网站的主要内容都是静态的，用户使用网站的行为也以浏览为主。2005年以后，互联网进入Web 2.0时代，各种类似桌面软件的Web应用大量涌现，网站的前端由此发生了翻天覆地的变化。网页不再只是承载单一的文字和图片，各种富媒体让网页的内容更加生动，网页上软件化的交互形式为用户提

前端

JavaScript 是一种基于脚本的编程语言，主要用于在 Web 页面上实现交互式的效果和动态的内容。JavaScript 是一种解释性语言，不需要编译就可以直接在浏览器中运行。

JavaScript 的主要特点包括：

轻量级：JavaScript 代码通常比较短小，可以快速加载和执行。

可移植性：JavaScript 可以在各种不同的浏览器和操作系统上运行。

面向对象编程：JavaSc

JavaScript

Cypress 是一个前端自动化测试工具，用于测试基于Web的应用程序。它能够测试运行在浏览器中的应用，并且适用于单元测试、集成测试和端到端（E2E）测试。Cypress 提供了一个丰富的API集，以及一个友好的交互式界面，让开发和测试人员能够轻松编写、运行和调试测试用例。

Cypress

ORM（Object-Relational Mapping，对象关系映射）是编程中的一个概念，它指的是一种技术手段，可以将不兼容的类型系统转换为面向对象模型。换句话说，ORM 允许开发者在编程语言中使用对象的方式来操作数据库中的数据。

Linux 是一个广泛使用的开源操作系统内核，由林纳斯·托瓦兹（Linus Torvalds）于1991年创建。它是 Unix-like 操作系统的一个重要分支，并且它的设计和实现遵循了模块化的设计原则。Linux 内核本身可以与不同的用户空间组件配合，形成完整的操作系统。这些完整的系统被称为 Linux 发行版，例如 Ubuntu、Fedora、Debian、CentOS 和 Arch Linu

Linux

Vue.js（简称 Vue）是一种开源的轻量级 JavaScript 框架，由 Evan You 于2014年首次发布。Vue 致力于在用户界面（UI）开发中实现数据与视图的双向绑定，为创建现代化 Web 应用、单页面应用（SPA）以及多种复杂界面提供了一种简洁、高效且可扩展的解决方案。

#### 核心特性

- **组件化：** Vue 包含了独立的、可复用的组件，有助于将 UI 切成逻辑部分

Docker 是一个开源的容器化平台，允许开发者打包应用及其全部依赖到一个可移植的容器中，然后这个容器可以在任何机器上运行，确保应用在不同环境之间运行的一致性。Docker 使用了 Linux 容器（LXC）的技术，但进行了扩展，使其更为易用、功能更全面。

Docker

Rust是一种系统编程语言，由Mozilla Research开发。它是一种安全、并发和高效的语言，旨在为开发人员提供更好的内存安全和线程安全，同时保持高性能和可扩展性。

Rust的设计具有以下特点：

内存安全：Rust在编译时执行内存安全检查，防止常见的内存错误，例如使用空指针或释放不再使用的内存。

并发性：Rust具有一种称为"无等待"（lock-free）的并发模型，它可以确保线程安全

Rust

MySQL 是一款流行的关系型数据库管理系统（RDBMS）。它负责存储、检索和管理结构化数据，尤其是以表格形式存储的数据。MySQL 使用 SQL（Structured Query Language，结构化查询语言）作为查询和操作数据的接口，并遵循许多 SQL 标准。它是一种兼具性能、可靠性和易用性的数据库系统，适用于各种应用场景，从个人项目到大型企业应用。

MySQL

JavaScript 的升级版 TypeScript 已日益成为开发世界全新的演变里程碑。立足于 JavaScript 的优雅灵活与 TypeScript 的强类型体系，本教程旨在助您铸就极致的开发力量。

我们的 TypeScript 系列教程将自始至终地引导你掌握 TypeScript 的各种方面，与您一起，宏观理解 JavaScript 世界、深入钻研 TypeScript 规则与逻辑，探索

TypeScript

Mongoose 是一个面向 MongoDB 数据库的对象数据模型（ODM）库，用于在 Node.js 环境下建模和操作 MongoDB 文档结构。它提供了一些方便的特性，如数据验证、查询构建、业务逻辑钩子（hooks）和中间件，使得处理 MongoDB 文档更加直观和安全。


Mongoose

Tailwind CSS 是一个非常强大且受欢迎的实用型 CSS 框架，于2017年由.Adam Wathan、Jonathan Reinink、David Hemphill 和 Steve Schoger 共同创立。 这个框架的主要目标是帮助开发者快速构建定制化的用户界面，而无需从头开始编写 CSS 代码。
Tailwind 提供了一整套预先定义好的类名，代表 CSS 的各种属性，如颜色、字体大

Tailwind CSS

Elasticsearch（常写作 Elasticsearch）是基于 Lucene 的分布式搜索与分析引擎，面向海量数据提供近实时（NRT）的全文检索、结构化查询与聚合分析能力。它以 JSON 文档为核心数据模型，通过 索引（index）—分片（shard）—副本（replica） 的机制实现横向扩展与高可用：数据被切分到多个分片分布在不同节点上，副本用于容灾与提升读取吞吐。Elasticsea

ElasticSearch

Go，也称为 Golang，是一种开源的编程语言，由 Google 开发。Go 是一种静态类型、编译型、并发型的语言，它被设计为一种简单、快速、可靠和高效的语言。Go 语言的语法类似于 C 语言，但也借鉴了其他语言的一些特性，如 Python 和 Java。

Go 语言的设计目标是提供一种简单、易于学习和使用的语言，同时具有高效的执行速度和并发处理能力。Go 语言的主要特点包括：

1. 并发支

Golang

CSS（Cascading Style Sheets）是一种用于描述文档样式和布局的样式表语言，常用于 Web 开发中。它通过定义样式规则来控制 HTML 元素的外观和布局，使得开发人员可以更加灵活地控制页面的样式和排版。

CSS 的主要特点包括：

分离样式和内容：CSS 可以将样式信息从 HTML 内容中分离出来，使得样式和内容的管理更加清晰和易于维护；
层叠样式：CSS 中的样式规则是可以

Network（网络）是指连接在一起的计算机、设备和其他物体，它们可以彼此通信和交换信息。网络可以分为局域网（LAN）、广域网（WAN）、互联网（Internet）等不同的类型和层次，它们在不同的范围和层次上提供了不同的服务和功能。

网络的主要特点包括：

连通性：网络可以将不同的计算机、设备和应用程序连接在一起，实现彼此之间的通信和数据交换。

分布式：网络中的计算机和设备分布在不同的地理位置