0

0

fastapi 如何实现 WebSocket 心跳与断线检测

冰川箭仙

冰川箭仙

发布时间:2026-01-27 18:26:03

|

284人浏览过

|

来源于php中文网

原创

WebSocket心跳不必由服务端主动发ping,但强烈建议如此;应使用await websocket.ping()发送原生ping帧,设间隔25–30秒、超时40–45秒,并在finally中统一清理资源。

fastapi 如何实现 websocket 心跳与断线检测

WebSocket 心跳必须由服务端主动发 ping 吗?

不是必须,但强烈建议由服务端发起 ping。FastAPI 的 WebSocket 底层基于 Starlette,它默认不自动处理 WebSocket ping/pong;客户端是否响应 ping、是否自动发 pong,取决于其实现(如浏览器 WebSocket API 会自动应答,但某些嵌入式客户端不会)。如果只靠客户端定时发 ping,服务端无法感知其是否已静默断连(比如网络中断后客户端未触发 onclose)。

实操建议:

  • websocket_endpoint 中启动一个后台任务(用 asyncio.create_task),每 15–30 秒调用 websocket.send_text('{"type":"ping"}') 或直接发 WebSocket ping 帧(见下一点)
  • 避免用 time.sleep(),必须用 await asyncio.sleep()
  • 心跳消息体建议用轻量协议(如纯字符串 "ping" 或最小 JSON),不要带时间戳或随机数——除非你真需要做 RTT 测量

如何发送原生 WebSocket ping 帧(非文本消息)?

HTTP 协议中 WebSocket ping/pong 是控制帧(opcode 0x9 / 0xA),和文本/二进制数据帧不同。用 send_text() 发的只是普通消息,不能触发底层连接保活机制。Starlette 的 WebSocket 对象提供了 ping() 方法,它会真正发送 opcode=0x9 的帧。

实操建议:

  • 直接调用 await websocket.ping() —— 这是最干净的心跳方式,不依赖消息解析逻辑
  • 注意:ping() 不抛异常不代表客户端在线;它只表示“发出去了”,收不到 pong 不会报错
  • 若需兼容老版本 Starlette(ping() 可能不存在,此时降级为发送文本 send_text("ping") 并在客户端约定响应 "pong"
  • 不要在 ping() 后立刻 await websocket.receive() 等 pong —— 这会阻塞,且 pong 帧不会出现在 receive 队列中(Starlette 自动处理)

如何检测客户端已断线并清理资源?

仅发 ping 不足以判断断连。关键是在接收端设置超时,并捕获 WebSocketDisconnect 或底层异常。FastAPI 不提供“ping 超时回调”,必须手动维护状态 + 超时检查。

AI神器大全
AI神器大全

AI工具集合导航站

下载

实操建议:

  • 用字典或 WeakKeyDictionary 记录每个 websocket 实例最后收到消息的时间(含 pong 响应或任意 receive_* 成功)
  • 心跳任务中检查该时间:若距今 > 45 秒,调用 await websocket.close(code=4001, reason="timeout") 并从记录中移除
  • 在主接收循环中(while True: await websocket.receive_text())用 try/except 捕获 WebSocketDisconnectRuntimeError(常见于客户端强制关闭 socket)
  • 务必在 finally 块中清理关联资源(如取消心跳 task、从连接池移除、释放数据库连接等)

为什么心跳间隔设为 30 秒却要容忍 45 秒断连?

这是为应对网络抖动与调度延迟留的余量。asyncio 任务调度不是实时的;WebSocket 底层 TCP 层可能重传;客户端处理 pong 也可能延迟。硬设“30 秒没 pong 就断”会导致误杀。

实操建议:

  • 心跳间隔(ping 频率)设为 25–30 秒,超时阈值设为 1.5× 间隔(即 40–45 秒)
  • 避免把超时阈值设得过长(如 120 秒)——这会让失效连接滞留太久,拖慢服务端连接数统计和内存释放
  • 如果业务要求极低延迟断连(如实时协作编辑),可缩短到 10 秒心跳 + 20 秒超时,但需压测确认服务端并发能力
  • 别忘了:Nginx / Cloudflare 等反向代理默认 60 秒 idle timeout,需同步调整其 proxy_read_timeouttimeout_idle

真正难的是状态一致性——心跳任务、接收循环、连接清理三者间没有原子协调机制,容易出现“task 还在跑但 websocket 已 close”的竞态。最稳妥的方式是用 asyncio.shield() 包裹清理逻辑,并在所有路径上统一用 websocket.client_state 判断是否仍可写。

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

通义千问
通义千问

阿里巴巴推出的全能AI助手

腾讯元宝
腾讯元宝

腾讯混元平台推出的AI助手

文心一言
文心一言

文心一言是百度开发的AI聊天机器人,通过对话可以生成各种形式的内容。

讯飞写作
讯飞写作

基于讯飞星火大模型的AI写作工具,可以快速生成新闻稿件、品宣文案、工作总结、心得体会等各种文文稿

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
nginx 重启
nginx 重启

nginx重启对于网站的运维来说是非常重要的,根据不同的需求,可以选择简单重启、平滑重启或定时重启等方式。本专题为大家提供nginx重启的相关的文章、下载、课程内容,供大家免费下载体验。

231

2023.07.27

nginx 配置详解
nginx 配置详解

Nginx的配置是指设置和调整Nginx服务器的行为和功能的过程。通过配置文件,可以定义虚拟主机、HTTP请求处理、反向代理、缓存和负载均衡等功能。Nginx的配置语法简洁而强大,允许管理员根据自己的需要进行灵活的调整。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

502

2023.08.04

nginx配置详解
nginx配置详解

NGINX与其他服务类似,因为它具有以特定格式编写的基于文本的配置文件。本专题为大家提供nginx配置相关的文章,大家可以免费学习。

499

2023.08.04

tomcat和nginx有哪些区别
tomcat和nginx有哪些区别

tomcat和nginx的区别:1、应用领域;2、性能;3、功能;4、配置;5、安全性;6、扩展性;7、部署复杂性;8、社区支持;9、成本;10、日志管理。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

233

2024.02.23

nginx报404怎么解决
nginx报404怎么解决

当访问 nginx 网页服务器时遇到 404 错误,表明服务器无法找到请求资源,可以通过以下步骤解决:1. 检查文件是否存在且路径正确;2. 检查文件权限并更改为 644 或 755;3. 检查 nginx 配置,确保根目录设置正确、没有冲突配置等等。本专题为大家提供相关的文章、下载、课程内容,供大家免费下载体验。

338

2024.07.09

Nginx报404错误解决方法
Nginx报404错误解决方法

解决方法:只需要加上这段配置:try_files $uri $uri/ /index.html;即可。想了解更多Nginx的相关内容,可以阅读本专题下面的文章。

3511

2024.08.07

nginx部署php项目教程汇总
nginx部署php项目教程汇总

本专题整合了nginx部署php项目教程汇总,阅读专题下面的文章了解更多详细内容。

27

2026.01.13

nginx配置文件详细教程
nginx配置文件详细教程

本专题整合了nginx配置文件相关教程详细汇总,阅读专题下面的文章了解更多详细内容。

29

2026.01.13

Python 自然语言处理(NLP)基础与实战
Python 自然语言处理(NLP)基础与实战

本专题系统讲解 Python 在自然语言处理(NLP)领域的基础方法与实战应用,涵盖文本预处理(分词、去停用词)、词性标注、命名实体识别、关键词提取、情感分析,以及常用 NLP 库(NLTK、spaCy)的核心用法。通过真实文本案例,帮助学习者掌握 使用 Python 进行文本分析与语言数据处理的完整流程,适用于内容分析、舆情监测与智能文本应用场景。

9

2026.01.27

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WEB前端教程【HTML5+CSS3+JS】
WEB前端教程【HTML5+CSS3+JS】

共101课时 | 8.5万人学习

JS进阶与BootStrap学习
JS进阶与BootStrap学习

共39课时 | 3.2万人学习

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

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号