FastAPI WebSocket：你的双向通信通道为何如此丝滑？

扫描二维码

关注或者微信搜一搜：编程智域前端至全栈交流与成长

发现1000+提升效率与开发的AI工具和实用程序：https://tools.cmdragon.cn/

# 示例代码运行环境

# Python 3.8+

# 安装依赖：pip install fastapi==0.68.0 uvicorn==0.15.0 websockets==10.3 pydantic==1.10.7

一、WebSocket路由声明规范

1.1 基础路由定义

使用@app.websocket装饰器声明WebSocket路由：

from fastapi import FastAPI, WebSocket

app = FastAPI()

@app.websocket("/ws/chat/{room_id}")

async def websocket_chat(websocket: WebSocket, room_id: int):

    await websocket.accept()

    try:

        while True:

            data = await websocket.receive_text()

            await websocket.send_text(f"Room {room_id}: {data}")

    except WebSocketDisconnect:

        print("Client disconnected")

关键要点解析：

路径参数通过URL直接传递（如{room_id}）
WebSocket对象自动注入到路由函数
必须显式调用await websocket.accept()建立连接
receive_text()和send_text()实现双向通信

1.2 路由参数验证

结合路径参数与查询参数进行复合验证：

from fastapi import Query, WebSocket

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

async def secure_ws(

        websocket: WebSocket,

        client_id: int = Path(..., gt=0),

        token: str = Query(..., min_length=8)

):

    if not validate_token(token):

        await websocket.close(code=1008)

        return

    # ...连接处理逻辑...

二、客户端连接建立与握手验证

2.1 握手过程控制

自定义握手验证流程：

@app.websocket("/ws/auth")

async def auth_ws(websocket: WebSocket):

    # 手动控制握手过程

    await websocket.accept()

    # 获取握手时的请求头

    headers = websocket.headers

    auth_token = headers.get("authorization")

    if not verify_jwt_token(auth_token):

        await websocket.close(code=1008, reason="Invalid credentials")

        return

    # 验证通过后的处理逻辑

2.2 验证失败处理模式

graph TD
A[客户端请求连接] --> B{验证Headers}
B -- 成功 --> C[返回101状态码]
B -- 失败 --> D[返回403状态码]
C --> E[建立双向通信]
D --> F[关闭TCP连接]

三、连接状态维护与生命周期管理

3.1 连接状态跟踪

使用字典维护活跃连接：

from typing import Dict

active_connections: Dict[str, WebSocket] = {}

@app.websocket("/ws/status")

async def status_ws(websocket: WebSocket):

    await websocket.accept()

    client_id = str(websocket.client)

    active_connections[client_id] = websocket

    try:

        while True:

            # 保持连接活跃

            await websocket.receive_text()

    except WebSocketDisconnect:

        del active_connections[client_id]

3.2 心跳检测机制

import asyncio

async def heartbeat(websocket: WebSocket, interval: int = 30):

    try:

        while True:

            await asyncio.sleep(interval)

            await websocket.send_json({

                "type": "heartbeat",

                "timestamp": time.time()

            })

    except WebSocketDisconnect:

        print("Heartbeat terminated")

@app.websocket("/ws/realtime")

async def realtime_ws(websocket: WebSocket):

    await websocket.accept()

    # 启动独立心跳任务

    heartbeat_task = asyncio.create_task(heartbeat(websocket))

    try:

        # 主消息处理循环

        while True:

            data = await websocket.receive_json()

            # 处理业务逻辑...

    finally:

        heartbeat_task.cancel()

        await websocket.close()

课后 Quiz

当客户端发送非文本格式数据时如何处理？

# 正确处理方法

try:

    data = await websocket.receive_json()

except WebSocketDisconnect:

# 处理断开逻辑

except ValueError:

    await websocket.send_text("ERROR: 仅支持JSON格式")

# 错误处理方法：直接使用未校验的receive()

如何获取客户端的真实IP地址？

# 正确方法

client_ip = websocket.client.host

# 常见错误：直接读取X-Forwarded-For头

# 需要配合代理设置处理

常见报错解决方案

错误1：403 Handshake Failed

现象：客户端连接时立即断开

分析：未通过握手验证，常见于：

缺少必要认证头
验证逻辑返回False后未及时close()

解决：

# 在拒绝连接时立即关闭

if not valid:

    await websocket.close(code=1008)

    return  # 必须立即返回

错误2：1006 Abnormal Closure

现象：客户端非正常断开

处理方案：

try:

    while True:

        data = await websocket.receive_text()

except WebSocketDisconnect as e:

    print(f"断开代码：{e.code}")

错误3：TypeError: 'str' expected

场景：发送非文本数据时

正确做法：

# 发送二进制数据

await websocket.send_bytes(binary_data)

# 发送文本数据

await websocket.send_text("message")

# 发送JSON

await websocket.send_json({"key": "value"})

余下文章内容请点击跳转至个人博客页面或者扫码关注或者微信搜一搜：编程智域前端至全栈交流与成长

，阅读完整的文章：如何在FastAPI中玩转WebSocket，让实时通信不再烦恼？

往期文章归档：

免费好用的热门在线工具

FastAPI WebSocket：你的双向通信通道为何如此丝滑？的更多相关文章

happyChat开发系列：使用websocket.io实现双向通信的乐聊大前端开发
一.前言乐聊是一个自己用websocket写一个完整的应用,虽然功能比较欠缺,但是实现了基本的文字聊天,以及群聊,私聊,机器人聊天等功能.因为这个自己做了PC端,无线端(手机端),以及使用cordo ...
FastAPI（56）- 使用 Websocket 打造一个迷你聊天室
背景在实际项目中,可能会通过前端框架使用 WebSocket 和后端进行通信这里就来详细讲解下 FastAPI 是如何操作 WebSocket 的模拟 WebSocket 客户端 #!usr/b ...
WebSocket 浅析
版权声明:本文由史燕飞原创文章,转载请注明出处: 文章原文链接:https://www.qcloud.com/community/article/241 来源:腾云阁 https://www.qclo ...
【腾讯Bugly干货分享】WebSocket 浅析
本文来自于腾讯Bugly公众号(weixinBugly),未经作者同意,请勿转载,原文地址:http://mp.weixin.qq.com/s/7aXMdnajINt0C5dcJy2USg 前言在W ...
websocket的子协议stomp协议
stomp协议Spring实现服务器注册EndPoint 用来与客户端建立websocket连接 websocket连接的建立应该与客户端与服务器之间的通道无关 jdk中 javax下的websoc ...
websocket基本概念
(1)websocket 协议与 http协议 websocket 协议,双工通道 socket连接不断开 http 协议 ,只能请求响应 (用户主动获取) socket连接断开都是基于socke ...
Spring Chapter4 WebSocket 胡乱翻译（二）
书接上文,Spring Chapter4 WebSocket 胡乱翻译 (一) 4.4.4. 消息流一旦暴露了STOMP端点,Spring应用程序就成为连接客户端的STOMP代理. 本节介绍服务器端 ...
HTML5(十二)——一文读懂 WebSocket 原理
一.WebSocket 由来 WebSocket 是一个持久化的协议,通过第一次 HTTP Request 建立连接之后,再把通信协议升级成 websocket,保持连接状态,后续的数据交换不需要再重 ...
JAVA使用netty建立websocket连接
依赖  <dependency> <gr ...
FastAPI快速查阅
官方文档主要侧重点是循序渐进地学习FastAPI, 不利于有其他框架使用经验的人快速查阅故本文与官方文档不一样, 并补充了一些官方文档没有的内容安装包括安装uvicorn $pip instal ...

随机推荐

【SpringCloud】SpringCloud Alibaba Nacos服务注册和配置中心
SpringCloud Alibaba Nacos服务注册和配置中心感悟注意:凡是cloud里面,你要开哪个组件,新加哪个注解,第一个就是启动,如@EnableFeignClients,第二个就是 ...
Linux系统中的目录和文件夹的区别
Linux系统中的目录和文件夹的区别目录 Linux系统中的目录和文件夹的区别一.概念与术语背景 1.目录(Directory) 2.文件夹(Folder) 二.技术实现差异 1.存储内容 2.权 ...
datasnap的监督功能【2】-管理Session
1.服务端的Session是有TDSSession定义的.TDSSession提供了许多有用的方法和特性,再开发室取得服务or重要信息. 如Session状态.安排Session独享定时or自动执行工 ...
4G模块详解
在之前的教程中,无线通信技术我们学习了蓝牙和 WiFi,今天我们要来学习 4G. 4G 模块在距离上有个突破,它不像蓝牙短距离,也不像 WiFi 只能在局域网,4G 模块可使用户无论在哪,只要有 4G ...
java的打包(JAR、War)
一.Error assembling WAR: webxml attribute is required (or pre-existing WEB-INF/web.xml if executing i ...
java基础之继承，抽象类
一.继承 :就是子类继承父类的非私有属性和行为二.特点 1.子类和父类中出现了同名的成员变量时,在子类中需要访问父类中非私有成员变量时,需要使用 super 关键字格式:super.父类成员变量名 ...
Google Adsense中文设置
1. 入口 https://www.google.com/adsense 2. 菜单 Account -> settings -> Personal settings 3. 切换语言 Di ...
Eclipse 安装---windows10环境下
Eclipse 安装---windows10环境下一.下载 1.前往eclipse官网下载 https://www.eclipse.org/downloads/ 2.选择类型(压缩包) 3.选择版本 ...
DPDI(Dispatch PDI)kettle调度管理平台之实操演练第001讲--手工调度本地PDI任务生成日期维度数据
DPDI实操演练第一讲 1.DPDI简介 DPDI Online 您的智能ETL任务调度专家 DPDI Online 是一款基于Kettle的强大在线任务调度平台,凭借其高效与灵活性,专为调度和监控K ...
kettle使用MD5加密增量获取接口数据
kettle使用MD5加密增量获取接口数据场景介绍: 使用JavaScript组件进行MD5加密得到Http header,调用API接口增量获取接口数据,使用json input组件解析数据入库 ...