FastAPI中使用Lifespan Events初始化数据库连接后变量仍为None的问题

根本原因 #

你遇到的问题是Python变量作用域导致的：

• 在lifespan函数内直接赋值db_session = DBConnection(...)时，Python会创建一个局部变量，和全局作用域的db_session完全是两个独立变量，因此全局变量不会被修改。
• 即便使用global声明，这种全局变量的方式也不符合FastAPI的设计规范，还可能带来线程安全隐患（如果数据库连接不是异步安全的）。

正确解决方案：使用FastAPI的app.state存储共享资源 #

FastAPI提供了app.state专门用于存储应用级别的共享状态，这是初始化和访问数据库连接的标准方式。

修改后的代码示例 #

from fastapi import FastAPI, Request
from fastapi.staticfiles import StaticFiles
from fastapi.templating import Jinja2Templates
from contextlib import asynccontextmanager

# 你的DBConnection类示例（根据实际情况调整）
class DBConnection:
    def __init__(self, db_path):
        self.db_path = db_path
        # 模拟数据库连接初始化逻辑
        self._connection = "active_db_connection"
    
    def get_db_connection(self):
        return self._connection
    
    def get_test_value(self):
        return "valid_test_value"

class InitializationError(Exception):
    pass

@asynccontextmanager
async def lifespan(app: FastAPI):
    # 初始化数据库连接并存储到app.state
    app.state.db_session = DBConnection("file.db")
    if app.state.db_session.get_db_connection() is None:
        raise InitializationError("Could not access database file.")
    print(app.state.db_session.get_test_value())  # 输出有效值
    yield
    # 应用关闭时清理资源（如果需要）
    # 例如：await app.state.db_session.close()

app = FastAPI(lifespan=lifespan)
app.mount("/static", StaticFiles(directory="static"), name="static")
templates = Jinja2Templates(directory="templates")

# 示例路由：访问数据库连接
@app.get("/")
async def test_db_connection(request: Request):
    db_session = request.app.state.db_session
    return {"test_value": db_session.get_test_value()}

关键说明 #

1. 存储到app.state：在lifespan中将数据库连接赋值给app.state.db_session，这样连接会在整个应用生命周期内保持可用。
2. 路由中访问：在路由函数中，通过request.app.state获取共享的数据库连接，这是线程安全的访问方式。
3. 资源清理：在lifespan的yield之后可以添加数据库连接的关闭逻辑，确保应用退出时正确释放资源。

为什么之前的尝试无效？ #

• 直接赋值局部变量：会覆盖全局变量的引用，导致全局变量始终保持初始值。
• 使用列表/字典的误区：如果是修改列表/字典的内部元素（如db_session.append(...)或db_session["db"] = ...），理论上可以修改全局容器，但这种方式不规范，且不如app.state清晰可控。

内容的提问来源于stack exchange，提问作者guerda