0

0

Quart 中实现 Server-Sent Events(SSE)的完整指南

碧海醫心

碧海醫心

发布时间:2026-04-20 09:24:44

|

726人浏览过

|

来源于php中文网

原创

Quart 中实现 Server-Sent Events(SSE)的完整指南

本文详解如何在 quart 框架中正确实现 server-sent events,重点解决事件流被 nginx/hypercorn 缓冲导致前端收不到实时响应的问题,并提供可直接运行的异步队列驱动 sse 示例。

本文详解如何在 quart 框架中正确实现 server-sent events,重点解决事件流被 nginx/hypercorn 缓冲导致前端收不到实时响应的问题,并提供可直接运行的异步队列驱动 sse 示例。

Server-Sent Events(SSE)是一种基于 HTTP 的单向实时通信机制,适用于服务端向客户端持续推送更新(如通知、日志、状态变更等)。Quart 作为异步 Python Web 框架,天然支持 SSE,但实际部署中常因反向代理(如 Nginx)或 ASGI 服务器(如 Hypercorn)的默认缓冲策略,导致响应体被截断或延迟发送——表现为 Postman 或浏览器长时间挂起、无任何 event-stream 数据输出,仅在服务中断时才“刷出”累积内容。

根本原因在于:Nginx 默认启用 proxy_buffering on,会暂存后端响应直到缓冲区满或连接关闭;而 SSE 要求逐块即时传输(chunked encoding + keep-alive),必须显式禁用代理层缓冲。

✅ 正确解决方案是:在 Quart 响应头中添加 X-Accel-Buffering: no(Nginx 专用指令),强制其绕过缓冲,直通流式数据。

以下是一个生产就绪的 Quart SSE 实现示例:

聚好用AI
聚好用AI

可免费AI绘图、AI音乐、AI视频创作,聚集全球顶级AI,一站式创意平台

下载
from quart import Quart, request, make_response, abort
from asyncio import Queue
from dataclasses import dataclass
import asyncio

app = Quart(__name__)

@dataclass
class ServerSentEvent:
    data: str
    event: str = "message"

    def encode(self) -> bytes:
        # 严格遵循 SSE 规范:每条消息以 \r\n\r\n 结尾,字段为 data: / event: / id: 等
        lines = [f"data: {self.data}"]
        if self.event != "message":
            lines.append(f"event: {self.event}")
        lines.append("")  # 空行分隔消息
        return "\r\n".join(lines).encode("utf-8")

# 全局事件队列(生产环境建议使用 Redis Pub/Sub 或更健壮的消息总线)
global_event_queue: Queue = Queue()

@app.route("/sse")
async def sse_endpoint():
    # 客户端必须声明接受 text/event-stream
    if "text/event-stream" not in request.accept_mimetypes:
        abort(400, "Accept header must include text/event-stream")

    async def event_stream():
        # 初始订阅确认事件
        yield ServerSentEvent(event="connected", data="SSE connection established").encode()

        # 持续监听队列并推送事件
        while True:
            try:
                # 使用 timeout 避免永久阻塞(可选,增强健壮性)
                event = await asyncio.wait_for(global_event_queue.get(), timeout=30.0)
                yield event.encode()
            except asyncio.TimeoutError:
                # 心跳保活:发送空注释(SSE 注释以 : 开头,客户端忽略)
                yield b": heartbeat\n\n"

    # 构造响应:关键!添加 X-Accel-Buffering: no
    response = await make_response(
        event_stream(),
        {
            "Content-Type": "text/event-stream",
            "Cache-Control": "no-cache",
            "Connection": "keep-alive",
            "X-Accel-Buffering": "no",  # ? 核心修复:禁用 Nginx 缓冲
        }
    )
    response.timeout = None  # 禁用 Quart 响应超时
    return response

# 示例:模拟后端触发事件(如 WebSocket 收到消息、数据库变更等)
@app.route("/trigger-event", methods=["POST"])
async def trigger_event():
    form = await request.form
    data = form.get("data", "default message")
    event_name = form.get("event", "update")

    await global_event_queue.put(ServerSentEvent(data=data, event=event_name))
    return {"status": "event queued"}

? 关键注意事项:

  • Nginx 配置补充(如使用): 除响应头外,还需在 location /sse 块中配置:
    proxy_buffering off;
    proxy_cache off;
    proxy_http_version 1.1;
    proxy_set_header Connection '';
    chunked_transfer_encoding off;  # 确保 Hypercorn 的 chunked 不被覆盖
  • ASGI 服务器兼容性: Hypercorn 默认支持流式响应,但需确保未启用 --worker-class sync 等同步模式;推荐使用默认 asyncio worker。
  • 客户端连接管理: 浏览器 EventSource 会在断连后自动重试(默认 3s),服务端应处理重复连接(如通过 request.sid 或 token 鉴权)。
  • 错误处理与心跳: 示例中加入了超时心跳,避免长连接被中间设备(如负载均衡器)静默关闭;生产环境建议结合 retry: 字段控制重连间隔。
  • 并发安全: asyncio.Queue 是协程安全的,多路 event_stream() 可共享同一队列,无需额外锁。

总结:Quart 完全胜任 SSE 场景,问题不在框架本身,而在 HTTP 中间件的流式语义适配。只需牢记——X-Accel-Buffering: no 是 Nginx 环境下 SSE 生效的黄金钥匙,配合规范的事件编码与异步流生成,即可构建低延迟、高可靠的服务端推送能力。

相关标签:

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

热门AI工具

更多
DeepSeek
DeepSeek

幻方量化公司旗下的开源大模型平台

豆包大模型
豆包大模型

字节跳动自主研发的一系列大型语言模型

WorkBuddy
WorkBuddy

腾讯云推出的AI原生桌面智能体工作台

通义千问
通义千问

阿里巴巴推出的全能AI助手

Claude
Claude

Anthropic发布的与ChatGPT竞争的聊天机器人

Cursor
Cursor

一个新的IDE,使用AI来帮助您重构、理解、调试和编写代码。

Hermes Agent
Hermes Agent

一位与您共同成长的Agent

即梦AI
即梦AI

一站式AI创作平台,免费AI图片和视频生成。

ChatGPT
ChatGPT

最最强大的AI聊天机器人程序,ChatGPT不单是聊天机器人,还能进行撰写邮件、视频脚本、文案、翻译、代码等任务。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

707

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

930

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

913

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2850

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

703

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

678

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

760

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

411

2023.08.10

phpEnv 多版本 PHP 切换与管理
phpEnv 多版本 PHP 切换与管理

系统讲解 phpEnv 的多版本 PHP 管理能力,涵盖 PHP 5.6、7.4、8.0、8.1、8.2、8.3 等多版本的下载安装与共存配置、不同站点绑定不同 PHP 版本的方法、php.ini 常用参数(内存限制/上传大小/时区/错误显示)的独立调整、PHP 扩展(Redis/Swoole/Xdebug/imagick)的安装与启用,帮助开发者灵活应对多项目多版本的开发需求。

0

2026.04.22

热门下载

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

精品课程

更多
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送