本文详细介绍了如何在 fastapi 框架中同时处理文件上传和接收额外数据。通过结合 UploadFile 类型和请求参数，开发者可以轻松构建支持文件上传和接收相关元数据的 API 接口。本文提供了代码示例，演示了如何接收上传的文件，并将其保存到服务器本地，同时接收其他字符串类型的参数，并介绍了注意事项。
在构建现代 web 应用程序时，经常需要处理文件上传和接收相关数据的场景。fastapi 提供了简洁而强大的方式来实现这一目标。本文将详细介绍如何使用 fastapi 的 uploadfile 类型来处理文件上传，并同时接收其他数据，例如字符串类型的 id 或描述信息。
使用 UploadFile 实现文件上传
FastAPI 提供了 UploadFile 类型，用于处理文件上传。要使用它，需要在路由函数中声明一个类型为 UploadFile 的参数。例如：
from fastapi import FastAPI, UploadFile app = FastAPI() @app.post("/upload") async def upload_file(file: UploadFile): return {"filename": file.filename}
在这个例子中，/upload 路由接收一个名为 file 的 UploadFile 类型的参数。file 对象包含了上传文件的相关信息，例如文件名、内容类型等。
同时接收文件和额外数据
要同时接收文件和额外的数据，可以将 UploadFile 参数与其他类型的参数一起声明。例如：
from fastapi import FastAPI, UploadFile app = FastAPI() @app.post("/example") async def create_upload_file( file: UploadFile, transaction_id: str, organization_id: str ): file_name = organization_id + transaction_id with open(file_name, "wb") as out_file: contents = await file.read() out_file.write(contents) return {"filename": file.filename, "transaction_id": transaction_id, "organization_id": organization_id}
在这个例子中，/example 路由接收一个 UploadFile 类型的 file 参数，以及两个字符串类型的参数 transaction_id 和 organization_id。
代码解析
- file: UploadFile: 声明一个 UploadFile 类型的参数，用于接收上传的文件。
- transaction_id: str: 声明一个字符串类型的参数，用于接收交易 ID。
- organization_id: str: 声明一个字符串类型的参数，用于接收组织 ID。
- file_name = organization_id + transaction_id: 将组织 ID 和交易 ID 拼接成文件名。
- with open(file_name, “wb”) as out_file: 以二进制写入模式打开文件，用于保存上传的文件。
- contents = await file.read(): 读取上传文件的内容。注意这里需要使用await关键字，因为file.read()是一个异步操作。
- out_file.write(contents): 将文件内容写入到文件中。
- return {“filename”: file.filename, “transaction_id”: transaction_id, “organization_id”: organization_id}: 返回包含文件名、交易 ID 和组织 ID 的 json 响应。
注意事项
- 确保在安装 FastAPI 时，同时安装了 python-multipart 库，它是处理文件上传的依赖项。可以使用 pip install python-multipart 命令安装。
- 上传的文件默认存储在内存中。如果上传的文件较大，可能会导致内存溢出。为了避免这种情况，可以将文件保存到磁盘上。
- 在生产环境中，应该对上传的文件进行安全检查，例如检查文件类型、大小等，以防止恶意文件上传。
- 在保存文件时，应该使用唯一的文件名，以避免文件名冲突。
总结
本文介绍了如何在 FastAPI 中使用 UploadFile 类型来处理文件上传，并同时接收其他数据。通过结合 UploadFile 类型和请求参数，开发者可以轻松构建支持文件上传和接收相关元数据的 API 接口。希望本文能够帮助你更好地理解和使用 FastAPI。
