FastAPI怎么配置WebSocket实现实时消息推送

梦杰同学_3953

梦杰同学_3953

2026-11-17

732人浏览

原创

FastAPI原生支持WebSocket,无需额外配置,关键在正确使用@app.websocket()装饰器、显式调用await websocket.accept()、手动实现心跳及协程安全的连接管理。

fastapi怎么配置websocket实现实时消息推送

直接上结论:FastAPI 本身不需额外配置就能跑 WebSocket,关键在路由声明、连接生命周期管理、以及避免常见异步陷阱。它依赖 Starlette 的 WebSocket 类和 ASGI 协议支持,不是插件也不是扩展——只要用对 API,连接就通了。

怎么写一个最简可用的 WebSocket 路由

核心是用 @app.websocket() 装饰器,参数必须是 websocket: WebSocket,且函数体必须是 async def。不能用 def,否则会报 RuntimeError: Expected coroutine function。

必须显式调用 await websocket.accept() 才算握手成功;漏掉这句,前端 new WebSocket() 会卡在 connecting 状态,控制台显示 Failed to connect。

  • 接收文本消息用 await websocket.receive_text(),二进制用 await websocket.receive_bytes()
  • 发送文本用 await websocket.send_text(),二进制用 await websocket.send_bytes()
  • 关闭连接推荐用 await websocket.close(code=1000),避免直接抛异常导致连接残留

为什么 WebSocket 连接会莫名其妙断开

绝大多数“自动断开”不是代码 bug,而是网络中间件(如 Nginx、Cloudflare)或客户端浏览器主动踢掉空闲连接。默认情况下,WebSocket 没有心跳,TCP 层的 keepalive 通常不生效,中间代理会在 60–300 秒后静默关闭连接。

解决办法是手动加心跳:服务端定期发 ping(用 await websocket.ping()),客户端收到后回 pong;或者双方约定业务层心跳包(比如每 25 秒发一次 {"type": "ping"})。别只在服务端发,不处理客户端的响应,否则无法判断对方是否还活着。

fastapi-pro
fastapi-pro

使用 FastAPI、SQLAlchemy 2.0 和 Pydantic V2 构建高性能异步 API。精通微服务、WebSocket 和现代 Python 异

下载
  • Nginx 需要显式配置 proxy_read_timeout 300; 和 proxy_set_header Upgrade $http_upgrade; 等头字段
  • 浏览器 tab 切到后台时,setInterval 可能被节流,心跳间隔拉长,容易触发超时
  • FastAPI 的 WebSocket 实例不是线程安全的,不能跨任务共享(比如在后台任务里直接调用 send_text)

怎么让多个客户端之间广播消息

FastAPI 没内置连接池,得自己管。最常用的是维护一个全局 set 或 list 存活的 WebSocket 实例,但要注意:这个集合必须是线程/协程安全的,且每个连接断开时必须及时清理,否则内存泄漏+消息发错人。

推荐用 asyncio.Lock 包裹增删操作,或改用 weakref.WeakSet 自动回收已关闭的连接对象。别用普通 dict 存连接并靠 id(websocket) 当 key——WebSocket 对象销毁后 id 可能复用,导致误判。

  • 广播前先检查 websocket.client_state == WebSocketState.CONNECTED,跳过已断开的连接
  • 发送失败(如 ConnectionClosedOK 异常)时,必须从集合中移除该连接
  • 多进程部署时,这个集合只在单个 worker 内有效;跨进程广播需引入 Redis Pub/Sub 或消息队列

真正麻烦的从来不是“怎么连上”,而是“连上之后怎么不丢、不乱、不崩”。连接数一上去,异常分支、并发写入、进程隔离这些点,比写第一个 send_text 花的时间多十倍。

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

相关文章

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

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

下载

相关标签:

websocket fastapi

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

相关专题

更多
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

2025.12.22

119

5

Python 微服务架构与 FastAPI 框架
Python 微服务架构与 FastAPI 框架

本专题系统讲解 Python 微服务架构设计与 FastAPI 框架应用,涵盖 FastAPI 的快速开发、路由与依赖注入、数据模型验证、API 文档自动生成、OAuth2 与 JWT 身份验证、异步支持、部署与扩展等。通过实际案例,帮助学习者掌握 使用 FastAPI 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

2026.02.06

594

18

Python Web框架FastAPI 全栈开发教程合集
Python Web框架FastAPI 全栈开发教程合集

以 FastAPI 为核心,讲解现代 Python Web API 的高效开发方式,涵盖路由定义与路径参数/查询参数/请求体绑定、Pydantic 模型的数据校验与序列化、依赖注入(Depends)系统的分层设计、中间件与 CORS 配置、OAuth2 + JWT 认证流程、后台任务(BackgroundTasks)、WebSocket 实时通信、SQLAlchemy 异步 ORM 集成、自动生成 OpenAPI/Swagger 交互文

2026.05.09

776

23

Python FastAPI异步微服务与高性能接口设计
Python FastAPI异步微服务与高性能接口设计

本专题聚焦 Python FastAPI 框架在高性能接口与微服务开发中的应用,讲解异步请求处理、依赖注入机制、路由设计、数据库异步操作以及接口性能优化策略。结合实际项目案例,帮助开发者构建高并发、低延迟的现代化后端服务架构。

2026.06.16

679

12

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

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

2026.11.12

140

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

100

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

60

15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

160

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

140

13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
WebSocket手册
WebSocket手册

共0课时 | 0人学习

Webman中文手册
Webman中文手册

共0课时 | 0人学习