讲师中心 微信公众号
AI工具推荐 视频效率加速

FastApi实现WebSocket教程 Python异步Web框架集成WebSocket【实战】

秋萱吖_2835

秋萱吖_2835

发布时间:2026-05-28 06:54:35

|

376人浏览过

|

来源于php中文网

原创

BackgroundTasks 在 FastAPI 的 WebSocket 路由中完全失效,因其依赖 HTTP 请求结束的生命周期节点,而 WebSocket 是无响应体的长连接,缺乏触发上下文;必须改用 asyncio.create_task() 启动独立协程,并手动处理异常、复用客户端及连接状态校验。

fastapi实现websocket教程 python异步web框架集成websocket【实战】

BackgroundTasks 在 FastAPI 的 WebSocket 路由里完全不生效——这不是配置问题,是设计使然。WebSocket 连接没有“请求结束”这个生命周期节点,BackgroundTasks 依赖的 Request 上下文根本不存在,调用 add_task() 后函数静默不执行,连日志都不会打。

为什么 BackgroundTasks 在 @app.websocket 中失效

FastAPI 的 BackgroundTasks 是为 HTTP 请求流设计的:它在响应已生成、但连接尚未关闭的瞬间触发任务。而 WebSocket 是长连接,websocket.accept() 之后连接持续存在,整个过程不返回 HTTP 响应体,BackgroundTasks 的触发机制彻底失联。

你写的异步函数(比如调用外部 API 或订阅 Redis)如果只是塞进 background_tasks.add_task(...),它永远不会运行。

  • 不是语法错,不是漏 await,是根本没注册进事件循环
  • WebSocketDisconnect 异常捕获再完善也救不了它——任务压根没启动
  • 本地测试可能“看似有效”,那通常是协程被意外 await 了(比如误写成 await func()),但这会阻塞主连接循环,导致消息收发卡顿

必须用 asyncio.create_task() 启动真正后台协程

这是唯一可靠的方式:把协程直接提交到当前事件循环,和 WebSocket 主循环并行跑,互不阻塞。

立即学习“Python免费学习笔记(深入)”;

python学习
python学习

Python 编程学习助手 skill,面向零基础用户。 当用户表达以下意图时触发: - 学习 Python 基础概念(变量、数据类型、循环、函数、类等) - 请求 Python 练习题或测验 - 请求审查或调试 Python 代码 - 请求 Python 项目实战指导(爬虫、数据分析、Web 开发等入门项目) - 泛化表述如"教我 Python""我想学编程""Python 怎么写""帮我学 Python" 此 skill

下载

关键点:

  • 必须显式 await websocket.accept() 后再创建任务,否则连接未建立就发消息会报错
  • 任务内部要自己处理异常,否则崩溃后无声退出(建议包 try/except + logging.error)
  • 不要在任务里反复创建新 HTTP 客户端(如 aiohttp.ClientSession()),应复用单例或通过依赖注入传入
  • 如果任务需要向该 WebSocket 发送消息,得确保连接仍活跃——不能只靠 websocket.send_text(),要捕获 WebSocketDisconnect 并主动取消任务

示例片段:

import asyncio
from fastapi import WebSocket, WebSocketDisconnect
<p>@app.websocket("/ws/{user_id}")
async def ws_endpoint(websocket: WebSocket, user_id: str):
await websocket.accept()</p><pre class="brush:php;toolbar:false;"># 启动后台任务:监听 Redis Pub/Sub
task = asyncio.create_task(
    listen_redis_and_forward(websocket, user_id)
)

try:
    while True:
        data = await websocket.receive_text()
        # 处理客户端发来的指令
        await handle_user_message(data, user_id)
except WebSocketDisconnect:
    task.cancel()  # 主动取消后台任务
    try:
        await task
    except asyncio.CancelledError:
        pass

WebSocket 连接管理中容易被忽略的边界情况

真实部署时,以下几点比“能连上”更重要:

  • websocket.receive_text() 和 websocket.receive_bytes() 会阻塞等待,如果客户端断网但 TCP 连接未及时关闭(如 NAT 超时),服务端会一直挂起;建议加 asyncio.wait_for(..., timeout=30)
  • 多个客户端共用一个连接管理器(如 ConnectionManager)时,send_text() 抛出 WebSocketDisconnect 不代表连接已从集合中移除,必须在 except 块里手动 .remove()
  • Uvicorn 默认单 worker,WebSocket 连接无法跨进程广播;要做群聊或广播,必须引入 Redis 或其他共享状态后端
  • 前端页面刷新或网络闪断,会导致重复连接;服务端若不做 client_id 去重或 session 绑定,可能产生脏数据或资源泄漏

WebSocket 的难点不在“怎么写第一个 echo”,而在连接长期存活下的资源清理、异常传播、并发安全和跨实例协调——这些细节不处理,上线后就是内存缓慢增长、任务静默丢失、消息偶尔不达。

热门AI工具

更多
VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

Seko
Seko Hot

一款AI视频创作工具,主要用于商汤科技推出的创编一体的AI短视频创作Agent,适合需要提升相关任务效率的用户。

讯飞智作

讯飞智作是一款AI视频创作工具,AI文本配音工具,数字人课程、营销视频制作。

Lovart
Lovart Hot

一款面向视觉设计创作的AI设计平台,可通过智能体和画布工作流辅助制作海报、Logo、网页、PPT及其他视觉内容。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1791

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

4684

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1749

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

27777

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3347

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3347

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1203

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

596

2023.08.10

Gradle插件开发入门教程
Gradle插件开发入门教程

本专题介绍Gradle插件开发的基本流程,涵盖插件类编写、自定义任务注册、扩展参数设计和插件应用方法,帮助你理解插件如何组织构建逻辑,减少多个项目之间的重复配置。

0

2026.10.22

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn