讲师中心 微信公众号

工具推荐

视频效率加速
Seko
Seko

AI短剧一键生成成片

立刻MV
立刻MV

低成本歌曲 MV、视频生成

updream

一键生成高质量推广成片

剧云
剧云

中文短剧剧本制作平台

fastapi 如何实现 WebSocket 的 ping/pong 心跳机制

轻枫同学_5886

轻枫同学_5886

发布时间:2026-01-26 19:38:02

|

698人浏览过

|

来源于php中文网

原创

FastAPI WebSocket 默认不自动处理 ping/pong,需手动调用 websocket.ping() 并配合定时任务每20–30秒发送一次;同时须配置 Nginx proxy_read_timeout 与心跳间隔对齐,并确保 WebSocket 升级头正确设置。

fastapi 如何实现 websocket 的 ping/pong 心跳机制

FastAPI 的 WebSocket 默认不自动处理 ping/pong

FastAPI 基于 Starlette 实现 WebSocket,底层使用 websockets 库,但 WebSocketEndpoint 或 websocket_route 并不会自动响应 ping 帧(opcode 9)或发送 pong(opcode 10)。浏览器或客户端发来的 ping 不会被自动回 pong,长时间无数据交互时连接容易被中间代理(如 Nginx、Cloudflare)或防火墙断开。

必须手动调用 websocket.ping() 触发心跳

Starlette 的 WebSocket 对象提供了 ping() 方法,但它是**单向触发发送 pong 帧**的工具,不是周期性心跳开关。它不接收参数,也不自动重试,且仅在连接活跃时有效。常见错误是误以为调用一次就能“开启心跳”——实际必须配合定时任务反复调用。

实操建议:

  • 使用 asyncio.create_task() 启动一个后台心跳协程,每 20–30 秒调用一次 websocket.ping()
  • 务必在 try/except 中包裹 ping() 调用,捕获 ConnectionClosed 或 RuntimeError(例如连接已关闭时调用会抛异常)
  • 避免在 websocket.receive_text() 等阻塞等待前才发 ping —— 心跳应独立运行,不能依赖业务消息驱动

客户端 ping 和服务端 pong 的分工要明确

WebSocket 协议中,ping/pong 是对称机制:任意一端可发 ping,另一端需回应 pong。但实践中更可靠的做法是「服务端主动 ping,客户端自动 pong」,因为:

JSON Toolkit
JSON Toolkit

JSON文件多功能工具。支持格式化、验证、压缩、键排序及点记法路径查询。零依赖。

下载
  • 现代浏览器和主流 WebSocket 客户端(如 JS WebSocket、ws npm 包)都内置自动 pong 响应逻辑,无需额外代码
  • 服务端可控性强;而依赖客户端定时 ping 容易因前端页面失焦、JS 被节流等原因失效
  • Nginx 等反向代理通常只检查服务端是否活跃,对客户端 ping 不敏感

示例心跳协程片段:

async def _send_ping(websocket: WebSocket):
    while True:
        try:
            await websocket.ping()
        except (ConnectionClosed, RuntimeError):
            break
        await asyncio.sleep(25)

在 connect 后立即启动:asyncio.create_task(_send_ping(websocket))

注意 Nginx 和超时配置的协同

即使 FastAPI 正确发送了 ping,若 Nginx 的 proxy_read_timeout 小于 ping 间隔,连接仍会被断开。典型错误配置:

  • Nginx 默认 proxy_read_timeout 60,但服务端 ping 间隔设为 45 秒 → 中间空窗期可能超时
  • 未设置 proxy_set_header Upgrade $http_upgrade 和 proxy_set_header Connection "upgrade",导致 WebSocket 升级失败,ping/pong 根本不走 WebSocket 通道
  • Cloudflare 免费版强制 100 秒闲置断连,此时 ping 间隔必须 ≤ 85 秒,且需开启 “WebSockets” 开关

关键点:服务端 ping 间隔、Nginx proxy_read_timeout、客户端保活逻辑三者必须严格对齐,差 5 秒都可能导致静默掉线。

热门AI工具

更多
码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

WorkBuddy

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

立刻MV
立刻MV Hot

立刻MV是一款AI文本写作工具,AI 音乐视频(MV)创作工具。

Atoms
Atoms Hot

Atoms是一款AI智能体工具,第一支自动构建真实业务的 AI 团队。

DeepSeek

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

豆包大模型

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

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

Lovart
Lovart Hot

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

小橡皮AI

一款AI工具,主要用于小橡皮一键去AI味,将机器味重的内容改得更有活人感,防止因为 AI 内容被平台打上 AI 标签,以及限流,适合需要提升相关任务效率的用户。

相关专题

更多
nginx 重启
nginx 重启

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

423

2023.07.27

nginx 配置详解
nginx 配置详解

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

4207

2023.08.04

nginx配置详解
nginx配置详解

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

7105

2023.08.04

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

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

601

2024.02.23

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

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

1516

2024.07.09

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

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

3998

2024.08.07

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

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

122

2026.01.13

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

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

577

2026.01.13

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

20

2026.11.12

热门下载

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

精品课程

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

共101课时 | 21.3万人学习

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

共39课时 | 4.9万人学习

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

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