FastAPI 中如何使用 StreamingResponse？-JavaScript中文网-JavaScript教程资源分享门户

推荐答案

在 FastAPI 中，StreamingResponse 用于流式传输数据，适用于处理大文件或生成动态内容。以下是一个简单的示例，展示如何使用 StreamingResponse 来流式传输一个文件：

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

app = FastAPI()

@app.get("/stream-file")
def stream_file():
    def iter_file():
        with open("large_file.txt", "rb") as f:
            yield from f

    return StreamingResponse(iter_file(), media_type="text/plain")

在这个示例中，iter_file 函数是一个生成器，它逐块读取文件内容并生成数据流。StreamingResponse 接收这个生成器，并将其作为响应内容流式传输给客户端。

本题详细解读

1. `StreamingResponse` 的作用

StreamingResponse 是 FastAPI 提供的一个响应类，专门用于处理流式数据。它允许你将数据分块发送给客户端，而不是一次性发送整个响应内容。这对于处理大文件、实时数据或生成动态内容非常有用。

2. 使用 `StreamingResponse` 的步骤

定义生成器函数：首先，你需要定义一个生成器函数，该函数将逐块生成数据。生成器函数使用 yield 关键字来返回数据块。
创建 StreamingResponse 实例：将生成器函数传递给 StreamingResponse，并指定适当的 media_type。
返回 StreamingResponse：在路由处理函数中返回 StreamingResponse 实例。

3. 示例代码解析

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

app = FastAPI()

@app.get("/stream-file")
def stream_file():
    def iter_file():
        with open("large_file.txt", "rb") as f:
            yield from f

    return StreamingResponse(iter_file(), media_type="text/plain")

iter_file 函数：这是一个生成器函数，它打开一个文件并以二进制模式读取内容。yield from f 语句逐块生成文件内容。
StreamingResponse：StreamingResponse 接收生成器函数 iter_file 作为参数，并指定 media_type 为 "text/plain"，表示响应内容为纯文本。
路由处理函数：stream_file 是处理 /stream-file 路径的路由函数，它返回 StreamingResponse 实例。

4. 注意事项

内存效率：使用 StreamingResponse 可以显著减少内存使用，因为它不需要一次性加载整个文件或数据到内存中。
媒体类型：确保为 StreamingResponse 设置正确的 media_type，以便客户端能够正确解析响应内容。
生成器函数：生成器函数可以是任何能够逐块生成数据的函数，不仅限于文件读取。例如，你可以使用生成器函数来生成动态内容或从数据库中流式传输数据。

通过以上步骤和示例，你可以在 FastAPI 中有效地使用 StreamingResponse 来处理流式数据。

FastAPI 中如何使用 StreamingResponse？