• 【FastAPI】实现服务器向客户端发送SSE(Server-Sent Events)广播


    在FastAPI中实现服务器向客户端发送SSE(Server-Sent Events)广播,可以通过以下步骤实现。SSE是一种服务器推送技术,允许服务器发送实时数据到客户端,通常用于创建实时更新的应用程序。

    1. 安装必要的依赖

    首先,确保你已经安装了FastAPI和Uvicorn:

    pip install fastapi uvicorn
    

    2. FastAPI服务器实现SSE广播

    FastAPI使用StreamingResponse可以实现SSE。以下是一个实现SSE广播的简单例子,服务器会定期向所有连接的客户端广播消息。

    from fastapi import FastAPI, Request
    from fastapi.responses import StreamingResponse
    from typing import List
    import asyncio
    
    app = 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 = 0
            while True:
                await asyncio.sleep(5)  # 每5秒发送一次消息
                await broadcast_message(f"Server message: {count}")
                count += 1
    
        asyncio.create_task(send_messages())
    
    

    3. 客户端实现

    客户端可以使用EventSource对象来接收SSE事件流。以下是一个简单的HTML客户端代码:

    DOCTYPE html>
    <html>
    <head>
        <title>SSE Demotitle>
    head>
    <body>
        <h1>Server-Sent Eventsh1>
        <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广播功能了。

  • 相关阅读:
    Golang入门笔记(最后一章 17 封版)—— 映射map
    无重复字符的最长子串-返回结果字符串
    循环神经网络(RNN)简单介绍及实现(基于表面肌电信号)
    云栖大会丨桑文锋:打造云原生数字化客户经营引擎
    暴雪战网重装失败问题解决
    数字秒表设计仿真VHDL跑表,源码,视频
    Asp .Net Core 系列:Asp .Net Core 配置 System.Text.Json
    大功率光伏应用不同多电平变换器拓扑的比较研究(Simulink)
    CICD 流程学习(四)搜素服务与消息队列
    举例详解 TCP/IP 五层(或四层)模型与 OSI七层模型对比 (画图详解 一篇看懂!)
  • 原文地址:https://blog.csdn.net/h1773655323/article/details/142254031