如何在FastAPI中实现类类型依赖注入？现有代码报错求助

问题根源 #

你遇到的错误是因为FastAPI会自动尝试将共享依赖的返回值纳入OpenAPI文档的响应模型，但MyServerConfig和DependencyContainer不是Pydantic模型，无法被识别为合法的字段类型。另外，路由里的空Depends()没有指定依赖函数，也会导致注入失败。

修正步骤 #

1. 调整依赖函数与实例初始化逻辑 #

先修正代码里的语法错误（比如DependencyContainer的方法缺少self参数、变量名大小写不统一），再明确依赖获取函数的定义：

# main.py
from fastapi import Depends, FastAPI
import grpc
from os import getenv
import somemodule

class MyServerConfig:
    def __init__(self):
        serviceA_host = getenv("SERVICE_A_HOST")
        serviceA_port = getenv("SERVICE_A_PORT")
        self._serviceA_addr = f"{serviceA_host}:{serviceA_port}"

class DependencyContainer:
    def __init__(self, config: MyServerConfig):
        self._serviceA_channel = grpc.insecure_channel(config._serviceA_addr)
        self._serviceA_client = SomeGrpcStub(self._serviceA_channel)
    
    def service_a_client(self):
        return self._serviceA_client

# 预初始化全局单例实例
config = MyServerConfig()
dependency_container = DependencyContainer(config)

# 定义依赖获取函数
def get_dependency_container() -> DependencyContainer:
    return dependency_container

def get_server_config() -> MyServerConfig:
    return config

app = FastAPI()

2. 移除共享依赖的错误用法，直接在路由中注入 #

不要把需要注入的实例放在路由的dependencies参数里（FastAPI会误将其解析为响应字段），而是通过路由函数的参数直接注入：

# main.py 续
app.include_router(
    somemodule.products_router_v1(),
    prefix="/v1"
)

3. 调整路由模块的注入逻辑 #

在路由函数中通过Depends()指定对应的依赖获取函数：

# somemodule.py
from fastapi import APIRouter, Depends, Request
from pydantic import BaseModel
# 导入定义好的类
from main import DependencyContainer, MyServerConfig, get_dependency_container, get_server_config

class SaveProductRequest(BaseModel):
    # 定义请求字段
    product_name: str
    price: float

class Response(BaseModel):
    # 定义响应字段
    product_id: str
    status: str

def products_router_v1():
    products_router = APIRouter(prefix="/products")

    @products_router.post("", response_model=Response)
    def register_product(
        save_request: SaveProductRequest,
        http_request: Request,
        # 明确指定依赖函数完成注入
        dependency_container: DependencyContainer = Depends(get_dependency_container),
        server_config: MyServerConfig = Depends(get_server_config)
    ):
        # 使用注入的实例
        service_a_client = dependency_container.service_a_client()
        # 执行业务逻辑
        return Response(product_id="123", status="success")
    
    return products_router

4. 可选：用Lifespan管理实例生命周期 #

如果需要规范管理实例的启动/销毁（比如关闭GRPC通道），可以用FastAPI的Lifespan函数：

# main.py 替换实例初始化部分
def lifespan(app: FastAPI):
    # 启动时初始化
    config = MyServerConfig()
    dep_container = DependencyContainer(config)
    app.state.config = config
    app.state.dep_container = dep_container
    yield
    # 关闭时清理资源
    dep_container._serviceA_channel.close()

app = FastAPI(lifespan=lifespan)

# 调整依赖函数从app.state获取实例
def get_dependency_container(app: FastAPI = Depends()) -> DependencyContainer:
    return app.state.dep_container

def get_server_config(app: FastAPI = Depends()) -> MyServerConfig:
    return app.state.config

关键注意点 #

• 非Pydantic类的实例不要放在路由的dependencies参数中，避免FastAPI误将其解析为响应模型字段。
• 路由中使用Depends()必须指定对应的依赖函数，空Depends()会尝试创建类的新实例（而非复用预初始化的单例）。
• 确保依赖函数返回预初始化的单例，避免重复创建资源（比如GRPC通道）。

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