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

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

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 中心模式,支持懒加载 Redis 订阅、连接注册表和优雅关闭。适用于构建可跨多实例扩展的实时 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" 而不触发业务广播逻辑。这样既维持了连接状态,又避免了无意义的数据广播。若长时间未收到心跳,可主动关闭连接并从集合中移除,防止僵尸连接占用资源。










