FastAPI集成WebSocket教程 异步接收前端消息代码示例【技术】

酷雪大大_6730

酷雪大大_6730

2026-06-02

262人浏览

原创

websocket端点必须用async def声明,因运行在事件循环中,所有i/o操作(如receive_text、send_text)均需异步;漏写async或误用同步调用会阻塞整个连接。

fastapi集成websocket教程 异步接收前端消息代码示例【技术】

WebSocket端点必须用 async def 声明

FastAPI 的 WebSocket 路由不是普通函数,它运行在事件循环中,所有 I/O 操作(如 receive_text()、send_text())都必须是异步的。写成同步函数会导致阻塞整个连接,甚至让其他 WebSocket 客户端卡住。

常见错误是漏掉 async 关键字,或在 try/except 外部调用 await —— 这会直接抛出 SyntaxError: await outside async function。

  • 正确写法:@app.websocket("/ws") 后跟 async def websocket_endpoint(websocket: WebSocket):
  • 必须先调用 await websocket.accept(),否则客户端会收到 403 或连接立即关闭
  • WebSocketDisconnect 异常必须显式捕获,不能靠全局异常处理器兜底,否则连接不会被清理

receive_text() 和 receive_bytes() 别混用

前端发 JSON 字符串,后端就用 receive_text();发 ArrayBuffer 或 Blob(比如上传二进制帧),就用 receive_bytes()。混用会导致 WebSocketException: cannot decode bytes as utf-8 或静默丢包。

实际项目里,多数聊天场景走文本,但实时音视频信令、模型 token 流、设备原始传感器数据往往走二进制。别为了“统一”硬转 str(data) —— 那会破坏字节完整性。

  • 文本消息:前端 socket.send(JSON.stringify({msg: "hi"})) → 后端 data = await websocket.receive_text()
  • 二进制消息:前端 socket.send(new Uint8Array([1,2,3])) → 后端 data = await websocket.receive_bytes()
  • 若需兼容两种类型,得先 receive() 获取原始 WebSocketMessage,再判 type 字段

广播消息时别直接遍历 active_connections 列表

看似简单的 for conn in active_connections: await conn.send_text(...) 在高并发下容易出问题:某个连接已断开但还没来得及从列表移除,send_text() 就会抛 WebSocketDisconnect,进而中断整个 for 循环,导致后续连接收不到消息。

Claw Code Suite (Python-Only Edition)
Claw Code Suite (Python-Only Edition)

仅使用 Python 将 Claw Code 虚拟化框架与 OpenClaw 集成,提供 184 种工具和 200 多条命令,用于安全分析和代码质量...

下载

更稳妥的做法是用 asyncio.create_task() 并发发送,并单独处理每个连接的异常。

  • 不要用裸列表遍历广播;改用 asyncio.gather(*[conn.send_text(msg) for conn in connections], return_exceptions=True)
  • 连接管理建议封装成类(如 ConnectionManager),在 disconnect() 中用 remove() + try/except 双保险
  • 记得在 WebSocketDisconnect 捕获块里调用 manager.disconnect(websocket),否则内存泄漏会随连接数线性增长

生产环境必须设 ping_interval 和超时参数

本地调试时连接能一直挂着,但真实网络存在 NAT 超时、代理中断、移动网络切换等场景。不主动 ping,连接可能“假活”——服务端以为在线,其实客户端早已断开。

Uvicorn 默认不启用 ping,得靠 FastAPI 层或 WebSocket 库自己补。最简单的是在 websocket.accept() 后手动启一个心跳任务,或者用 websockets 库的 ping_interval 参数(需替换默认 transport)。

  • 推荐做法:在 connect() 后启动 asyncio.create_task(ping_loop(websocket)),每 30 秒发一次 ping
  • 设置 websocket.iter_text(timeout=60) 或自定义 receive() 超时,避免单个连接长期阻塞
  • 注意:uvicorn 的 --timeout-keep-alive 是 HTTP 连接参数,对 WebSocket 无效

真正麻烦的从来不是写通第一行 await websocket.receive_text(),而是连接状态怎么精准感知、异常怎么不扩散、广播怎么不丢人。这些细节没压到代码里,上线后就会变成凌晨三点的报警电话。

大量免费API接口:立即使用
涵盖生活服务API、金融科技API、企业工商API、等相关的API接口服务。免费API接口可安全、合规地连接上下游,为数据API应用能力赋能!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

fastapi websocket python 前端

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2543

5

前端如何实现即时通讯
前端如何实现即时通讯

实现即时通讯的方法有WebSocket、Long Polling、Server-Sent Events、WebRTC等等。详细介绍:1、WebSocket,它可以在客户端和服务器之间建立持久连接,实现实时的双向通信,前端可以使用 WebSocket API来创建WebSocket连接,并通过发送和接收消息来实现即时通讯;2、Long Polling,是一种模拟实时通信的技术等等。

2023.10.09

5483

6

前端和后端的区别
前端和后端的区别

前端关注的是用户界面的设计和交互,而后端则注重数据处理和逻辑控制。想了解更多前端后端的相关内容,可以阅读本专题下面的文章。

2024.03.19

6490

13

php和前端的关联介绍
php和前端的关联介绍

php既可以作为前端语言,也可以作为后端语言。想了解更多php和前端的相关内容,可以阅读本专题下面的文章。

2024.03.22

6138

10

前端外包工作内容有哪些
前端外包工作内容有哪些

前端外包工作内容包括:1. 网站和应用程序开发;2. 用户界面和交互设计;3. 用户体验优化;4. 设计和视觉开发;5. 跨浏览器兼容性;6. 性能优化;7. 维护和更新;8. 项目管理和沟通。想了解更多前端的相关内容,可以阅读本专题下面的文章。

2024.05.22

863

5

C语言变量命名
C语言变量命名

c语言变量名规则是:1、变量名以英文字母开头;2、变量名中的字母是区分大小写的;3、变量名不能是关键字;4、变量名中不能包含空格、标点符号和类型说明符。php中文网还提供c语言变量的相关下载、相关课程等内容,供大家免费下载使用。

2023.06.20

3229

3

c语言入门自学零基础
c语言入门自学零基础

C语言是当代人学习及生活中的必备基础知识,应用十分广泛,本专题为大家c语言入门自学零基础的相关文章,以及相关课程,感兴趣的朋友千万不要错过了。

2023.07.25

2328

9

c语言运算符的优先级顺序
c语言运算符的优先级顺序

c语言运算符的优先级顺序是括号运算符 > 一元运算符 > 算术运算符 > 移位运算符 > 关系运算符 > 位运算符 > 逻辑运算符 > 赋值运算符 > 逗号运算符。本专题为大家提供c语言运算符相关的各种文章、以及下载和课程。

2023.08.02

1260

5

c语言数据结构
c语言数据结构

数据结构是指将数据按照一定的方式组织和存储的方法。它是计算机科学中的重要概念,用来描述和解决实际问题中的数据组织和处理问题。数据结构可以分为线性结构和非线性结构。线性结构包括数组、链表、堆栈和队列等,而非线性结构包括树和图等。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.09

1218

4

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
FastAPI SQL数据库实战文档
FastAPI SQL数据库实战文档

共0课时 | 0人学习

FastAPI官方教程文档
FastAPI官方教程文档

共0课时 | 0人学习