FastAPI 通过 FastApi 平台全局变量不能正常工作

在本文中，我们将介绍 FastAPI 平台中全局变量无法正常工作的问题，并分析解决方案。

阅读更多：FastAPI 教程

问题描述

FastAPI 是一个基于 Python 的现代化 Web 框架，具有高性能和简洁的特点。但是，有时在使用 FastAPI 时，发现全局变量无法按照正常的方式进行工作。

具体而言，当我们在 FastAPI 的应用程序中定义全局变量时，期望这些变量能够在整个应用程序中被访问和修改。然而，在某些情况下，我们会发现全局变量的值并不像我们预期的那样被保留下来，或者被不同的请求共享。

问题分析

这个问题的根源是 FastAPI 的应用程序本质上是异步（asynchronous）的，而全局变量不适合在异步环境中使用。因为异步环境下，多个请求可能会同时访问同一个全局变量，可能会导致数据竞争（data race）和不可预测的结果。

解决方案

在 FastAPI 中解决这个问题有以下几种方式：

1. 使用依赖注入

依赖注入是一种将对象注入到需要它们的组件中的设计模式。在 FastAPI 中，我们可以使用 FastAPI 的依赖注入系统来传递变量或对象。

from fastapi import Depends, FastAPI

app = FastAPI()

async def get_global_var():
    return "global value"

@app.get("/")
async def root(global_var: str = Depends(get_global_var)):
    ...

在上面的例子中，我们通过 Depends 和 get_global_var 函数来传递全局变量 global_var。在每个请求中，通过调用 get_global_var 函数得到全局变量的值，然后传递给 root 函数。

2. 使用上下文变量

FastAPI 还提供了一个称为 Request 的上下文变量，可以用来存储每个请求的相关信息。我们可以利用这个上下文变量来共享一些需要在整个应用程序中访问的值。

from fastapi import FastAPI, Request

app = FastAPI()
app.state.global_var = "global value"

@app.get("/")
async def root(request: Request):
    global_var = request.app.state.global_var
    ...

在上述示例中，我们将全局变量存储在 app.state.global_var 中，在每个请求中，通过 request.app.state.global_var 来获取该值。

3. 使用数据库或缓存

如果需要在多个请求之间共享数据，一种常见的做法是使用数据库或者缓存。我们可以将需要共享的数据存储在数据库或者缓存中，并通过数据库查询或者缓存读取的方式来获取这些数据。

from fastapi import FastAPI
from tortoise import fields, models
from tortoise.contrib.fastapi import register_tortoise


class GlobalVar(models.Model):
    value = fields.CharField(max_length=255)

app = FastAPI()

@app.on_event("startup")
async def startup_event():
    await register_tortoise(
        app,
        db_url="sqlite://:memory:",
        modules={"models": ["main"]},
        generate_schemas=True,
        add_exception_handlers=True,
    )

@app.get("/")
async def root():
    global_var = await GlobalVar.get()
    ...

在上述示例中，我们通过 tortoise 数据库框架定义了一个 GlobalVar 模型，用于存储全局变量的值。在 root 函数中，通过调用 GlobalVar.get() 来获取全局变量的值。

总结

在本文中，我们介绍了 FastAPI 平台中全局变量无法正常工作的问题，并提供了几种解决方案。通过使用依赖注入、上下文变量或数据库和缓存，我们可以在 FastAPI 中实现全局变量的功能，并确保其可以在异步环境中正常工作。在选择解决方案时，需要根据具体的应用场景和需求来进行选择，并进行适当的权衡和调整。