Starlette如何处理流式响应StreamingResponse

星明吖_3113

星明吖_3113

2026-11-17

584人浏览

原创

starlette 通过 streamingresponse 处理流式响应,核心做法是传入一个异步可迭代对象(如生成器或异步生成器),框架会在客户端连接期间逐块发送数据。开发者只需在视图函数中定义包含 yield 的异步函数,并将其实例化为 streamingresponse 返回即可。若需自定义 mime 类型或头部信息,可在构造函数中指定 media_type 和 headers 参数。

Starlette如何处理流式响应StreamingResponse

如何构建基础的异步流式响应

构建基础流式响应的关键在于使用 Python 的异步生成器(async def + yield)来产生数据块。Starlette 会自动遍历该生成器,将每次 yield 出的字节串写入 HTTP 响应体并立即发送给客户端。这种方式避免了将所有数据加载到内存中,非常适合大文件传输或实时日志推送场景。以下代码展示了如何创建一个简单的流式响应,其中数据块按顺序生成。

Starlette如何处理流式响应StreamingResponse

import asyncio
from starlette.applications import Starlette
from starlette.responses import StreamingResponse
from starlette.routing import Route

async def stream_data(request):
    async def data_generator():
        for i in range(5):
            yield f"Chunk {i}: Hello\n".encode()
            await asyncio.sleep(0.1)  # 模拟延迟以观察流式效果
    return StreamingResponse(data_generator())

app = Starlette(routes=[Route("/stream", stream_data)])

运行上述代码后,访问 /stream 端点,客户端会依次收到五个数据块。每个块都是独立的字节串,中间由 await asyncio.sleep 引入微小延迟,这能直观体现流式传输的特性:数据不是一次性到达,而是分批次抵达。这种实现方式确保了即使数据量很大,服务器内存占用也保持恒定。

如何处理自定义头部与媒体类型

在处理流式响应时,默认媒体类型通常为 text/html,但在许多场景下(如 JSON 流、CSV 导出或 SSE),需要明确指定 media_type 和额外的 HTTP 头部。通过在实例化 StreamingResponse 时传入 headers 字典,可以覆盖默认的 Content-Type 或添加 Cache-Control 等指令。这对于确保客户端正确解析流内容至关重要,例如告诉浏览器不要缓存部分更新的 CSV 文件。

Livestream Sales Script
Livestream Sales Script

直播带货脚本专家,擅长根据产品信息编写生动、吸引人且具说服力的直播脚本,突出核心卖点。

下载

Starlette如何处理流式响应StreamingResponse

import asyncio
from starlette.responses import StreamingResponse

async def csv_stream(request):
    async def generate_csv():
        yield "id,name\n".encode()
        for i in range(3):
            yield f"{i},User{i}\n".encode()
            await asyncio.sleep(0.05)
    
    headers = {
        "Cache-Control": "no-cache",
        "X-Stream-Status": "active"
    }
    return StreamingResponse(
        generate_csv(),
        media_type="text/csv",
        headers=headers
    )

执行此代码时,客户端接收到的响应头将包含 Content-Type: text/csv; charset=utf-8 以及自定义的 X-Stream-Status。这种灵活性允许开发者根据具体业务需求调整 HTTP 协议层面的元数据,而无需修改底层的数据生成逻辑。需要注意的是,头部信息必须在响应开始发送前确定,因为一旦第一个数据块发出,HTTP 头部即被锁定。

当异步生成器抛出异常时响应会怎样

当异步生成器在迭代过程中抛出未捕获的异常时,Starlette 会中断当前的流式传输,并向客户端发送一个错误状态码(通常是 500 Internal Server Error)。此时,已经发送的部分数据可能已被客户端接收,但后续数据将不再传输。如果需要在发生错误时优雅地关闭连接或记录日志,可以在生成器内部使用 try...except 块包裹 yield 语句,或者在视图层捕获异常并返回标准的错误响应对象,从而避免直接暴露堆栈跟踪给客户端。

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

starlette stream

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

相关专题

更多
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

2025.12.22

119

5

Python 微服务架构与 FastAPI 框架
Python 微服务架构与 FastAPI 框架

本专题系统讲解 Python 微服务架构设计与 FastAPI 框架应用,涵盖 FastAPI 的快速开发、路由与依赖注入、数据模型验证、API 文档自动生成、OAuth2 与 JWT 身份验证、异步支持、部署与扩展等。通过实际案例,帮助学习者掌握 使用 FastAPI 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

2026.02.06

594

18

Python Web框架FastAPI 全栈开发教程合集
Python Web框架FastAPI 全栈开发教程合集

以 FastAPI 为核心,讲解现代 Python Web API 的高效开发方式,涵盖路由定义与路径参数/查询参数/请求体绑定、Pydantic 模型的数据校验与序列化、依赖注入(Depends)系统的分层设计、中间件与 CORS 配置、OAuth2 + JWT 认证流程、后台任务(BackgroundTasks)、WebSocket 实时通信、SQLAlchemy 异步 ORM 集成、自动生成 OpenAPI/Swagger 交互文

2026.05.09

776

23

Python FastAPI异步微服务与高性能接口设计
Python FastAPI异步微服务与高性能接口设计

本专题聚焦 Python FastAPI 框架在高性能接口与微服务开发中的应用,讲解异步请求处理、依赖注入机制、路由设计、数据库异步操作以及接口性能优化策略。结合实际项目案例,帮助开发者构建高并发、低延迟的现代化后端服务架构。

2026.06.16

679

12

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

2026.11.12

140

15

Go-Zero安装与goctl环境配置教程
Go-Zero安装与goctl环境配置教程

本专题围绕Go-Zero的安装与工具链配置展开,讲清Go版本要求、goctl安装方式、代理镜像、protoc依赖与环境变量设置,说明多版本共存、升级回退与CI流水线安装的做法,并整理安装阶段的常见报错与验证步骤。

2026.11.12

100

15

Go-Zero零基础入门教程
Go-Zero零基础入门教程

本专题整理Go-Zero的入门知识,从框架定位、环境准备到跑通第一个API服务,讲清目录分层、配置加载、日志与中间件的基本用法,并对比Gin、Kratos的差异,帮助Go开发者建立整体认知,判断它是否适合当前项目。

2026.11.12

100

15

Postman身份认证怎么配置
Postman身份认证怎么配置

本专题从实际API接口调试场景出发,讲解Postman身份认证的完整配置流程,包括常见认证协议介绍、授权参数设置、访问令牌填写、OAuth 2.0授权及认证失败排查,帮助用户正确完成接口授权与访问验证。

2026.11.06

160

12

Postman请求头Headers怎么设置
Postman请求头Headers怎么设置

围绕Postman HTTP请求头配置展开,讲解Headers选项的具体使用方式,包括Key和Value参数填写、请求头信息添加、常见Header字段设置及请求头修改方法,帮助用户解决接口调试过程中遇到的请求头配置问题。

2026.11.06

140

13

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程