FastAPI 在 FastAPI 中一次性初始化重型服务的最佳方法

在本文中，我们将介绍在 FastAPI 中一次性初始化重型服务的最佳方法。FastAPI 是一个现代、快速（高性能）的 Web 框架，用于构建 API。它基于 Python 3.7+ 的标准类型提示，使代码具备更好的智能和编辑时错误检测。FastAPI 还集成了 Python 的异步特性，可以快速处理大量并发请求。

阅读更多：FastAPI 教程

背景

当我们使用 FastAPI 构建一个应用程序时，有时会遇到需要初始化一些重型服务的情况。这些服务需要比较长的时间进行初始化，而我们希望它们只被初始化一次并在整个应用程序的生命周期中共享。这可以节省资源，提高应用程序的性能和可伸缩性。

问题分析

在 FastAPI 中初始化重型服务的最佳方法是使用单例设计模式。单例是一种创建唯一实例的设计模式，它可以确保一个类只有一个实例存在，并提供全局访问点。

解决方案

为了实现单例模式，我们可以使用 Python 中的模块级别变量或 FastAPI 的依赖注入系统。下面是两种方法的示例说明。

使用模块级别变量

在这种方法中，我们可以在模块级别定义一个变量，用于存储实例化的服务。当我们第一次访问这个变量时，我们在其中初始化服务。之后，我们将重复使用这个已经实例化的服务。

# main.py
from heavy_service import HeavyService

heavy_service = None

def get_heavy_service():
    global heavy_service
    if heavy_service is None:
        heavy_service = HeavyService()
    return heavy_service

在上面的示例中，我们首先导入了 HeavyService 类。然后，我们定义了一个 heavy_service 的全局变量，并将其初始化为 None。在 get_heavy_service 函数中，我们检查 heavy_service 是否为 None，如果是，则实例化 HeavyService 类，并将其赋值给 heavy_service，然后返回该实例。

通过这种方式，我们可以确保 heavy_service 变量只会在第一次访问时进行初始化，并在整个应用程序的生命周期中共享。

使用 FastAPI 的依赖注入系统

FastAPI 提供了一个强大的依赖注入系统，可以方便地解决此类问题。我们可以使用 FastAPI 的 Depends 类来定义一个依赖项，然后在处理程序函数中使用它。

# main.py
from fastapi import Depends
from heavy_service import HeavyService

def get_heavy_service() -> HeavyService:
    return HeavyService()

@app.get("/example")
def example(heavy_service: HeavyService = Depends(get_heavy_service)):
    # 使用 heavy_service 进行操作
    pass

在上面的示例中，我们首先导入了 FastAPI 的 Depends 类和 HeavyService 类。然后，我们定义了一个 get_heavy_service 函数，它返回一个 HeavyService 实例。在 example 处理程序函数中，我们使用 heavy_service 参数来接受 HeavyService 实例，并使用它进行操作。

通过依赖注入系统，FastAPI 会自动管理和实例化依赖项，并且可以确保它们只会在需要时进行初始化。