用 aiohttp 与 Server-Sent Events 实现即时聊天应用

随着互联网的快速发展,即时通信应用也越来越流行。尤其是近年来,随着移动互联网的普及,即时通信应用更是成为人们日常生活中不可或缺的一部分。本文将介绍如何使用 aiohttp 和 Server-Sent Events 来实现一个简单的即时聊天应用,并对其中的技术细节进行详细讲解。

aiohttp 是什么?

aiohttp 是一个 Python 的 HTTP 客户端和服务器框架。它支持异步 IO,与 Python 语言自带的 async IO 库结合使用,能够形成一个高效的、并发的、易于开发和维护的 Web 应用程序。使用 aiohttp 编写 Web 应用程序,可以极大地简化 IO 密集型代码的开发。aiohttp 还支持 WebSocket、HTTP/2 和 HTTP/3 协议。

Server-Sent Events 是什么?

Server-Sent Events (SSE) 是一种 HTML5 技术,它以一种简单的、基于文本的方式向 Web 页面推送事件流。当一个 SSE 连接建立后,服务器就会持续地向客户端发送事件流。这种技术被广泛地应用于实时通知、实时数据更新等方面。

实现一个简单的即时聊天应用

为了说明如何使用 aiohttp 和 SSE 实现即时通信,我们将要构建一个简单的聊天室应用,用户可以在聊天室中发送和接收消息。以下是该应用的主要功能:

  1. 在 Web 浏览器中展示聊天室 UI;
  2. 在聊天室中发送和接收消息;
  3. 将发送的消息在聊天室中持久化。

设计应用架构

首先,我们需要设计应用的架构,如下图所示:

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

上述架构中,客户端为 Web Browser,它通过 HTTP Request 向 aiohttp Server 发送请求。aiohttp Server 使用 SSE 向客户端推送事件流,同时,它还会与 Chat Server 上的 Web Socket 建立连接,将聊天室中的消息通过 WebSocket 推送给客户端。

编写代码实现应用

接下来,我们将编写代码来实现上述应用的功能。我们首先需要构建一个可以处理 SSE 请求的 aiohttp Server。

实现 aiohttp Server 端

我们首先定义了一个用于处理 SSE 请求的 aiohttp View:

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


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

上述代码定义了一个 sse_handler 函数,它是一个标准的 aiohttp View,用来处理 SSE 请求。在处理请求时,我们首先创建了一个 StreamResponse 对象,将其 headers 设置为 'Content-Type: text/event-stream',这是 SSE 的标准 MIME 类型。之后,我们使用 await response.prepare() 将 response 对象准备好,允许我们使用 response.write() 向客户端发送数据。最后,我们使用 asyncio.sleep() 暂停 1 秒钟,模拟持续的 SSE 数据流。

接下来,我们需要将 sse_handler 绑定到 aiohttp Server 上:

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

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

上述代码表示我们将 sse_handler 函数绑定到了 '/sse' 路由上,当客户端通过 'GET /sse' 请求该路由时,将调用 sse_handler 函数。最后,我们使用 web.run_app(app) 来启动整个 aiohttp Server。

实现 Chat Server 端

接下来,我们需要实现 Chat Server 端,它负责接收用户的消息、将消息持久化,并将消息通过 WebSocket 推送给聊天室中的所有用户。这里,我们可以使用 Python 的 WebSocket 库 fooster-websocket 来实现一个简单的 Chat Server。具体实现代码如下:

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

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


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

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

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

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

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

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

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

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

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

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

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


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

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

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


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

上述代码中,我们通过定义 ChatServer 类来处理 WebSocket 连接。我们将所有的用户连接存放在 users 集合中,并为每个客户端分配一个唯一的 client_id。同时,我们将 messages 用于保存已经发送的所有消息,以便 WebSocket 客户端可以在连接时收到历史消息。

我们接下来实现了一个 register 函数,用于添加新用户到 ChatServer 中。该函数将客户端添加到 users 集合中,并将客户端添加到 clients['all'] 中,以便 ChatServer 可以将消息发送到所有客户端。

然后,我们实现了一个 unregister 函数,用于从 ChatServer 中移除一个用户。当用户连接关闭时,我们删除了该用户的 WebSocket 对象,并从 users 集合中移除该用户。

最后,我们实现了一个 dispatch 函数,它负责将消息分发给 ChatServer 中的所有客户端,包括历史消息。当用户发送消息时,我们将消息添加到 messages 中,并将消息以 JSON 格式发送到所有客户端。匹配不同的用户组。最后,我们使用 websockets.serve() 函数启动聊天服务器,并在运行时处理 WebSocket 连接。

至此,我们已经完成了聊天服务器的编写。我们现在需要将 Chat Server 和 aiohttp Server 整合在一起。

整合 Chat Server 和 aiohttp Server

我们需要在 aiohttp Server 中建立 WebSocket 连接,将其作为 Chat Server 与 Chat Server 之间的通信通道,从而实现 Chat Server 推送消息给 Web Browser。

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

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


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

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

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

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


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


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

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


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

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

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

上述代码为 aiohttp Server 的主体部分。我们将 '/chat' 绑定到使用漂亮的 timeout.html 模板实现的聊天窗口。在 sse_handler 中,我们向 '/sse' 发送了一个 GET 请求,以获取服务器推送的 SSE 事件流。在发现新数据时,我们将其发送到 ChatServer,以便 Chat Server 可以推送新消息。

运行即时聊天室应用

到此,我们已经实现了一个简单的即时聊天室应用程序。我们可以执行以下命令来启动它:

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

总结

本文介绍了如何使用 aiohttp 和 Server-Sent Events 来实现一个简单的即时聊天室应用。基于该应用,我们讲解了 aiohttp 和 Server-Sent Events 的一些基本用法,以及如何将异步 IO 应用于 Web 开发。本文中所涉及的源代码可在 GitHub 上查看。

我们希望,通过本文的介绍,读者可以深入了解 aiohttp 和 Server-Sent Events 的使用,并且可以利用此知识去构建更为复杂的实时应用。

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