当前位置:首页 > 文章列表 > 文章 > python教程 > FastAPI流式响应chunked传输方法

FastAPI流式响应chunked传输方法

2026-02-16 15:03:48 0浏览 收藏
本文深入解析了 FastAPI 中 StreamingResponse 实现流式响应的核心机制与实战要点,揭示其默认即通过 chunked transfer encoding 实时推送数据的原理,并强调真正实现“流式”的关键不在配置开关,而在于生成器设计、中间件兼容性(如 Nginx 必须禁用缓冲)、前端读取方式(需用 ReadableStream 而非 text())、以及规避常见陷阱(如 Content-Length 干扰、同步阻塞、超时断连等);文章不仅提供可运行的最小示例,更给出从响应头验证、抓包排查到性能调优的一线排障路径,助你构建稳定、低延迟、真正端到端可控的实时数据流服务。

fastapi 如何实现 StreamingResponse 的 chunked transfer

StreamingResponse 默认就用 chunked transfer

只要你不设置 Content-Length,FastAPI 的 StreamingResponse 会自动启用 HTTP/1.1 chunked transfer encoding。这是它的默认行为,不需要额外配置 —— 但前提是底层 ASGI 服务器(如 Uvicorn)支持,并且你没手动干扰响应头。

  • Uvicorn 默认开启 chunked;Gunicorn + Uvicorn worker 也正常,但纯 Gunicorn(sync worker)不支持流式响应,会等整个生成器结束才发响应
  • 如果用了 Nginx 反向代理,默认会缓冲响应体,导致 chunked 被吞掉、客户端收不到实时数据 —— 必须在 location 块里加 proxy_buffering off;chunked_transfer_encoding on;
  • 浏览器 fetch API 接收 chunked 响应时,response.body.getReader() 才能分块读取;用 response.text() 会等全部结束,失去流式意义

如何构造一个真正可分块的生成器

关键不是“怎么开启 chunked”,而是生成器 yield 的内容是否足够小、是否及时 flush。Uvicorn 每次收到一个 yield 就尝试发一个 chunk,但如果 yield 太大或太密集,可能被合并;如果 yield 太慢,TCP 包可能被延迟发送(Nagle 算法)。

  • 每次 yield 最好控制在几 KB 内,例如 yield json.dumps(chunk).encode() + b"\n"
  • 避免在生成器里做耗时同步操作(如 time.sleep、requests.get),改用 await asyncio.sleep()
  • 如果需要强制刷新小 chunk,可在 yield 后加 await asyncio.sleep(0) 让出控制权,帮助 Uvicorn 尽快写出
  • 不要在生成器里 raise 异常后继续 yield —— FastAPI 会关闭连接,后续 chunk 丢弃

常见 chunked 失效场景和排查方法

你以为在流,其实客户端看到的是全量响应,大概率是中间某层吃掉了 chunked。先看响应头:

  • 用 curl -v 或浏览器 DevTools Network 面板确认响应头含 Transfer-Encoding: chunked,且没有 Content-Length
  • 如果看到 Content-Length,说明你或中间件(如某些 CORS 中间件、gzip 中间件)提前计算了长度,禁用或绕过它们
  • 如果响应头正确但前端收不到分块,抓包(tcpdump/wireshark)看 TCP 层是否真有多个小包;若只有 1 个大包,基本是 Nginx 或负载均衡器缓冲所致
  • Uvicorn 日志里出现 Connection lost before response written,常因客户端断连或超时,不是 chunked 问题,而是流产生太慢或客户端没保持连接

一个最小可验证的流式 endpoint 示例

from fastapi import FastAPI
from fastapi.responses import StreamingResponse
import asyncio
import json
<p>app = FastAPI()</p><p>async def event_stream():
for i in range(5):
await asyncio.sleep(1)  # 模拟异步等待
data = {"seq": i, "message": "hello"}
yield f"data: {json.dumps(data)}\n\n".encode()</p><h1>加 sleep(0) 可提升 chunk 及时性,非必需但有时有用</h1><pre class="brush:php;toolbar:false"><code>    await asyncio.sleep(0)</code>

@app.get("/stream") async def stream(): return StreamingResponse( event_stream(), media_type="text/event-stream", # 或 "application/json" 等

不要设 content_length!

)

注意:这里用 text/event-stream 是为了兼容浏览器 EventSource;若用 application/json,前端需用 fetch + ReadableStream 处理,且每个 chunk 应为独立 JSON 对象(不换行或用 \n 分隔)。

最易忽略的一点:流式响应的生命期依赖于生成器执行完或客户端断开。如果生成器卡在某个 await 上太久,Uvicorn 可能因 keep-alive 超时关闭连接,而这个超时通常不在 FastAPI 控制范围内,得去调 Uvicorn 的 --timeout-keep-alive 参数。

本篇关于《FastAPI流式响应chunked传输方法》的介绍就到此结束啦,但是学无止境,想要了解学习更多关于文章的相关知识,请关注golang学习网公众号!

Clawdbot手机版入口及下载方法Clawdbot手机版入口及下载方法
上一篇
Clawdbot手机版入口及下载方法
Win10计算器汇率功能不见了怎么恢复
下一篇
Win10计算器汇率功能不见了怎么恢复
查看更多
最新文章
资料下载
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ChatExcel酷表:告别Excel难题,北大团队AI助手助您轻松处理数据
    ChatExcel酷表
    ChatExcel酷表是由北京大学团队打造的Excel聊天机器人,用自然语言操控表格,简化数据处理,告别繁琐操作,提升工作效率!适用于学生、上班族及政府人员。
    4022次使用
  • Any绘本:开源免费AI绘本创作工具深度解析
    Any绘本
    探索Any绘本(anypicturebook.com/zh),一款开源免费的AI绘本创作工具,基于Google Gemini与Flux AI模型,让您轻松创作个性化绘本。适用于家庭、教育、创作等多种场景,零门槛,高自由度,技术透明,本地可控。
    4359次使用
  • 可赞AI:AI驱动办公可视化智能工具,一键高效生成文档图表脑图
    可赞AI
    可赞AI,AI驱动的办公可视化智能工具,助您轻松实现文本与可视化元素高效转化。无论是智能文档生成、多格式文本解析,还是一键生成专业图表、脑图、知识卡片,可赞AI都能让信息处理更清晰高效。覆盖数据汇报、会议纪要、内容营销等全场景,大幅提升办公效率,降低专业门槛,是您提升工作效率的得力助手。
    4236次使用
  • 星月写作:AI网文创作神器,助力爆款小说速成
    星月写作
    星月写作是国内首款聚焦中文网络小说创作的AI辅助工具,解决网文作者从构思到变现的全流程痛点。AI扫榜、专属模板、全链路适配,助力新人快速上手,资深作者效率倍增。
    5544次使用
  • MagicLight.ai:叙事驱动AI动画视频创作平台 | 高效生成专业级故事动画
    MagicLight
    MagicLight.ai是全球首款叙事驱动型AI动画视频创作平台,专注于解决从故事想法到完整动画的全流程痛点。它通过自研AI模型,保障角色、风格、场景高度一致性,让零动画经验者也能高效产出专业级叙事内容。广泛适用于独立创作者、动画工作室、教育机构及企业营销,助您轻松实现创意落地与商业化。
    4610次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码