contextvars.contextvar 是 python 异步链路中唯一可靠的上下文隔离方案,它能穿透所有异步边界(await、create_task、to_thread),需模块级定义、用 .get()/.set() 操作,且在 to_thread 中须手动传递重设。

asyncio contextvars 是唯一可靠方案
在 Python 异步链路中,threading.local 完全失效,因为协程可能跨线程调度、共享线程但不共享上下文。必须用 contextvars.ContextVar —— 它是 asyncio 原生支持的上下文隔离机制,能穿透 await、asyncio.create_task()、asyncio.to_thread() 等所有异步边界。
常见错误是试图复用同步场景下的装饰器 + 全局变量或用 inspect.currentframe() 拼 ID,结果在并发请求下 Request ID 串扰、丢失或重复。
-
ContextVar必须在模块顶层定义,不能在函数内重新创建同名变量 - 读写必须通过
.get()和.set(),直接赋值无效 - 若在
asyncio.to_thread()中使用,需手动传递并重设(见下文)
如何在 FastAPI / Starlette 中注入和透传 Request ID
FastAPI 的 Request 对象本身不携带上下文绑定能力,必须在中间件中捕获并写入 ContextVar;后续所有异步 handler、依赖、后台任务都自动继承该值。
关键点:中间件必须是 async def,且在 await call_next(request) 前完成 set,否则下游拿不到。
from contextvars import ContextVar
from fastapi import FastAPI, Request, Response
import uuid
<p>request_id_var = ContextVar("request_id", default=None)</p><div class="aritcle_card flexRow artxards">
<div class="artcardd flexRow">
<a class="aritcle_card_img" rel="nofollow" href="/xiazai/skill4102" title="Shadows Python Sensei"><img
src="https://img.php.cn/upload/skill/000/000/081/178990406882325.jpg" alt="Shadows Python Sensei" onerror="this.onerror='';this.src='/static/lhimages/moren/morentu.png'" ></a>
<div class="aritcle_card_info flexColumn">
<a rel="nofollow" href="/xiazai/skill4102" title="Shadows Python Sensei" class="overflowclass">Shadows Python Sensei</a>
<p class="overflowclass">Python 最佳实践助手——代码规范、设计模式、性能优化、测试与类型注解。适用于编写或审查 Python 代码。</p>
</div>
<a rel="nofollow" href="/xiazai/skill4102" title="Shadows Python Sensei" class="aritcle_card_btn flexRow flexcenter"><b></b><span>下载</span>
</a>
</div>
</div><p>@app.middleware("http")
async def inject_request_id(request: Request, call_next):
rid = request.headers.get("X-Request-ID") or str(uuid.uuid4())
token = request_id_var.set(rid) # ⚠️ 记得保存 token 用于 reset
try:
response = await call_next(request)
response.headers["X-Request-ID"] = rid
return response
finally:
request_id_var.reset(token) # 必须 reset,否则 context 泄漏
</p>
- 不 reset 会导致 contextvars 在某些 asyncio 版本中累积残留,尤其长连接或 uvicorn reload 后
- 不要在依赖项(Depends)里 set,它可能被多次调用,造成覆盖
- 日志库(如 structlog)需配置 processor 从
request_id_var.get()取值,而非依赖 logging.Logger 实例属性
跨线程操作(to_thread)时如何保持 Request ID
asyncio.to_thread() 会脱离当前 async context,ContextVar 在子线程中读不到值。必须显式捕获 + 传递 + 重设。
错误写法:await asyncio.to_thread(some_sync_func) —— some_sync_func 内调用 request_id_var.get() 返回 default。
- 正确做法:在主线程获取值,传入函数,并在函数入口立即
request_id_var.set(rid) - 若调用的是第三方 sync 库(无法改源码),可用
contextvars.copy_context()+ctx.run()包装执行 - 避免在 to_thread 中再起新 task,那又掉出上下文了
async def handle_with_thread():
rid = request_id_var.get()
return await asyncio.to_thread(_sync_work_with_rid, rid)
<p>def _sync_work_with_rid(rid):
request_id_var.set(rid) # ✅ 主动恢复</p><h1>此处可安全调用日志、DB driver 等</h1><p></p>
日志、数据库、HTTP 客户端如何自动携带 Request ID
不是“打日志时手动加字段”,而是让日志处理器、DB 连接池、HTTP client 自动读取 request_id_var.get() 并注入。否则每层都要显式传参,违背“全链路”初衷。
- structlog:用
structlog.contextvars.bind_contextvars(request_id=request_id_var.get())配合 processor - SQLAlchemy:在
engine.connect()或sessionmaker的scopefunc中返回request_id_var.get - httpx:用
EventHook或自定义AsyncClient子类,在send()前自动加 header - 注意:uvicorn 的 access log 默认不走你的日志系统,需关掉
--access-log=False并自行记录
最易被忽略的是:异步生成器(async def ... yield)、流式响应、WebSocket handler,它们的生命周期可能跨越多个 event loop 迭代,必须确保每次 await 后 context 仍有效 —— 这正是 contextvars 被设计解决的问题,但前提是别在中间误 reset 或覆盖。
Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!










