了解如何创建基于永久连接 Server-Sent Events

在现代 web 应用程序中,与服务器保持实时连接是非常重要的。一个优秀的工具来实现这一目标是 Server-Sent Events(SSE),它是一种基于 HTTP 的协议,可以通过永久连接从服务器向浏览器发送消息和数据。

本文将介绍如何在前端中创建基于 SSE 的实时连接,并提供详细的学习和指导。我们将探讨以下内容:

  • SSE 的基本原理及其用途
  • 如何使用 SSE 在我们的应用程序中创建实时连接
  • 示例代码和常见问题解答

SSE 简介

Server-Sent Events 是一种基于 HTTP 的协议,它与 WebSocket 类似,但是它的实现要简单得多。SSE 允许服务器以异步方式向客户端发送数据,而客户端不需要像 WebSocket 那样维护一个持久连接。

SSE 可以在浏览器和服务器之间建立一条活动连接,并使服务器能够随时向客户端发出消息。如果我们使用 SSE,我们可以实现对服务器的实时通信,这对于一些特定场景下非常有用,例如:

  • 实时应用程序,例如股票报价、地图和即时信息流。
  • 轮询的替代品,例如,可以用 SSE 来代替定期进行轮询数据的策略。

SSE 工作原理

使用 SSE 的基本流程是:

  1. 客户端使用 EventSource 对象向服务器发出 HTTP 请求
  2. 服务器为客户端返回一个 Content-Type 头字段的值为 text/event-stream 的响应
  3. 服务器使用文本事件流(text event stream)与客户端通信,将消息传递给 EventSource 对象
  4. 客户端通过监听 EventSource 对象的 onmessage 事件来处理从服务器收到的事件

每个 SSE 事件都由一个消息 ID、事件名称和数据组成。它们以如下方式发送:

--- ----
------ -------
----- ---- -- - ---- -------

--- ----
------ ------- -------
----- ---- -- ------- ---- -------

一次 SSE 会话可能会包含多个这样的事件,客户端通过监听 EventSource 对象的 onmessage 事件来处理收到的事件。

使用 SSE 进行实时连接

现在,我们已经了解了 SSE 的基本情况,我们将介绍如何在前端应用程序中使用 SSE 来建立实时连接。

首先,我们需要在客户端 Javascript 中创建一个 EventSource 对象。我们可以使用以下代码:

----- ----------- - --- --------------------------------------------

这将创建一个新的 SSE 对象,并将它与我们的服务器端点 http://localhost:3001/events 相关联。

随后,我们需要为 eventSource 对象设置 onmessage 监听器。这个监听器将在从服务器端点接收到消息时触发。我们可以使用以下代码来设置监听器:

--------------------- - --------------- -
  --------------------- ------ -------- -- ------------
-

这将在控制台输出从服务器端点接收到的消息。

现在,我们的客户端已经准备好接收来自服务器的实时数据。接下来,我们需要在服务器端点上设置 SSE 连接,以便服务器能够向客户端发送消息。

我们可以使用 Node.js 中的 httpsse 模块来实现 SSE 连接。以下是一个例子:

----- ---- - ----------------
----- --- - ---------------

----- ------ - ----------------------- ---- -- -
  -- -------- --- ---------- -
    ------------------ -
      --------------- --------------------
      ---------------- -----------
      ------------- -------------
    ---

    ----- --------- - --- -------- -----

    -------------- -- -
      ----------------
        --- -----------
        ------ ----- -------
        ----- ------- -------
      ---
    -- ------

  - ---- -
    -------------------
    ----------
  -
---

------------------- -- -- -
  ------------------- --------- -- ---- -------
---

此代码会创建一个基于 Node.js 的 HTTP 服务器,并在 /events 端点上创建 SSE 连接。我们通过 sse.send() 方法向客户端发送数据,并使用 setInterval() 函数来模拟实时数据流。

示例代码和常见问题解答

完整的示例代码可以在我的 Github 仓库中找到:https://github.com/johndoe/sse-example

以下是一些常见问题的解答:

Q: SSE 会话会一直持久化吗?

A: 是的,SSE 会话会一直保持活动状态,直到客户端关闭它或者发生连接超时。

Q: 我该如何处理 SSE 连接超时?

A: SSE 连接默认超时时间为 2 小时。如果客户端在这段时间内未接收到新的事件,则连接将超时并关闭。您可以通过重新打开 SSE 连接来处理它。

Q: SSE 数据是如何传输的?

A: SSE 数据随着文本事件流一起发送。每个事件由一个消息 ID、事件名称和数据组成,它们以如下方式发送:

--- ----
------ -------
----- ---- -- - ---- -------

--- ----
------ ------- -------
----- ---- -- ------- ---- -------

Q: 我该如何处理 SSE 连接出错?

A: SSE 连接可能会出现错误,例如服务器关闭。您可以通过 EventSource 对象的 onerror 事件来处理这些错误,例如:

------------------- - --------------- -
  ---------------- ---------- ----- ---- ------- -- -------
-

结论

在本文中,我们了解了 Server-Sent Events 的基本情况及其工作原理。我们还介绍了如何在前端应用程序中使用 SSE 来建立实时连接,并提供了示例代码和常见问题解答。

SSE 是一种非常有用的通信协议,它可以让我们轻松地实现前端和服务器之间的实时通信。如果您正在构建一个需要实时通信的应用程序,那么 SSE 会是一个不错的选择。

来源:JavaScript中文网 ,转载请注明来源 本文地址:https://www.javascriptcn.com/post/671e12442e7021665ef59106