如何在FastAPI中使用依赖注入来管理应用程序的共享依赖

FastAPI是一个用于构建API的现代框架，使用了Python的标准类型注释，使得开发API变得快速和简单。在这篇文章中，我们将介绍如何在FastAPI应用程序中使用依赖注入来管理共享依赖。

1. 什么是依赖注入

依赖注入（Dependency Injection）是一种设计模式，旨在通过将对象的创建和维护责任委托给依赖注入框架来提高代码的可维护性和可测试性。简单来说，就是将依赖的对象注入到对象的构造函数或者属性中，而不是在类内部使用导入等方式直接对其进行调用。

2. 快速入门

我们将使用FastAPI来演示如何使用依赖注入。首先安装FastAPI和uvicorn：

pip install fastapi

pip install uvicorn

然后，我们创建一个名为`main.py`的文件，包含以下内容：

from fastapi import FastAPI, Depends

app = FastAPI()
def fake_dependency():
    return {"message": "Hello World"}
@app.get("/")
async def root(dependency_data: dict = Depends(fake_dependency)):
    return dependency_data

这个例子创建了一个FastAPI应用程序，它定义了一个名为`fake_dependency()`的依赖项，它返回一个包含"Hello World"消息的字典。我们使用`Depends`装饰器将依赖项注入到`root()`函数中。在这个例子中，`root()`函数不需要直接实例化或调用`fake_dependency()`，而是使用注入的依赖项。

现在，我们可以使用uvicorn运行该应用程序：

uvicorn main:app --reload

在浏览器中访问`http://localhost:8000/`，将看到输出结果为`{"message": "Hello World"}`。

3. 使用依赖注入管理共享依赖

通过将依赖项注入到函数中，我们可以轻松共享依赖项。让我们使用一个例子来演示如何共享共享数据库连接实例。

首先，我们需要安装MongoDB的Python驱动程序`pymongo`。

pip install pymongo

然后，我们创建一个名为`mongo.py`的文件，包含以下内容：

from pymongo import MongoClient

class Mongo:
    def __init__(self, host: str):
        self.client = MongoClient(host)
    def get_collection(self, collection_name: str):
        return self.client.get_database()[collection_name]
mongo = Mongo("localhost")

这里我们编写了一个`Mongo`类，其中包含一个`__init__()`方法来初始化连接到MongoDB的客户端实例。然后，我们还定义了一个名为`mongo`的全局变量，它持有Mongo实例，可以在应用程序中使用。

接下来，我们需要在应用程序中编写一个依赖项，以便在请求中注入`mongo`实例。我们要使用`fastapi.dependencies.Depends()`函数来定义该依赖项:

from fastapi import Depends, FastAPI

from .mongo import Mongo, mongo
app = FastAPI()
def get_mongo():
    return mongo
@app.get("/")
async def root(mongo: Mongo = Depends(get_mongo)):
    return {"message": "Hello World"} 

在上述代码中，我们使用`get_mongo()`函数作为`Depends()`构造函数的参数，注入`mongo`全局变量中保存的`Mongo`实例。

现在，我们可以在路由函数中使用`mongo`实例来访问数据库：

async def get_user_by_name(username: str, mongo: Mongo = Depends(get_mongo)) -> dict:

    user = await mongo.get_collection("users").find_one({"username": username})
    return user if user else {"message": "User not found."}

在这个例子中，我们使用`mongo`实例来连接到名为"users"的MongoDB集合，并搜索与指定用户名匹配的用户。

结论

依赖注入是一种设计模式，可以将应用程序的依赖项注入到应用程序的其他部分，从而提高了代码的可维护性和可测试性。在FastAPI中使用依赖注入管理应用程序的共享依赖是非常简单的，只需要使用FastAPI提供的内置`Depends()`函数将依赖项注入到路由函数即可。这使得在FastAPI应用程序中管理MongoDB连接，共享缓存实例或应用程序配置等共享依赖项变得非常容易。