背景

  • 在实际项目中，可能会通过前端框架使用 WebSocket 和后端进行通信
  • 这里就来详细讲解下 FastAPI 是如何操作 WebSocket 的

模拟 WebSocket 客户端

#!usr/bin/env python

# -*- coding:utf-8 _*-

"""

# author: 小菠萝测试笔记

# blog:  https://www.cnblogs.com/poloyy/

# time: 2021/10/5 5:26 下午

# file: 46_websocket.py

"""

import uvicorn

from fastapi import FastAPI, WebSocket

from fastapi.responses import HTMLResponse

app = FastAPI()

html = """

<!DOCTYPE html>

<html>

    <head>

        <title>小菠萝聊天室</title>

    </head>

    <body>

        <h1>小菠萝聊天室</h1>

        <form action="" onsubmit="sendMessage(event)">

            <input type="text" id="messageText" autocomplete="off"/>

            <button>Send</button>

        </form>

        <ul id='messages'>

        </ul>

        <script>

            // 加载页面，自动创建一个 WebSocket 连接

            var ws = new WebSocket("ws://localhost:8080/ws");

            // 收到消息

            ws.onmessage = function(event) {

                // 获取输入框的值

                var messages = document.getElementById('messages')

                // 创建一个 li 元素

                var message = document.createElement('li')

                // 接收 event 的 data

                var content = document.createTextNode(event.data)

                message.appendChild(content)

                messages.appendChild(message)

            };

            // 发送消息方法

            function sendMessage(event) {

                var input = document.getElementById("messageText")

                ws.send(input.value)

                input.value = ''

                event.preventDefault()

            }

        </script>

    </body>

</html>

"""

# 返回一段 HTML 代码给前端

@app.get("/")

async def get():

    return HTMLResponse(html)

@app.websocket("/ws")

async def websocket_endpoint(websocket: WebSocket):

    # 1、ws 连接

    await websocket.accept()

    while True:

        # 2、接收客户端发送的内容

        data = await websocket.receive_text()

        # 3、服务端发送内容

        await websocket.send_text(f"小菠萝收到的消息是: {data}")

if __name__ == '__main__':

    uvicorn.run(app="46_websocket:app", reload=True, host="127.0.0.1", port=8080)

启动 uvicorn 服务器，访问 127.0.0.1:8080/

客户端、服务端建立 WebSocket 连接成功

发送聊天信息

每发一条消息，均会显示在列表中

可以在其他地方使用 WebSocket

  • Depends
  • Security
  • Cookie
  • Header
  • Path
  • Query

在依赖项中使用 WebSocket

from typing import Optional

import uvicorn

from fastapi import FastAPI, WebSocket, Cookie, Query, status, Depends

from fastapi.responses import HTMLResponse

app = FastAPI()

html = """

<!DOCTYPE html>

<html>

    <head>

        <title>Chat</title>

    </head>

    <body>

        <h1>小菠萝聊天室</h1>

        <form action="" onsubmit="sendMessage(event)">

            <label>Item ID: <input type="text" id="itemId" autocomplete="off" value="foo"/></label>

            <label>Token: <input type="text" id="token" autocomplete="off" value="some-key-token"/></label>

            <button onclick="connect(event)">Connect</button>

            <hr>

            <label>Message: <input type="text" id="messageText" autocomplete="off"/></label>

            <button>Send</button>

        </form>

        <ul id='messages'>

        </ul>

        <script>

        var ws = null;

            function connect(event) {

                var itemId = document.getElementById("itemId")

                var token = document.getElementById("token")

                ws = new WebSocket("ws://localhost:8080/items/" + itemId.value + "/ws?token=" + token.value);

                ws.onmessage = function(event) {

                    var messages = document.getElementById('messages')

                    var message = document.createElement('li')

                    var content = document.createTextNode(event.data)

                    message.appendChild(content)

                    messages.appendChild(message)

                };

                event.preventDefault()

            }

            function sendMessage(event) {

                var input = document.getElementById("messageText")

                ws.send(input.value)

                input.value = ''

                event.preventDefault()

            }

        </script>

    </body>

</html>

"""

@app.get("/")

async def get():

    return HTMLResponse(html)

async def get_cookie_or_token(

        websocket: WebSocket,

        session: Optional[str] = Cookie(None),

        token: Optional[str] = Query(None)

):

    # 模拟：如果 session 和 token 都为空，则关闭 websocket

    if session or token:

        return session or token

    await websocket.close(code=status.WS_1008_POLICY_VIOLATION)

@app.websocket("/items/{item_id}/ws")

async def websocket_depends(

        websocket: WebSocket,

        item_id: str,

        q: Optional[str] = None,

        # 依赖项

        cookie_or_token: str = Depends(get_cookie_or_token)

):

    # 1、创建 websocket 连接

    await websocket.accept()

    while True:

        # 2、接收客户端发送的内容

        data = await websocket.receive_text()

        # 3、服务端发送内容

        await websocket.send_text(f"cookie or token value is:{cookie_or_token}")

        if q:

            # 4、如果有传查询参数 q，则再发一条

            await websocket.send_text(f"query param value is:{q}")

        # 5、最后再发一条信息

        await websocket.send_text(f"Message text was: {data}, for item ID: {item_id}")

if __name__ == '__main__':

    uvicorn.run(app="46_websocket:app", reload=True, host="127.0.0.1", port=8080)

发送聊天信息

不带查询参数 q

带查询参数 q

当 WebSocket 连接关闭时

await websocket.receive_text()  将引发 WebSocketDisconnect 异常，这不是期望看到的结果

处理断开连接和多个客户端

from typing import List

import uvicorn

from fastapi import FastAPI, WebSocket, WebSocketDisconnect, status

from fastapi.responses import HTMLResponse

app = FastAPI()

html = """

<!DOCTYPE html>

<html>

    <head>

        <title>Chat</title>

    </head>

    <body>

        <h1>WebSocket Chat</h1>

        <h2>Your ID: <span id="ws-id"></span></h2>

        <form action="" onsubmit="sendMessage(event)">

            <input type="text" id="messageText" autocomplete="off"/>

            <button>Send</button>

        </form>

        <ul id='messages'>

        </ul>

        <script>

            var client_id = Date.now()

            document.querySelector("#ws-id").textContent = client_id;

            var ws = new WebSocket(`ws://localhost:8080/ws/${client_id}`);

            ws.onmessage = function(event) {

                var messages = document.getElementById('messages')

                var message = document.createElement('li')

                var content = document.createTextNode(event.data)

                message.appendChild(content)

                messages.appendChild(message)

            };

            function sendMessage(event) {

                var input = document.getElementById("messageText")

                ws.send(input.value)

                input.value = ''

                event.preventDefault()

            }

        </script>

    </body>

</html>

"""

# 返回一段 HTML 代码给前端

@app.get("/")

async def get():

    return HTMLResponse(html)

# 处理和广播消息到多个 WebSocket 连接

class ConnectionManager:

    def __init__(self):

        self.active_connections: List[WebSocket] = []

    async def connect(self, websocket: WebSocket):

        await websocket.accept()

        self.active_connections.append(websocket)

    def disconnect(self, websocket: WebSocket):

        self.active_connections.remove(websocket)

    async def send_personal_message(self, message: str, websocket: WebSocket):

        await websocket.send_text(message)

    async def broadcast(self, message: str):

        for connection in self.active_connections:

            await connection.send_text(message)

manager = ConnectionManager()

@app.websocket("/ws/{client_id}")

async def websocket_endpoint(client_id: str, websocket: WebSocket):

    # 1、客户端、服务端建立 ws 连接

    await manager.connect(websocket)

    # 2、广播某个客户端进入聊天室

    await manager.broadcast(f"{client_id} 进入了聊天室")

    try:

        while True:

            # 3、服务端接收客户端发送的内容

            data = await websocket.receive_text()

            # 4、广播某个客户端发送的消息

            await manager.broadcast(f"{client_id} 发送消息：{data}")

            # 5、服务端回复客户端

            await manager.send_personal_message(f"服务端回复{client_id}：你发送的信息是：{data}", websocket)

    except WebSocketDisconnect:

        # 6、若有客户端断开连接，广播某个客户端离开了

        manager.disconnect(websocket)

        await manager.broadcast(f"{client_id} 离开了聊天室")

if __name__ == '__main__':

    uvicorn.run(app="48_websocket_handler:app", reload=True, host="127.0.0.1", port=8080)
  • 模拟一个小型聊天室的场景
  • 新的客户端进来，所有人都会收到新客户端进入聊天室的消息
  • 某个客户端发送消息，所有人都能看到
  • 某个客户端退出了（关闭浏览器），所有人都会收到该客户端退出聊天室的消息

浏览器打开三个 tab 均访问 127.0.0.1:8080

关掉其中一个客户端（tab）

FastAPI（56）- 使用 Websocket 打造一个迷你聊天室的更多相关文章

  1. 学习WebSocket(二):使用Spring WebSocket做一个简单聊天室

    聊天室高频率.低延时完全符合websocket的特点,所以聊天室使用websocket再适合不过了. 聊天室的功能并没有比上一节代码多多少,主要在握手阶段对用户的session做处理,对用户的消息进行 ...

  2. nodejs与websocket模拟简单的聊天室

    nodejs与websocket模拟简单的聊天室 server.js const http = require('http') const fs = require('fs') var userip ...

  3. Python开发一个WEB聊天室

    项目实战:开发一个WEB聊天室 功能需求: 用户可以与好友一对一聊天 可以搜索.添加某人为好友 用户可以搜索和添加群 每个群有管理员可以审批用户的加群请求,群管理员可以用多个,群管理员可以删除.添加. ...

  4. Node.js+websocket+mongodb实现即时聊天室

    ChatRoom Node.js+websocket+mongodb实现即时聊天室 A,nodejs简介:Node.js是一个可以让javascript运行在服务器端的平台,它可以让javascrip ...

  5. 基于 OpenResty 实现一个 WS 聊天室

    基于 OpenResty 实现一个 WS 聊天室 WebSocket WebSocket 协议分析 WebSocket 协议解决了浏览器和服务器之间的全双工通信问题.在WebSocket出现之前,浏览 ...

  6. Django中使用websocket并实现简易聊天室

    django使用websocket并实现简易聊天室 django默认只支持http协议 如果你想让django即支持http协议又支持websocket协议,则需要做以下配置 前期配置 前提需要安装c ...

  7. 如何利用WebSocket实现网页版聊天室

    花了将近一周的时间终于完成了利用WebSocket完成网页版聊天室这个小demo,期间还走过了一段"看似弯曲"的道路,但是我想其实也不算是弯路吧,因为你走过的路必将留下你的足迹.这 ...

  8. HTML5新特性 websocket(重点)--多对多聊天室

    一.html5新特性  websocket(重点)--多对多聊天室 HTTP:超文本传输协议 HTTP作用:传输网页中资源(html;css;js;image;video;..) HTTP是浏览器搬运 ...

  9. html5 WebSocket 与 PHP socket 聊天室原理

    html js <!DOCTYPE html> <html lang="en"> <head> <meta charset="U ...

随机推荐

  1. SpringMVC的拦截器和过滤器的区别

    一 简介 (1)过滤器: 依赖于servlet容器.在实现上基于函数回调,可以对几乎所有请求进行过滤,但是缺点是一个过滤器实例只能在容器初始化时调用一次.使用过滤器的目的是用来做一些过滤操作,获取我们 ...

  2. 深入浅出Mybatis系列（五）---配置详解之settings设置

    settings 中的设置是非常关键的,它们会改变 MyBatis 的运行时行为.下表描述了设置中各项的意图.默认值等. 设置参数 描述 有效值 默认值 cacheEnabled 该配置影响的所有映射 ...

  3. SpringBoot快速搭建流程

    创建一个新项目 使用maven创建一个新项目 给定项目名称.finsh完成创建 跑起来SpringBoot 引入依赖parent > SpringBoot父级依赖,spring-boot-sta ...

  4. Ubuntu下安装Python3（与旧Python2版本共存）

    官网下载Python3的源码 进行配置,在源码目录运行如下命令. ./configure --prefix=/usr/local/python3 --enable-shared 进行编译,在源码目录运 ...

  5. Robot framework随机文件

    *** Variables *** @{Example} One Two Three *** Test Cases *** Example ${value}= Evaluate random.choi ...

  6. Git入门配置

    1.账户注册: 无论是GitHub还是码云(下称Gitee),要使用他们,我们都需要先注册账户,已有账户的可以跳过此步骤. Gitee GitHub 2.创建仓库: a.创建远程仓库 登入Gitee后 ...

  7. openresty lua-resty-string md5 sha aes random string

    安装 https://github.com/openresty/lua-resty-string $ sudo opm get openresty/lua-resty-string $ ls -al ...

  8. 从kratos分析breaker熔断器源码实现

    为什么要用熔断 前面我们讲过限流保证服务的可用性,不被突如其来的流量打爆.但是两种情况是限流解决不了的. 如果我们服务只能处理1000QPS,但是有10wQPS打过来,服务还是会炸.因为拒绝请求也需要 ...

  9. 洛谷P3104 Counting Friends G 题解

    题目 [USACO14MAR]Counting Friends G 题解 这道题我们可以将 \((n+1)\) 个边依次去掉,然后分别判断去掉后是否能满足.注意到一点, \(n\) 个奶牛的朋友之和必 ...

  10. Linux下用Sed查找IP地址

    ip addr|sed -n '9p'|egrep '[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}'|sed -nr 's#^.*inet (.*) b ...