快速入门：在 FastAPI 中处理长时间运行后无响应的问题
随着现代应用程序的复杂性不断增加，开发者经常遇到 performance 和 reliability 等问题。其中一个常见的问题是在使用 FastAPI 开发应用程序时，长时间运行后可能会出现无响应的情况。本文将帮助新手开发者了解如何避免这个问题，同时提供详细的步骤和示例代码。
整体流程概述
下面是解决该问题的整体流程，包含步骤和目的：
| 步骤 | 目的 |
|---|---|
| 1. 理解 FastAPI 的工作原理 | 确保认识 FastAPI 是异步/同步的处理方式 |
| 2. 使用异步任务系统 | 在后台处理长时间运行的任务，保证接口的响应性 |
| 3. 调用任务并返回结果 | 使用户能够查询任务的状态和结果 |
| 4. 日志与错误处理策略 | 处理可能的错误并记录日志，以便后续调试 |
每一步的详细实现
1. 理解 FastAPI 的工作原理
FastAPI 支持异步编程模型，可以同时处理多个请求，但是如果某一个请求执行时间过长，就会造成其他请求的阻塞。这就是为何我们需要使用异步任务系统。
2. 使用异步任务系统
使用如 Celery 这样的工具，能够将长时间运行的任务放到后台执行。以下是如何设置 Celery 的示例代码。
# requirements.txt
fastapi
uvicorn
celery
redis
首先，我们需要安装依赖项：
pip install -r requirements.txt
3. 创建基础的 FastAPI 应用并集成 Celery
# main.py
from fastapi import FastAPI
from celery import Celery
import time
app = FastAPI()
# 设置 Celery
celery_app = Celery('tasks', broker='redis://localhost:6379/0')
@celery_app.task
def long_task():
# 模拟一个长时间运行的任务
time.sleep(10) # 睡眠 10 秒
return {"status": "Task complete!"}
@app.post("/run-task/")
async def run_task():
# 调用 celery 任务
task = long_task.delay()
return {"task_id": task.id} # 返回任务 ID
这段代码首先导入了 FastAPI 和 Celery。然后，我创建了 FastAPI 应用，并配置了 Celery 的分布式消息代理，这里使用 Redis。长时间运行的任务定义在 long_task 函数中。
4. 查询任务状态
用户可能想要知道任务是否完成，我们可以创建另一个接口来查询任务状态：
@app.get("/task-status/{task_id}")
async def get_task_status(task_id: str):
task = long_task.AsyncResult(task_id)
if task.state == 'PENDING':
# 任务尚未开始
return {"status": "Pending..."}
elif task.state != 'FAILURE':
# 任务已完成
return {"status": task.state, "result": task.result}
else:
return {"status": "Failed", "error": str(task.info)}
在这里，我们能够根据任务 ID 查询当前任务的状态，可以看到任务是Pending、SUCCESS 还是 FAILURE。
5. 日志与错误处理策略
在实际开发中，日志和错误处理非常重要。可以使用 Python 内置的 logging 模块来记录日志。
import logging
# 设置 logging
logging.basicConfig(level=logging.INFO)
@app.exception_handler(Exception)
async def unicorn_exception_handler(request, exc):
logging.error(f"Error: {exc}")
return PlainTextResponse(str(exc), status_code=500)
使用 mermaid 绘制饼状图
为了展示任务的状态，我们可以使用 mermaid 绘制简单的饼状图表示任务的完成状态：
pie
title 任务状态分布
"Pending": 40
"Success": 50
"Failed": 10
结尾
通过上述步骤，我们已经成功实现了一个基本的 FastAPI 应用，该应用能够处理长时间运行的任务而不会导致无响应的问题。使用 Celery 来异步处理任务是一个有效的解决方案。同时，结合状态查询和良好的日志策略，可以帮助你构建出更强大的应用程序。
希望以上信息对你理解和解决 FastAPI 中的长时间运行问题有所帮助。如果你有任何疑问或需要进一步的指导，请随时联系我。 Happy coding！
