1. 为什么依赖注入是FastAPI开发的核心武器
作为一个用FastAPI重构过三个生产系统的老鸟,我必须说依赖注入(Dependency Injection)是这个框架最被低估的特性。很多人只把它当作传递数据库连接的工具,但实际上它彻底改变了我们组织Web应用逻辑的方式。
去年我们团队接手了一个支付网关项目,最初版本把所有逻辑都堆在路由函数里——300行的函数处理JWT验证、数据库查询、金额计算和响应格式化。当需要添加风控模块时,几乎要重写整个服务。而用依赖注入重构后,每个功能模块像乐高积木一样可以自由组合。认证逻辑只需要这样声明:
async def verify_token(authorization: str = Header(...)): try: payload = jwt.decode(authorization, SECRET_KEY) return User(id=payload["sub"]) except JWTError: raise HTTPException(status_code=401) @app.get("/transactions") async def list_transactions(user: User = Depends(verify_token)): # 直接使用已认证的用户对象这种声明式开发带来的可维护性提升是颠覆性的。当审计要求增加IP检查时,我们只需要修改verify_token依赖项,所有路由自动获得新能力。更妙的是,这些依赖项本身也可以依赖其他服务,形成清晰的依赖树。
2. FastAPI依赖注入的四种实战模式
2.1 基础依赖:从配置管理到请求预处理
最简单的依赖就像注入配置参数。比如我们有个需要动态调整的费率系统:
class RateConfig: def __init__(self): self.fee_rate = 0.015 # 默认1.5% def get_rate_config() -> RateConfig: return RateConfig() @app.post("/pay") async def create_payment( config: RateConfig = Depends(get_rate_config), amount: float ): fee = amount * config.fee_rate # ...但更强大的用法是请求预处理。最近我们实现了一个智能分页系统:
class Pagination: def __init__(self, page: int = 1, size: int = 20): self.page = max(1, page) self.size = min(50, size) @app.get("/products") async def list_products(pg: Pagination = Depends()): skip = (pg.page - 1) * pg.size return await Product.find().skip(skip).limit(pg.size)注意这里Depends()直接作用在类上,FastAPI会自动解析查询参数。这种模式让分页逻辑与业务代码完全解耦。
2.2 分层依赖:构建服务依赖链
在电商系统中,订单创建需要经过:
- 用户认证
- 库存检查
- 风控审核
- 支付处理
用依赖链可以优雅地表达这个流程:
async def validate_stock(items: List[Item]): for item in items: if await Inventory.check(item.id) < item.qty: raise HTTPException(400, f"Insufficient stock for {item.id}") async def create_order( user: User = Depends(verify_token), _ = Depends(validate_stock), items: List[Item] = Body(...) ): order = await Order.create(user.id, items) await RiskControl.check(order) return await Payment.process(order)每个Depends都是可复用的业务单元,测试时还能轻松mock任意环节。
2.3 基于yield的资源管理
数据库连接是最典型的用例:
async def get_db(): async with AsyncSessionLocal() as session: try: yield session await session.commit() except Exception: await session.rollback() raise finally: await session.close()但很多人不知道这个模式还能用于更复杂的场景。比如我们实现的分布式锁:
@contextlib.asynccontextmanager async def acquire_lock(key: str, ttl: int = 30): redis = Redis() if not await redis.setnx(key, "1", ex=ttl): raise HTTPException(429, "Operation in progress") try: yield finally: await redis.delete(key) @app.post("/inventory/adjust") async def adjust_inventory( _ = Depends(acquire_lock("inventory_lock")) ): # 保证同一时间只有一个调整操作2.4 动态依赖:运行时决策
通过传递依赖函数实现动态逻辑。比如多租户系统中的数据库路由:
def get_tenant_db(tenant_id: str = Header("X-Tenant-ID")): if tenant_id == "A": return DatabaseA elif tenant_id == "B": return DatabaseB @app.get("/data") async def get_data(db = Depends(get_tenant_db)): return await db.query(...)更高级的用法是动态校验规则。我们在内容审核系统里这样实现:
def create_validator(rules: List[Rule]): async def validate(content: str = Body(...)): for rule in rules: if not rule.check(content): raise HTTPException(400, f"Violates {rule.name}") return validate # 路由注册时动态注入 app.add_api_route( "/posts", create_post, dependencies=[Depends(create_validator(get_rules()))] )3. 性能优化:依赖注入的隐藏技巧
3.1 依赖缓存机制
默认情况下,FastAPI会对每个请求的依赖项重新计算。但通过use_cache参数可以改变这个行为:
@app.get("/heavy") async def heavy_computation( # 这个复杂计算结果会被缓存 result: float = Depends(calculate, use_cache=True) ): return {"result": result}我们在报表生成系统中用这个特性缓存模板解析结果,QPS提升了3倍。但要特别注意:永远不要缓存有状态的对象,比如数据库连接应该始终保持use_cache=False。
3.2 异步依赖的并行加载
当多个独立依赖可以并行执行时:
async def get_user(): await asyncio.sleep(1) return User() async def get_news(): await asyncio.sleep(1) return News() @app.get("/dashboard") async def dashboard( user: User = Depends(get_user), news: News = Depends(get_news) ): # 总耗时≈1s而非2s return {**user.dict(), "news": news}这个特性让我们的聚合接口响应时间从320ms降到了180ms。关键是要确保依赖之间没有先后关系。
3.3 依赖项预加载模式
对于启动时需要初始化的组件(如AI模型),可以用lifespan事件配合依赖:
class ModelContainer: model = None @classmethod async def load(cls): cls.model = await load_heavy_model() async def get_model(): if ModelContainer.model is None: raise RuntimeError("Model not loaded") return ModelContainer.model @app.on_event("startup") async def startup(): await ModelContainer.load() @app.post("/predict") async def predict(model = Depends(get_model)): return model.predict(...)4. 大型项目中的依赖架构设计
4.1 分层架构实践
我们的支付系统采用清晰的三层依赖结构:
请求层依赖 ├─ 认证守卫 ├─ 限流控制 └─ 日志追踪 业务层依赖 ├─ 支付处理器 ├─ 风控引擎 └─ 会计系统 数据层依赖 ├─ 主数据库 ├─ 缓存集群 └─ 消息队列对应的代码组织:
dependencies/ ├─ auth.py # 请求层 ├─ business/ # 业务层 │ ├─ payment.py │ └─ risk.py └─ infra/ # 基础设施层 ├─ database.py └─ redis.py4.2 依赖项的生命周期管理
对于需要复杂初始化的服务,我们采用这种模式:
class NotificationService: _client = None @classmethod async def start(cls): cls._client = EmailClient( host=settings.EMAIL_HOST, timeout=10 ) @classmethod async def shutdown(cls): if cls._client: await cls._client.close() @classmethod async def get(cls): if cls._client is None: raise RuntimeError("Service not started") return cls._client # 在FastAPI lifespan中管理 app.router.lifespan_context = lambda: { "startup": NotificationService.start, "shutdown": NotificationService.shutdown }4.3 依赖覆盖与测试技巧
在测试时替换生产依赖非常方便:
@pytest.fixture def client(): # 覆盖真实数据库依赖 def mock_db(): return TestDatabase() app.dependency_overrides[get_db] = mock_db return TestClient(app) async def test_create_order(client): # 使用模拟数据库运行测试 response = client.post("/orders", json={...}) assert response.status_code == 201我们甚至开发了一个依赖标记系统来批量切换环境:
@dependency(env="staging") def get_redis(): return Redis(host="redis.staging") @dependency(env="prod") def get_redis(): return Redis(host="redis.prod.svc")5. 那些年我们踩过的坑
5.1 循环依赖陷阱
曾经我们这样组织代码:
# auth.py def get_current_user(db = Depends(get_db)): ... # database.py def get_db(settings = Depends(get_settings)): ... # settings.py def get_settings(user = Depends(get_current_user)): # 循环了! ...解决方案是重构为层级明确的依赖树。现在我们强制要求:
- 基础设施层不能依赖业务层
- 业务层不能依赖表现层
5.2 状态污染问题
早期我们犯过在类依赖中保存状态的错误:
class Counter: def __init__(self): self.value = 0 def get_counter(): return Counter() @app.get("/count") async def count(counter: Counter = Depends(get_counter)): counter.value += 1 return counter.value # 每次请求都会递增!正确的做法是要么用use_cache=True明确声明共享状态,要么保持无状态。
5.3 异步上下文管理器的遗漏
这样的代码会导致连接泄漏:
async def get_db(): return AsyncSessionLocal() # 没有yield或try/finally @app.get("/users") async def get_users(db = Depends(get_db)): # 如果抛出异常,session不会自动关闭 return await db.query(User)现在我们团队有Code Review检查清单,确保每个资源类依赖都正确实现了上下文管理。