在 Java 应用程序中使用 Servlets 实现 Server-sent Events(SSE)

随着 Web 技术的发展,实时数据传输变得越来越普遍。一个常见的需求是让服务器向客户端实时发送事件,而不是请求该事件。例如,一个股票应用程序可以每次股价变化时向客户端发送通知。

这种实时数据传输可以使用 Server-sent Events(SSE)来实现。本文将介绍如何在 Java 应用程序中使用 Servlets 来实现 SSE。

什么是 Server-sent Events?

Server-sent Events 是一种 HTML5 技术,它允许服务器向客户端实时发送事件。使用 SSE,客户端可以在不刷新页面的情况下接收事件,因此它更适合实时传输数据。相比于 WebSocket,SSE 更容易实现,但是它仅仅是单向通信。

使用 SSE 的好处

使用 SSE 的好处包括:

  • 客户端无需不断地轮询服务器以获取新的数据。
  • 数据传输更加实时,因为没有轮询延迟。
  • 减少服务器负载。

实现 SSE

要实现 SSE,我们需要在客户端创建一个 EventSource 对象,并设置服务器地址。服务器必须在预处理程序(即 doGet() 方法)中发送数据,代码如下:

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

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

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

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

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

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

在客户端,使用 JavaScript 可以非常容易地处理 SSE 事件,代码如下:

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

EventSource 对象上注册 onmessage 事件处理程序并处理接收到的数据。

SSE 的注意事项

使用 SSE 时需要注意以下事项:

  • 浏览器兼容性:SSE 可以在大多数现代浏览器中使用,但在某些旧浏览器中无法正常工作。
  • 服务器负载:使用 SSE 会增加服务器负载,因为它要维护多个长连接。
  • 连接超时:使用 SSE 时需要注意连接超时,因为连接可能会因为某些原因(例如网络故障)而中断。

示例代码

以下是一个使用 SSE 的示例应用程序。该应用程序使用 Spring Boot 和 Thymeleaf,但对于实现 SSE 的部分可以与任何 Java Web 框架一起使用。

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

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

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

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

该控制器使用 ConcurrentHashMap 存储每个房间的 SseEmitter。当客户端请求 SSE events 时,控制器创建一个 SseEmitter 并将其添加到该房间的 emitters 列表中。当客户端断开连接时,控制器将其从列表中移除。

当客户端向 /sse/{room} 路径发出 POST 请求时,该控制器使用 SseEmitter 将消息发送到该房间中的所有客户端。如果发送失败,则控制器会将 SseEmitter 从列表中移除并完成。

在客户端,使用以下代码监听 SSE 事件:

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

完整的示例代码可以在 GitHub 上下载

结论

Server-sent Events 是实现实时数据传输的一种强大且易于使用的技术。它比循环请求更有效率,同时仍然能够提供足够的实时性。借助可在 Java Servlets 中使用的 SSE,您可以在自己的 Web 应用程序中轻松实现此功能。

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