当前位置:首页 > 文章列表 > 文章 > python教程 > FastAPI异步依赖用yield管理资源

FastAPI异步依赖用yield管理资源

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

fastapi 如何让依赖支持 yield(异步资源管理)

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.ClientSessionaiomysql.PoolAsyncSession)安全地生命周期绑定到请求,必须走异步上下文管理器路线。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 实例

真正容易被忽略的是异常传播:asynccontextmanageryield 后的代码(finally 块)一定会执行,但若 yield 期间抛出未捕获异常,__aexit__ 仍会被调用,此时你得确保清理逻辑能应对“资源处于半初始化/半失效”状态。

以上就是《FastAPI异步依赖用yield管理资源》的详细内容,更多关于的资料请关注golang学习网公众号!

交管12123官网入口及登录教程交管12123官网入口及登录教程
上一篇
交管12123官网入口及登录教程
12306已检票状态怎么查?
下一篇
12306已检票状态怎么查?
查看更多
最新文章
资料下载
查看更多
课程推荐
  • 前端进阶之JavaScript设计模式
    前端进阶之JavaScript设计模式
    设计模式是开发人员在软件开发过程中面临一般问题时的解决方案,代表了最佳的实践。本课程的主打内容包括JS常见设计模式以及具体应用场景,打造一站式知识长龙服务,适合有JS基础的同学学习。
    543次学习
  • GO语言核心编程课程
    GO语言核心编程课程
    本课程采用真实案例,全面具体可落地,从理论到实践,一步一步将GO核心编程技术、编程思想、底层实现融会贯通,使学习者贴近时代脉搏,做IT互联网时代的弄潮儿。
    516次学习
  • 简单聊聊mysql8与网络通信
    简单聊聊mysql8与网络通信
    如有问题加微信:Le-studyg;在课程中,我们将首先介绍MySQL8的新特性,包括性能优化、安全增强、新数据类型等,帮助学生快速熟悉MySQL8的最新功能。接着,我们将深入解析MySQL的网络通信机制,包括协议、连接管理、数据传输等,让
    500次学习
  • JavaScript正则表达式基础与实战
    JavaScript正则表达式基础与实战
    在任何一门编程语言中,正则表达式,都是一项重要的知识,它提供了高效的字符串匹配与捕获机制,可以极大的简化程序设计。
    487次学习
  • 从零制作响应式网站—Grid布局
    从零制作响应式网站—Grid布局
    本系列教程将展示从零制作一个假想的网络科技公司官网,分为导航,轮播,关于我们,成功案例,服务流程,团队介绍,数据部分,公司动态,底部信息等内容区块。网站整体采用CSSGrid布局,支持响应式,有流畅过渡和展现动画。
    485次学习
查看更多
AI推荐
  • ChatExcel酷表:告别Excel难题,北大团队AI助手助您轻松处理数据
    ChatExcel酷表
    ChatExcel酷表是由北京大学团队打造的Excel聊天机器人,用自然语言操控表格,简化数据处理,告别繁琐操作,提升工作效率!适用于学生、上班族及政府人员。
    4078次使用
  • Any绘本:开源免费AI绘本创作工具深度解析
    Any绘本
    探索Any绘本(anypicturebook.com/zh),一款开源免费的AI绘本创作工具,基于Google Gemini与Flux AI模型,让您轻松创作个性化绘本。适用于家庭、教育、创作等多种场景,零门槛,高自由度,技术透明,本地可控。
    4425次使用
  • 可赞AI:AI驱动办公可视化智能工具,一键高效生成文档图表脑图
    可赞AI
    可赞AI,AI驱动的办公可视化智能工具,助您轻松实现文本与可视化元素高效转化。无论是智能文档生成、多格式文本解析,还是一键生成专业图表、脑图、知识卡片,可赞AI都能让信息处理更清晰高效。覆盖数据汇报、会议纪要、内容营销等全场景,大幅提升办公效率,降低专业门槛,是您提升工作效率的得力助手。
    4293次使用
  • 星月写作:AI网文创作神器,助力爆款小说速成
    星月写作
    星月写作是国内首款聚焦中文网络小说创作的AI辅助工具,解决网文作者从构思到变现的全流程痛点。AI扫榜、专属模板、全链路适配,助力新人快速上手,资深作者效率倍增。
    5704次使用
  • MagicLight.ai:叙事驱动AI动画视频创作平台 | 高效生成专业级故事动画
    MagicLight
    MagicLight.ai是全球首款叙事驱动型AI动画视频创作平台,专注于解决从故事想法到完整动画的全流程痛点。它通过自研AI模型,保障角色、风格、场景高度一致性,让零动画经验者也能高效产出专业级叙事内容。广泛适用于独立创作者、动画工作室、教育机构及企业营销,助您轻松实现创意落地与商业化。
    4665次使用
微信登录更方便
  • 密码登录
  • 注册账号
登录即同意 用户协议隐私政策
返回登录
  • 重置密码