背景

  • 在实际项目中，可能会通过前端框架使用 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. WPF 勾选划线

    最近项目需要一个左右侧一对多的划线功能 我们先来看一下效果秃: 主要功能: 支持动态添加 支持复选 支持修改颜色 支持动态宽度 主要实现:事件的传递 应用场景:购物互选,食品搭配,角色互选 数据源 左 ...

  2. 六、Abp vNext 基础篇丨文章聚合功能上

    介绍 9月开篇讲,前面几章群里已经有几个小伙伴跟着做了一遍了,遇到的问题和疑惑也都在群里反馈和解决好了,9月咱们保持保持更新.争取10月份更新完基础篇. 另外番外篇属于 我在abp群里和日常开发的问题 ...

  3. linux centos7 模拟垃圾回收站功能以及 crontab 定时任务的设置

    2021-08-04 1. 安装 环境:CentOS Linux release 7.5.1804 (Core) # 将 saferm.sh 拷贝到 /bin 目录下面 git clone git:/ ...

  4. Redis实现主从复制以及sentinel的配置

    redis 是一个高性能的 key-value 数据库. redis 的出现,很大程度补偿了 memcached 这类 keyvalue 存储的不足,在部分场合可以对关系数据库起到很 好的补充作用.它 ...

  5. MyBatis学习总结(四)——字段名与实体类属性名不相同的冲突的解决

    表中的字段名和表对应实体类的属性名称不一定都是完全相同的,这种情况下的如何解决字段名与实体类属性名不相同的冲突.如下所示: 一.准备演示需要使用的表和数据 CREATE TABLE my_user( ...

  6. MySQL高级语句（二）

    目录: 1.别名 2.子查询 3.EXISTS 4.连接查询 5.CREATE VIEW 视图 6.UNION 联集 7.交集值 8.无交集值 9.CASE 10.算排名 11.算中位数 12.算累积 ...

  7. Java反序列化漏洞Apache CommonsCollections分析

    Java反序列化漏洞Apache CommonsCollections分析 cc链,既为Commons-Collections利用链.此篇文章为cc链的第一条链CC1.而CC1目前用的比较多的有两条链 ...

  8. golang sync.noCopy 类型 —— 初探 copylocks 与 empty struct

    问题引入 学习golang(v1.16)的 WaitGroup 代码时,看到了一处奇怪的用法,见下方类型定义: type WaitGroup struct { noCopy noCopy ... } ...

  9. git config 选项

    git config  --global -- global 写入选项:写入全局的 ~/.gitconfig 文件而不是版本库的 .git/config,如果 ~/.gitconfig 文件不存在,则 ...

  10. 查看elasticsearch版本的方法

    查看elasticsearch版本的方法: 1.elasticsearch已经启动的情况下 使用curl -XGET localhost:9200命令查看: "version" : ...