FastAPI 中如何使用 Depends 进行依赖注入？

推荐答案

在 FastAPI 中，Depends 是用于依赖注入的核心工具。通过 Depends，你可以将依赖项注入到路径操作函数中，从而实现代码的复用和模块化。以下是一个简单的示例：

-- -------------------- ---- -------
---- ------- ------ -------- -------

--- - ---------

--- ---------
    -- - --------------------
    ------ --

-------------------
--- -------------- --- - -----------------
    ------ ------ ---

在这个示例中，get_db 函数是一个依赖项，它返回一个模拟的数据库连接。read_items 路径操作函数通过 Depends(get_db) 注入了这个依赖项。

本题详细解读

1. 依赖注入的概念

依赖注入（Dependency Injection, DI）是一种设计模式，用于实现控制反转（Inversion of Control, IoC）。通过依赖注入，对象的依赖关系由外部容器在运行时动态注入，而不是在代码中硬编码。这种方式使得代码更加模块化、可测试和可维护。

2. FastAPI 中的 Depends

在 FastAPI 中，Depends 是一个用于依赖注入的工具。它允许你将函数或类作为依赖项注入到路径操作函数中。依赖项可以是任何可调用对象，如函数、类或异步函数。

3. 使用 Depends 的步骤

1. 定义依赖项：首先，你需要定义一个依赖项函数或类。这个函数或类可以执行一些初始化操作，并返回一个值或对象。

   def get_db():
       db = "fake_db_connection"
       return db

2. 注入依赖项：在路径操作函数中，使用 Depends 将依赖项注入到函数参数中。

   @app.get("/items/")
   def read_items(db: str = Depends(get_db)):
       return {"db": db}

3. 使用依赖项：在路径操作函数中，你可以直接使用注入的依赖项。

   @app.get("/items/")
   def read_items(db: str = Depends(get_db)):
       return {"db": db}

4. 依赖项的作用域

FastAPI 中的依赖项可以是全局的，也可以是局部的。全局依赖项在整个应用程序中共享，而局部依赖项仅在特定的路径操作函数中使用。

5. 异步依赖项

如果依赖项是异步的，你可以使用 async def 定义依赖项函数，并在路径操作函数中异步调用它。

async def get_async_db():
    db = "fake_async_db_connection"
    return db

@app.get("/items/")
async def read_items(db: str = Depends(get_async_db)):
    return {"db": db}

6. 依赖项的嵌套

你可以在一个依赖项中调用另一个依赖项，从而实现依赖项的嵌套。

-- -------------------- ---- -------
--- ---------
    -- - --------------------
    ------ --

--- ------------ --- - -----------------
    ---- - -----------
    ------ ----

-------------------
--- --------------- --- - -------------------
    ------ -------- -----

7. 依赖项的生命周期

FastAPI 中的依赖项在每次请求时都会被调用，因此它们的状态不会在请求之间共享。如果你需要在多个请求之间共享状态，可以考虑使用 lru_cache 或其他缓存机制。

-- -------------------- ---- -------
---- --------- ------ ---------

------------
--- ----------------
    -- - ---------------------------
    ------ --

-------------------
--- -------------- --- - ------------------------
    ------ ------ ---

通过以上步骤，你可以在 FastAPI 中灵活地使用 Depends 进行依赖注入，从而实现代码的模块化和复用。