FastAPI 中如何返回流式响应？-JavaScript中文网-JavaScript教程资源分享门户

推荐答案

在 FastAPI 中，可以通过使用 StreamingResponse 来返回流式响应。以下是一个简单的示例：

// www.javascriptcn.com code example
from fastapi import FastAPI
from fastapi.responses import StreamingResponse
import time

app = FastAPI()

def generate_data():
    for i in range(10):
        time.sleep(1)  # 模拟耗时操作
        yield f"data: {i}\n\n"

@app.get("/stream")
async def stream_data():
    return StreamingResponse(generate_data(), media_type="text/event-stream")

在这个示例中，generate_data 函数是一个生成器，它会逐步生成数据。StreamingResponse 将这个生成器包装成一个流式响应，客户端可以逐步接收数据。

本题详细解读

1. 什么是流式响应？

流式响应（Streaming Response）是一种逐步向客户端发送数据的机制。与一次性返回所有数据的传统响应不同，流式响应允许服务器在数据生成的同时逐步发送给客户端。这在处理大文件、实时数据或需要长时间计算的场景中非常有用。

2. 为什么使用 `StreamingResponse`？

StreamingResponse 是 FastAPI 提供的一个专门用于处理流式响应的类。它允许你将一个生成器函数或异步生成器函数包装成响应对象，客户端可以逐步接收数据，而不需要等待所有数据生成完毕。

3. 如何使用 `StreamingResponse`？

使用 StreamingResponse 的基本步骤如下：

定义生成器函数：生成器函数使用 yield 逐步生成数据。这个函数可以是同步的，也可以是异步的。
创建 StreamingResponse 对象：将生成器函数传递给 StreamingResponse，并指定适当的 media_type。
返回 StreamingResponse 对象：在路由处理函数中返回 StreamingResponse 对象。

4. 示例代码解析

// www.javascriptcn.com code example
from fastapi import FastAPI
from fastapi.responses import StreamingResponse
import time

app = FastAPI()

def generate_data():
    for i in range(10):
        time.sleep(1)  # 模拟耗时操作
        yield f"data: {i}\n\n"

@app.get("/stream")
async def stream_data():
    return StreamingResponse(generate_data(), media_type="text/event-stream")

generate_data 函数：这是一个同步生成器函数，每次调用 yield 时，它会生成一个字符串并暂停执行，直到下一次迭代。
StreamingResponse：将 generate_data 生成器包装成流式响应，并指定 media_type 为 text/event-stream，这是一种常用于服务器推送事件的媒体类型。
/stream 路由：当客户端访问 /stream 路由时，服务器会逐步发送生成的数据。

5. 注意事项

异步生成器：如果你需要处理异步操作（如数据库查询、网络请求等），可以使用异步生成器（async def 和 await）。
性能考虑：流式响应适用于大数据量或实时数据场景，但在高并发情况下，需要注意服务器的资源消耗。
客户端处理：客户端需要能够处理流式数据，通常使用 EventSource 或类似的机制来逐步接收数据。

通过以上步骤，你可以在 FastAPI 中轻松实现流式响应，逐步向客户端发送数据。

FastAPI 中如何返回流式响应？