了解Python中FileResponse()函数的参数和返回值

FileResponse()函数是Python中一个用于返回文件的HTTP响应的函数。它用于创建一个包含文件内容的HTTP响应，可以将文件发送给客户端。下面是关于FileResponse()函数的参数和返回值的详细说明，并包含一些使用例子。

参数：

1. file_path（必需）：要返回的文件的路径。可以是绝对路径或相对路径。

2. status_code（可选）：HTTP状态码，默认为200（OK）。

3. headers（可选）：HTTP响应头的字典。可以包含Content-Type、Content-Disposition等头信息。

4. media_type（可选）：要返回的文件的MIME类型。

5. filename（可选）：返回给客户端时的文件名。

返回值：

FileResponse()函数返回一个HTTP响应对象，其中包含要发送给客户端的文件内容。

下面是一些使用示例：

示例1：返回一个图片文件

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get("/get_image")
async def get_image():
    image_path = "path/to/image.jpg"
    return FileResponse(image_path, media_type="image/jpeg")

当访问/get_image时，服务器将返回image_path指定的图片文件给客户端，并将MIME类型设置为image/jpeg。

示例2：返回一个PDF文件

from fastapi import FastAPI
from fastapi.responses import FileResponse

app = FastAPI()

@app.get("/get_pdf")
async def get_pdf():
    pdf_path = "path/to/document.pdf"
    return FileResponse(pdf_path, media_type="application/pdf", filename="my_document.pdf")

当访问/get_pdf时，服务器将返回pdf_path指定的PDF文件给客户端，并将MIME类型设置为application/pdf。文件名将被设置为my_document.pdf。

示例3：返回一个从数据库中读取的二进制文件

from fastapi import FastAPI
from fastapi.responses import FileResponse
import io

app = FastAPI()

@app.get("/get_file")
async def get_file():
    file_data = get_file_data_from_database() # 从数据库中获取文件的二进制数据
    file_stream = io.BytesIO(file_data)
    return FileResponse(file_stream, media_type="application/octet-stream", filename="file.bin")

当访问/get_file时，服务器将返回从数据库中获取的文件的二进制数据。通过将二进制数据转换为文件流，并将文件流传递给FileResponse()函数来实现。

总结：

FileResponse()函数是用于返回文件内容的一个非常方便的工具函数。它可以根据需要设置HTTP响应头，允许指定文件的MIME类型和文件名，并能处理不同种类的文件（如图片、PDF、二进制文件）。