Starlette如何实现WebSocket广播消息

浅明大大_2362

浅明大大_2362

2026-11-20

840人浏览

原创

starlette 实现 websocket 广播消息的核心做法是维护一个全局或应用级的连接集合,在客户端建立连接时将其加入集合,断开时移除。通过遍历该集合并调用每个连接的 send_json 方法,即可将消息推送给所有在线用户。

Starlette如何实现WebSocket广播消息

如何管理 WebSocket 连接的生命周期

要实现广播,第一步是确保能准确追踪当前有哪些客户端处于连接状态。这通常通过定义一个全局列表或在 App 实例上挂载属性来实现。在路由处理函数中,当收到 websocket.connect() 信号后,立即将当前 scope 或连接对象存入集合;当捕获到 websocket.close() 异常或显式关闭时,从集合中移除该对象。这种机制保证了广播目标始终是当前活跃的客户端列表。

Starlette如何实现WebSocket广播消息

from starlette.applications import Starlette
from starlette.routing import Route
from starlette.websockets import WebSocket
import asyncio

# 全局连接集合
connections = set()

async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()
    connections.add(websocket)
    try:
        while True:
            data = await websocket.receive_text()
            # 广播逻辑见下一节
            for conn in list(connections):
                await conn.send_text(f"Echo: {data}")
    except Exception as e:
        print(f"Connection lost: {e}")
    finally:
        connections.discard(websocket)
        await websocket.close()

app = Starlette(routes=[
    Route("/ws", websocket_endpoint, methods=["GET"])
])

运行上述代码,启动服务后使用两个 WebSocket 客户端连接 /ws,发送消息后双方均会收到回显。预期结果为:客户端 A 发送 "Hello",客户端 B 和 A 均收到 "Echo: Hello"。若客户端断开,其连接将从 connections 集合中移除,不再接收后续消息。

如何实现向所有客户端广播特定消息

在连接管理的基础上,广播的具体实现依赖于遍历集合。需要注意的是,由于需要修改集合(在循环中可能因断连导致变化),最佳实践是使用 list(connections) 创建副本进行遍历,避免在迭代过程中修改集合引发运行时错误。此外,应使用异步发送以支持高并发场景,确保单个客户端的网络延迟不会阻塞其他客户端的消息发送。

Websocket Hub Patterns
Websocket Hub Patterns

可水平扩展的 WebSocket 中心模式,支持懒加载 Redis 订阅、连接注册表和优雅关闭。适用于构建可跨多实例扩展的实时 WebSocket 服务器。

下载

Starlette如何实现WebSocket广播消息

# 假设已在主逻辑中接收到需广播的消息
broadcast_message = "System Update"
for conn in list(connections):
    try:
        await conn.send_text(broadcast_message)
    except Exception:
        # 如果发送失败,说明连接已失效,可安全移除
        connections.discard(conn)

此段代码展示了广播的核心循环。预期结果:所有在 connections 中的客户端都会收到 "System Update" 文本。若某个连接在发送前已断开,send_text 会抛出异常,此时通过 discard 清理无效连接,保证集合的整洁性。这种模式适用于聊天室、实时通知等场景。

当客户端发送心跳包时如何处理以保持连接活跃

在实际部署中,网络中间件可能会因空闲超时切断 WebSocket 连接。为保持连接活跃,可在 receive_text 循环中增加对心跳消息的判断。例如,约定客户端定期发送 "ping" 字符串,服务端收到后回复 "pong" 而不触发业务广播逻辑。这样既维持了连接状态,又避免了无意义的数据广播。若长时间未收到心跳,可主动关闭连接并从集合中移除,防止僵尸连接占用资源。

相关文章

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

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

下载

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系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

614

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

796

23

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

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

2026.06.16

699

12

Nginx CVE-2026-123007排查与防护指南
Nginx CVE-2026-123007排查与防护指南

Nginx HTTP/2漏洞该怎么修复?本专题围绕CVE-2026-123007,介绍安全版本升级、模块兼容检查和配置恢复方法,以及日志排查、权限设置等后续加固操作,方便你按实际部署情况查找对应教程。

2026.11.20

0

8

GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

2026.11.17

20

15

GoFrame框架安装与gf命令行工具
GoFrame框架安装与gf命令行工具

本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.17

60

15

GoFrame框架零基础入门
GoFrame框架零基础入门

本专题整理GoFrame框架的入门知识,从模块化设计理念、环境准备到跑通第一个Web服务,讲清目录分层、配置加载、日志与中间件的用法,并对比Gin、Go-Zero的差异,帮助Go开发者建立整体认知。

2026.11.17

80

15

SQLAlchemy 一对多关系怎么建立
SQLAlchemy 一对多关系怎么建立

SQLAlchemy 一对多关系怎么建立?本专题整理父子表外键、relationship 双向映射、关联查询、级联删除和加载优化等相关文章,帮助你理解并实现常见的 ORM 关系建模。

2026.11.17

20

10

热门下载

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

精品课程

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