FastAPI异步依赖用yield管理资源
时间:2026-02-24 23:17:44 245浏览 收藏
本文深入解析了在FastAPI中安全管理异步资源(如数据库会话、HTTP客户端)的核心实践:由于FastAPI底层不支持直接使用`async def + yield`定义依赖,必须借助`@asynccontextmanager`将异步生成器封装为符合ASGI生命周期的异步上下文管理器,从而确保资源在请求开始时正确初始化、响应返回(或异常发生)后可靠清理;文章不仅厘清了常见误区(如误用异步生成器、手动await上下文、错误设置作用域),还强调了作用域选择、异常鲁棒性及资源共享边界等关键细节,是构建高可靠性异步Web服务不可或缺的实战指南。

FastAPI 依赖中用 yield 会报错:TypeError: async generator object is not awaitable
直接在 FastAPI 依赖函数里写 async def + yield 是不行的。FastAPI 默认只识别同步生成器(def + yield)或纯异步协程(async def + return),不支持异步生成器(async def + yield)。这是底层 Starlette 的限制,不是 FastAPI 的 bug。
正确写法:用 Depends 包裹 contextlib.asynccontextmanager
要让异步资源(比如 aiohttp.ClientSession、aiomysql.Pool、AsyncSession)安全地生命周期绑定到请求,必须走异步上下文管理器路线。FastAPI 本身不原生解析 async with,但能识别被 asynccontextmanager 装饰后的函数。
- 定义依赖时,用
@asynccontextmanager包装一个async def函数,里面yield资源实例 - 在路由中用
Depends(your_async_context_manager)注入 - FastAPI 会在请求开始时
await进入上下文,在响应返回后await退出上下文(包括异常路径)
from contextlib import asynccontextmanager
from fastapi import Depends
<p>@asynccontextmanager
async def get_db_session():
session = AsyncSessionLocal()
try:
yield session
finally:
await session.close()</p><p>@app.get("/items/")
async def read_items(db: AsyncSession = Depends(get_db_session)):
return await db.execute("SELECT * FROM items")
</p>别用 async def + yield 直接当依赖,也别手动 await 启动
以下写法全是错的:
async def bad_dep(): yield ...→ FastAPI 不识别,抛出TypeError- 试图在依赖里
await一个async with块再return→ 生命周期失控,资源可能提前释放或泄漏 - 把
asynccontextmanager返回的对象直接await→ 它不是协程,是上下文管理器实例
关键点在于:asynccontextmanager 把异步生成器转成了符合 ASGI 生命周期预期的上下文管理协议对象,FastAPI 内部会按需调用 __aenter__ 和 __aexit__。
注意嵌套依赖和作用域:scope="app" 不适用异步资源
异步资源(如数据库连接池、HTTP 客户端)通常不能设为 scope="app",因为它们需要按请求隔离或至少按任务隔离。FastAPI 的依赖作用域目前只支持 "app" 和 "request"(默认),没有 "task" 级别。
- 如果多个请求共用一个
aiohttp.ClientSession,没问题 —— 它本就是线程/协程安全的共享对象 - 但如果共用一个
AsyncSession,就可能引发状态污染或事务冲突 - 所以大多数情况应保持默认
scope="request",让每个请求拿到独立的yield实例
真正容易被忽略的是异常传播:asynccontextmanager 中 yield 后的代码(finally 块)一定会执行,但若 yield 期间抛出未捕获异常,__aexit__ 仍会被调用,此时你得确保清理逻辑能应对“资源处于半初始化/半失效”状态。
以上就是《FastAPI异步依赖用yield管理资源》的详细内容,更多关于的资料请关注golang学习网公众号!
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
501 收藏
-
327 收藏
-
366 收藏
-
314 收藏
-
420 收藏
-
371 收藏
-
138 收藏
-
414 收藏
-
478 收藏
-
176 收藏
-
321 收藏
-
466 收藏
-
280 收藏
-
- 前端进阶之JavaScript设计模式
- 设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
- 立即学习 543次学习
-
- GO语言核心编程课程
- 本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
- 立即学习 516次学习
-
- 简单聊聊mysql8与网络通信
- 如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
- 立即学习 500次学习
-
- JavaScript正则表达式基础与实战
- 在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
- 立即学习 487次学习
-
- 从零制作响应式网站—Grid布局
- 本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
- 立即学习 485次学习