当前位置：首页 > news >正文

FastAPI中的依赖注入详解与示例

news 来源：原创 2025/4/28 7:17:23

在构建现代Web应用时，代码的模块化和复用性至关重要。FastAPI内置了强大的依赖注入（Dependency Injection，简称DI）系统，帮助开发者轻松管理和复用复杂的逻辑、参数和服务，如数据库连接、认证、配置等。本文将详细介绍FastAPI依赖注入的原理、使用方法，并通过代码示例帮助你快速掌握。

什么是依赖注入？

依赖注入是一种设计模式，通过将组件所依赖的对象（依赖项）由外部传入，而不是在组件内部自行创建，从而实现代码解耦和复用。在FastAPI中，依赖注入允许我们声明路径操作函数所需的依赖，FastAPI会自动执行依赖逻辑并将结果注入到函数参数中。

FastAPI依赖注入的基本用法

1. 定义依赖项函数

依赖项通常是一个普通函数（可以是异步的），它执行某些逻辑并返回需要注入的值。例如，一个处理查询参数的依赖项：

from typing import Union
from fastapi import Depends, FastAPIapp = FastAPI()async def common_parameters(q: Union[str, None] = None, skip: int = 0, limit: int = 100
):return {"q": q, "skip": skip, "limit": limit}

2. 在路径操作函数中声明依赖

通过Depends将依赖函数注入到路径操作函数的参数中：

@app.get("/items/")
async def read_items(commons: dict = Depends(common_parameters)):return commons@app.get("/users/")
async def read_users(commons: dict = Depends(common_parameters)):return commons

当请求/items/或/users/时，FastAPI会先调用common_parameters函数，获取返回值并赋给commons参数，然后执行路径操作函数。

依赖注入的工作流程

FastAPI识别路径操作函数参数中使用的Depends。
自动调用依赖函数，传入请求中的参数（如查询参数）。
获取依赖函数的返回值，并注入到路径操作函数对应参数。
执行路径操作函数，返回响应。

依赖注入的高级用法

1. 类作为依赖项

依赖项不仅限于函数，也可以是类。FastAPI会实例化该类并注入：

from fastapi import Depends, FastAPIapp = FastAPI()class CommonQueryParams:def __init__(self, q: str = None, skip: int = 0, limit: int = 100):self.q = qself.skip = skipself.limit = limit@app.get("/items/")
async def read_items(commons: CommonQueryParams = Depends(CommonQueryParams)):return {"q": commons.q, "skip": commons.skip, "limit": commons.limit}

这种方式适合依赖项需要维护状态或多个方法的场景。

2. 依赖项嵌套（子依赖）

依赖项函数可以依赖其他依赖项，实现复杂逻辑拆分。例如：

from fastapi import Dependsasync def get_token_header(token: str = Depends(oauth2_scheme)):# 验证token逻辑return tokenasync def get_current_user(token: str = Depends(get_token_header)):# 根据token获取用户return user

3. 依赖项的生命周期管理

依赖函数可以用yield关键字实现上下文管理，完成资源的初始化和清理，如数据库连接：

from fastapi import Dependsasync def get_db():db = create_db_session()try:yield dbfinally:db.close()@app.get("/items/")
async def read_items(db = Depends(get_db)):items = db.query(...)return items

依赖注入的优势

代码复用：将通用逻辑封装为依赖项，多个路径操作函数共享。
解耦合：路径操作函数无需关心依赖的创建细节。
自动验证：依赖项参数支持类型注解，FastAPI自动校验请求参数。
灵活性：支持同步和异步依赖，类和函数均可作为依赖。
集成方便：轻松集成数据库连接、认证、配置等服务。

完整示例代码

from typing import Union
from fastapi import Depends, FastAPIapp = FastAPI()# 依赖项函数，处理查询参数
async def common_parameters(q: Union[str, None] = None, skip: int = 0, limit: int = 100
):return {"q": q, "skip": skip, "limit": limit}# 路径操作函数，注入依赖
@app.get("/items/")
async def read_items(commons: dict = Depends(common_parameters)):return commons# 类作为依赖项示例
class CommonQueryParams:def __init__(self, q: Union[str, None] = None, skip: int = 0, limit: int = 100):self.q = qself.skip = skipself.limit = limit@app.get("/users/")
async def read_users(commons: CommonQueryParams = Depends(CommonQueryParams)):return {"q": commons.q, "skip": commons.skip, "limit": commons.limit}