Node.js 下使用 SSE 向客户端实时推送消息-JavaScript中文网-JavaScript教程资源分享门户

在 Web 开发中，实时推送消息是非常常见的需求，比如聊天室、股票行情、即时通讯等等。在 Node.js 中，我们可以使用 Server-Sent Events（SSE）技术来实现这种实时推送消息的需求。本文将介绍 Node.js 下使用 SSE 向客户端实时推送消息的实现方法。

SSE 简介

Server-Sent Events（SSE）是一种基于 HTTP 的实时推送技术，它允许 Web 服务器向客户端发送事件流，这些事件流可以是文本、JSON、XML 等格式的数据。SSE 使用 HTTP 协议，因此它可以很好地与现有的 Web 技术集成，比如 AJAX、RESTful API 等。

SSE 的工作原理是通过一个 HTTP 连接，服务器向客户端发送一个事件流，客户端通过监听这个事件流来接收服务器端的实时推送消息。SSE 使用的是长连接（long-polling）技术，即客户端向服务器发送一个 HTTP 请求，服务器会一直保持这个请求打开状态，直到有新的数据到达或者超时，然后再将数据返回给客户端，客户端再重新发送一个请求，如此循环，从而实现实时推送消息的效果。

Node.js 中使用 SSE 实现实时推送消息

在 Node.js 中，我们可以使用 sse 模块来实现 SSE 技术。sse 模块是一个基于 Node.js 的 SSE 服务器实现，它支持客户端连接、事件流发送、断开连接等操作。下面我们将介绍如何使用 sse 模块在 Node.js 中实现 SSE 技术。

安装 sse 模块

首先，我们需要安装 sse 模块，可以使用 npm 命令进行安装：

npm install sse

创建 SSE 服务器

接下来，我们需要创建一个 SSE 服务器，代码如下：

// javascriptcn.com 代码示例
const sse = require('sse');
const http = require('http');

const server = http.createServer((req, res) => {
  if (req.url === '/events') {
    const sseServer = new sse(req, res);

    // 发送事件流
    setInterval(() => {
      sseServer.send({ data: 'Hello, SSE!' });
    }, 1000);
  } else {
    res.writeHead(200, { 'Content-Type': 'text/plain' });
    res.end('Hello, World!');
  }
});

server.listen(3000, () => {
  console.log('Server is running at http://localhost:3000');
});

上面的代码中，我们创建了一个 HTTP 服务器，并在 /events 路径下创建了一个 SSE 服务器。在 SSE 服务器中，我们使用 setInterval 函数每隔一秒钟向客户端发送一个事件流，事件流的内容为 Hello, SSE!。

客户端连接 SSE 服务器

客户端可以通过向 /events 路径发送 HTTP 请求来连接 SSE 服务器，代码如下：

const eventSource = new EventSource('/events');

eventSource.onmessage = (event) => {
  console.log(event.data);
};

上面的代码中，我们使用 EventSource 对象连接 SSE 服务器，并监听 onmessage 事件来接收服务器端发送的事件流。当服务器发送一个事件流时，onmessage 事件会被触发，并将事件流的内容打印到控制台上。

自定义事件流

除了发送简单的文本消息之外，我们还可以发送 JSON、XML 等格式的数据。下面是一个发送 JSON 数据的示例代码：

// javascriptcn.com 代码示例
const sseServer = new sse(req, res);

setInterval(() => {
  const data = {
    time: new Date(),
    message: 'Hello, SSE!'
  };

  sseServer.send({ data: JSON.stringify(data) });
}, 1000);

上面的代码中，我们将一个 JSON 对象转换成字符串，并通过 SSE 服务器将其发送给客户端。客户端可以通过解析这个 JSON 字符串来获取数据。

断开连接

当客户端断开连接时，我们需要在 SSE 服务器中进行相应的处理。下面是一个处理断开连接的示例代码：

const sseServer = new sse(req, res);

sseServer.on('close', () => {
  console.log('Client disconnected');
});

上面的代码中，我们在 SSE 服务器中监听 close 事件来处理客户端断开连接的情况。当客户端断开连接时，close 事件会被触发，并将相应的处理代码执行。

总结

本文介绍了 Node.js 下使用 SSE 向客户端实时推送消息的实现方法。通过使用 sse 模块创建 SSE 服务器，我们可以轻松地实现服务器端向客户端实时推送消息的功能。SSE 技术在 Web 开发中非常常见，掌握 SSE 技术对于提高 Web 开发效率和质量非常有帮助。

来源：JavaScript中文网，转载请注明来源本文地址：https://www.javascriptcn.com/post/655062c87d4982a6eb93ce2c