FastAPI：如何定义一个全局变量

在本文中，我们将介绍如何在FastAPI中定义一个全局变量，并确保它只被实例化一次。全局变量是在整个应用程序中可用的变量，可以通过不同的函数和模块进行访问和修改。

阅读更多：FastAPI 教程

为什么使用全局变量

使用全局变量的主要目的是在应用程序的不同部分共享数据。全局变量可以避免多次实例化相同的对象，从而提高应用程序的性能和效率。

在FastAPI中，定义一个全局变量可以让我们在整个应用程序中使用相同的实例，而不需要每次请求时重新创建对象。

在FastAPI中定义全局变量

在FastAPI中定义一个全局变量有多种方法。以下是两种常用的方法：

方法一：使用单例模式

单例模式是一种创建对象的设计模式，确保一个类只有一个实例存在，并提供全局访问点。

在Python中，我们可以使用元类实现单例模式。以下是一个使用单例模式定义全局变量的示例：

class Singleton(type):
    _instances = {}

    def __call__(cls, *args, **kwargs):
        if cls not in cls._instances:
            cls._instances[cls] = super().__call__(*args, **kwargs)
        return cls._instances[cls]

class AppConfig(metaclass=Singleton):
    def __init__(self):
        # 初始化全局变量
        self.global_variable = "Hello, world!"

在上面的示例中，我们定义了一个名为AppConfig的单例类，并将其实例化为全局变量。在每次访问AppConfig类时，都会返回同一个实例。

要在FastAPI应用程序中使用该全局变量，只需导入AppConfig类，并使用其实例访问全局变量即可：

from fastapi import FastAPI
from .app_config import AppConfig

app = FastAPI()

@app.get("/")
def read_global_variable():
    # 访问全局变量
    config = AppConfig()
    return {"global_variable": config.global_variable}

方法二：使用FastAPI的Depends注解

FastAPI提供了Depends注解，可以用于定义全局变量并确保其只被实例化一次。以下是一个使用Depends注解定义全局变量的示例：

from fastapi import FastAPI, Depends
from .app_config import get_app_config

app = FastAPI()

@Depends(get_app_config)
def global_variable():
    # 初始化全局变量
    return "Hello, world!"

@app.get("/")
def read_global_variable(config = Depends(global_variable)):
    # 访问全局变量
    return {"global_variable": config}

在上面的示例中，我们定义了一个名为global_variable的依赖项函数，并使用Depends注解将其用作全局变量。

要在FastAPI应用程序中使用该全局变量，只需将其作为参数传递给路由处理程序函数即可。