FastAPI依赖注入怎么用？

在Python中使用FastAPI进行依赖注入可以大大简化代码结构和提高可维护性。1）依赖注入允许将业务逻辑从路由处理中分离，使代码更清晰和可测试。2）依赖函数可以被多个路由共享，减少代码重复。3）依赖注入有助于解耦和提高灵活性，但需注意性能开销和复杂性。

在Python中使用FastAPI进行依赖注入是一种非常优雅和高效的方法，可以大大简化代码结构和提高可维护性。下面我将详细展开讨论如何使用FastAPI的依赖注入，并分享一些实用的经验。

当我们谈到FastAPI的依赖注入，它不仅仅是一个功能，而是一种设计哲学。在FastAPI中，依赖注入允许我们将业务逻辑从路由处理中分离出来，使得代码更加清晰和可测试。依赖注入的核心思想是“依赖反转原则”，即高层模块不应该依赖于低层模块，而是应该依赖于抽象。

让我们从一个简单的例子开始：

from fastapi import FastAPI, Depends
from typing import Annotated

app = FastAPI()

async def common_parameters(q: str | None = None, skip: int = 0, limit: int = 100):
    return {"q": q, "skip": skip, "limit": limit}

@app.get("/items/")
async def read_items(commons: Annotated[dict, Depends(common_parameters)]):
    return commons

在这个例子中，common_parameters 是一个依赖函数，它返回一个包含查询参数的字典。我们在路由中使用 Depends 来注入这个依赖，这样我们就可以在多个路由中复用这些参数处理逻辑。

这种方法有几个显著的优点：

• 代码复用：依赖函数可以被多个路由共享，减少了代码的重复。
• 解耦：业务逻辑和路由处理分离，提高了代码的可维护性和可测试性。
• 灵活性：依赖注入使得我们可以很容易地在运行时替换或修改依赖。

然而，使用依赖注入也有一些需要注意的地方：

• 性能开销：每次请求时，依赖函数都会被调用，这可能会带来一些性能开销。虽然FastAPI在这方面做了优化，但对于高并发场景还是需要谨慎。
• 复杂性：过度使用依赖注入可能会使代码结构变得复杂，难以理解和维护。

在实际项目中，我发现依赖注入在处理数据库连接、认证和权限管理等场景中特别有用。例如，我们可以创建一个依赖函数来管理数据库连接：

from fastapi import FastAPI, Depends
from sqlalchemy.orm import Session
from database import SessionLocal

app = FastAPI()

def get_db():
    db = SessionLocal()
    try:
        yield db
    finally:
        db.close()

@app.get("/users/")
async def read_users(db: Session = Depends(get_db)):
    users = db.query(User).all()
    return users

在这个例子中，get_db 是一个生成器函数，它在每次请求时创建一个新的数据库会话，并在请求结束后关闭会话。这样，我们可以在每个路由中轻松地获取数据库连接，而不需要在每个路由中重复编写数据库连接和关闭的代码。

关于依赖注入的使用，我有一些实用的建议：

• 保持依赖函数简单：依赖函数应该只做必要的工作，避免复杂的逻辑。
• 使用类型注解：FastAPI依赖注入与Python的类型注解结合得非常好，使用类型注解可以提高代码的可读性和可维护性。
• 测试依赖函数：依赖函数应该独立于路由进行测试，这样可以确保它们的正确性和可靠性。

最后，我想分享一个我曾经遇到的问题：在使用依赖注入时，如果依赖函数之间存在循环依赖，会导致运行时错误。为了避免这种情况，我建议在设计依赖关系时，确保依赖图是无环的，或者使用一些设计模式（如工厂模式）来解耦依赖关系。

总的来说，FastAPI的依赖注入是一个强大的工具，可以帮助我们编写更清晰、更可维护的代码。通过合理使用依赖注入，我们可以大大提高开发效率和代码质量。