在FastAPI中实现服务器向客户端发送SSE(Server-Sent Events)广播,可以通过以下步骤实现。SSE是一种服务器推送技术,允许服务器发送实时数据到客户端,通常用于创建实时更新的应用程序。
1. 安装必要的依赖
首先,确保你已经安装了FastAPI和Uvicorn:
pip install fastapi uvicorn
2. FastAPI服务器实现SSE广播
FastAPI使用StreamingResponse
可以实现SSE。以下是一个实现SSE广播的简单例子,服务器会定期向所有连接的客户端广播消息。
python">from fastapi import FastAPI, Request
from fastapi.responses import StreamingResponse
from typing import List
import asyncioapp = FastAPI()# 用于保存所有的客户端连接
clients: List[asyncio.Queue] = []# SSE生成器,用于向客户端发送事件流
async def event_generator():queue = asyncio.Queue() # 每个客户端拥有自己的消息队列clients.append(queue)try:while True:data = await queue.get() # 等待新消息yield f"data: {data}\n\n"except asyncio.CancelledError:clients.remove(queue) # 客户端断开连接时移除其队列raise# SSE endpoint,用于客户端连接
@app.get("/sse")
async def sse(request: Request):# 返回SSE流return StreamingResponse(event_generator(), media_type="text/event-stream")# 广播消息到所有客户端
async def broadcast_message(message: str):for queue in clients:await queue.put(message) # 将消息放入所有客户端的队列中# 定期发送广播消息
@app.on_event("startup")
async def startup_event():async def send_messages():count = 0while True:await asyncio.sleep(5) # 每5秒发送一次消息await broadcast_message(f"Server message: {count}")count += 1asyncio.create_task(send_messages())
3. 客户端实现
客户端可以使用EventSource
对象来接收SSE事件流。以下是一个简单的HTML客户端代码:
<!DOCTYPE html>
<html>
<head><title>SSE Demo</title>
</head>
<body><h1>Server-Sent Events</h1><div id="messages"></div><script>const eventSource = new EventSource("/sse");eventSource.onmessage = function(event) {const newMessage = document.createElement("div");newMessage.textContent = event.data;document.getElementById("messages").appendChild(newMessage);};eventSource.onerror = function() {console.log("Error occurred or connection closed.");};</script>
</body>
</html>
4. 运行FastAPI服务器
使用Uvicorn运行服务器:
uvicorn main:app --reload
这样,服务器会每5秒向所有连接的客户端广播消息。客户端只需要访问/sse
即可建立与服务器的SSE连接,并实时接收服务器推送的消息。
关键点说明:
- SSE(Server-Sent Events):服务器通过
text/event-stream
向客户端推送数据,客户端通过EventSource
接收。 - 广播实现:将消息放入所有客户端的队列中,确保每个连接的客户端都能接收到消息。
- StreamingResponse:用于持续向客户端发送数据流。
这样,你就可以在FastAPI中实现一个SSE广播功能了。