FastAPI（56）- 使用 Websocket 打造一个迷你聊天室

背景

在实际项目中，可能会通过前端框架使用 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 打造一个迷你聊天室的更多相关文章

学习WebSocket(二):使用Spring WebSocket做一个简单聊天室
聊天室高频率.低延时完全符合websocket的特点,所以聊天室使用websocket再适合不过了. 聊天室的功能并没有比上一节代码多多少,主要在握手阶段对用户的session做处理,对用户的消息进行 ...
nodejs与websocket模拟简单的聊天室
nodejs与websocket模拟简单的聊天室 server.js const http = require('http') const fs = require('fs') var userip ...
Python开发一个WEB聊天室
项目实战:开发一个WEB聊天室功能需求: 用户可以与好友一对一聊天可以搜索.添加某人为好友用户可以搜索和添加群每个群有管理员可以审批用户的加群请求,群管理员可以用多个,群管理员可以删除.添加. ...
Node.js+websocket+mongodb实现即时聊天室
ChatRoom Node.js+websocket+mongodb实现即时聊天室 A,nodejs简介:Node.js是一个可以让javascript运行在服务器端的平台,它可以让javascrip ...
基于 OpenResty 实现一个 WS 聊天室
基于 OpenResty 实现一个 WS 聊天室 WebSocket WebSocket 协议分析 WebSocket 协议解决了浏览器和服务器之间的全双工通信问题.在WebSocket出现之前,浏览 ...
Django中使用websocket并实现简易聊天室
django使用websocket并实现简易聊天室 django默认只支持http协议如果你想让django即支持http协议又支持websocket协议,则需要做以下配置前期配置前提需要安装c ...
如何利用WebSocket实现网页版聊天室
花了将近一周的时间终于完成了利用WebSocket完成网页版聊天室这个小demo,期间还走过了一段"看似弯曲"的道路,但是我想其实也不算是弯路吧,因为你走过的路必将留下你的足迹.这 ...
HTML5新特性 websocket(重点)--多对多聊天室
一.html5新特性 websocket(重点)--多对多聊天室 HTTP:超文本传输协议 HTTP作用:传输网页中资源(html;css;js;image;video;..) HTTP是浏览器搬运 ...
html5 WebSocket 与 PHP socket 聊天室原理
html js <!DOCTYPE html> <html lang="en"> <head> <meta charset="U ...

随机推荐

【转】关于DNS不得不说的一些事
转自:https://www.cnblogs.com/rjzheng/p/11395695.html 引言今天我们来聊聊DNS.所谓域名系统(Domain Name System缩写DNS,Doma ...
AOP的底层实现-CGLIB动态代理和JDK动态代理
AOP是目前Spring框架中的核心之一,在应用中具有非常重要的作用,也是Spring其他组件的基础.它是一种面向切面编程的思想.关于AOP的基础知识,相信多数童鞋都已经了如指掌,我们就略过这部分,来 ...
初识apache DBCP连接池
连接案例: 首先:我们使用的是mysql数据库,所以要有一个mysql和java的JDBCjar包: 然后是DBCP中的两个jar包,DBCP使用的话,需要两个包: dbcp.jar和pool.jar ...
T-SQL - 习题02_将数据表year|month|amount查询成year|m1|m2|m3|m4的样式
时间:2017-09-11 整理:byzqy 题目:有个年度统计表,结构如下: 怎么样把这个表,查询成这样一个结果: 这是在面试过程中遇到的一个关于数据库的题,没有一点思路,不知它考查到的知识点是什么 ...
Python中的列表、元组、字典、字符串及切片操作
我们引入一个新的概念:数据结构数据结构是通过某种方式组织在一起的数据元素的集合,这些数据元素可以是数字或字符,甚至可以是其他数据结构,在python中,最基本的数据结构是序列,序列中的每个元素匾被分 ...
mybaits源码分析--事务管理（八）
一.事务管理写到这也快进入收尾阶段了了,在介绍MyBatis中的事务管理时不可避免的要接触到DataSource的内容,所以接下来会分别来介绍DataSource和Transaction两块内容. ...
性能测试工具JMeter 基础（五）—— 测试元件：测试计划
测试计划的定义: 测试计划是测试脚本的容器,定义了要执行什么.怎么执行对测试做总体的设置,且都是从线程组开始执行在测试计划中可自定义用户变量(User Defined Variables),可通过A ...
Django——Paginator分页功能练习
1.路由urls.py from django.contrib import admin from django.urls import path from app01.views import in ...
shell脚本书写
#!/bin/bash #指定脚本默认使用的命令解释器第1行幻数 #!/usr/bin/python #!/bin/awk #!/bin/sed
Django使用tinymce富文本编辑器
1 - 安装 pip install django-tinymce==2.6.0 2 - 注册app INSTALLED_APPS = ( ... 'tinymce', ) 3 - 在setting中 ...

FastAPI（56）- 使用 Websocket 打造一个迷你聊天室

背景

模拟 WebSocket 客户端

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

发送聊天信息

可以在其他地方使用 WebSocket

在依赖项中使用 WebSocket

发送聊天信息

当 WebSocket 连接关闭时

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

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

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

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

随机推荐

热门专题