利用 Server-sent Events 实现前端实时显示后端操作结果

在许多 Web 应用程序中,数据实时更新是必不可少的。常见的数据更新方式有轮询和 WebSocket。但是,还有一种相对少见的技术,它可以在没有 WebSocket 的情况下实现实时更新,它就是 Server-sent Events。

Server-sent Events

Server-sent Events 是一种浏览器与服务器实时通信的技术。和 WebSockets 一样,Server-sent Events 也是一个单向的连接,它允许服务器发送事件到客户端。但是,不同于 WebSocket,Server-sent Events 的优点在于它不需要一个完整的双向连接,也不需要建立一个新的 TCP 连接。它只需要一个 HTTP 连接,并且使用明文传输。

使用 Server-sent Events 实现实时更新

我们可以利用 Server-sent Events 在后台执行一些长时间的任务,并且将这些任务的进度信息发送回前端进行实时更新。下面是一个 Server-sent Events 实现的例子:

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

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

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

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

在这个例子中,我们创建了一个 EventSource 对象来连接到 /api/progress 路径的 Server-sent Events 流。每当服务器发送一个事件时,message 事件被触发,我们可以从 data 属性中读取到服务器发送的数据并对页面进行相应的更新。当连接出现错误时,error 事件被触发,我们可以在该事件中处理错误。最后,在页面关闭前,我们需要显式地关闭 SSE 连接。在这个例子中,我们使用了一个进度条来演示 Server-sent Events 如何更新实时数据。

实现过程

下面是如何在后台使用 Flask 和 Redis 进行 SSE 更新的一个例子。这个例子使用 Flask-Redis 扩展来连接 Redis 数据库,用于记录任务进度。

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

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

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

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

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

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

在这个例子中,我们定义了两个路由。/api/progress 路由返回一个 SSE 流,用于实时更新任务进度。在 /api/start 路由中,我们开始一个任务并更新进度信息。在这个例子中,我们将计数器存储在 Redis 中,每秒钟更新一次计数器,并返回更新后的计数器值。

结论

Server-sent Events 是一种简单易用的实时数据更新方式。如果您不需要一个完整的双向连接并且不需要建立一个新的 TCP 连接,那么 Server-sent Events 是一个不错的选择。在本文中,我们演示了如何使用 Server-sent Events 更新后台任务进度信息。希望本文对您有所帮助。

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