FastAPI中的`async def`用法详解

### FastAPI 中 `lifespan` 功能详解 #### 一、功能概述 FastAPI 提供了一个名为 `lifespan` 的参数用于定义应用程序生命周期中的事件处理函数。这些事件主要分为启动前(`startup`)和关闭后(`shutdown`)两类，在应用初始化之前以及结束之后执行相应的逻辑操作[^2]。 #### 二、具体实现方式 通过装饰器或者直接传递给 FastAPI 实例化对象来指定 `lifespan` 函数。此函数应该是一个异步上下文管理器 (`@asynccontextmanager`)，它允许开发者在其中编写启动时建立资源(比如数据库连接)，并在程序终止时释放这些资源的代码片段。 ```python from contextlib import asynccontextmanager from fastapi import FastAPI # 假设这里有一个数据库模块db.py提供了database对象 from db import database @asynccontextmanager async def manage_database(app: FastAPI): await database.connect() try: yield finally: await database.disconnect() app = FastAPI(lifespan=manage_database) ``` 上述代码展示了如何利用 `lifespan` 参数配合自定义的异步上下文管理器来进行数据库连接池的创建与销毁工作。 #### 三、官方文档示例解析 根据官方给出的例子可以更清晰地理解其应用场景： 当集成 Tortoise ORM 或其他第三方库时，可能需要确保每次请求都能访问到有效的会话/事务环境；而使用 `lifespan` 就能很好地解决这个问题——即可以在服务启动之初就准备好必要的依赖项，并于停止之时清理它们[^3]。 对于 MongoDB 连接而言，则可以通过类似的方式完成同样的目标: ```python from motor.motor_asyncio import AsyncIOMotorClient from fastapi import FastAPI class MongoConnectionManager: def __init__(self, uri: str): self.uri = uri self.client = None async def startup(self): self.client = AsyncIOMotorClient(self.uri) async def shutdown(self): self.client.close() mongo_manager = MongoConnectionManager('mongodb://localhost:27017') @app.on_event("startup") async def start_mongo(): await mongo_manager.startup() @app.on_event("shutdown") async def stop_mongo(): await mongo_manager.shutdown() ``` 这段代码实现了基于 `on_event()` 方法的手动注册启动和关闭回调的效果，虽然不是严格意义上的 `lifespan` 用法，但在某些情况下也能达到相同的目的[^4]。