如何在Python异步Web框架中捕获客户端提前断开异常

夏强酱_3918

夏强酱_3918

2026-11-05

321人浏览

原创

应显式捕获 starlette.exceptions.ClientDisconnect 异常,而非 Exception 或 asyncio.CancelledError;它由 ASGI 服务器在客户端断连时主动抛出,用于及时终止流式响应并释放资源。

如何在python异步web框架中捕获客户端提前断开异常

FastAPI/Starlette 中如何识别 client disconnected 异常

在 FastAPI 或底层 Starlette 中,客户端提前关闭连接(比如用户刷新页面、网络中断、移动端切后台)会触发 ClientDisconnect 异常。它不会自动抛出,必须显式捕获——否则请求会静默失败或卡住,日志里也看不到明确线索。

常见错误现象:RuntimeError: Response closed 或 ConnectionResetError 出现在流式响应(如 StreamingResponse)中;或者异步任务持续运行却没人接收结果。

  • ClientDisconnect 是 Starlette 定义的异常,位于 starlette.exceptions,FastAPI 兼容它
  • 只在请求体已接收完成、但响应尚未写完时断开才触发该异常(例如正在 yield 数据)
  • 不能靠 try/except Exception 捕获,必须明确写 except ClientDisconnect
from starlette.exceptions import ClientDisconnect
from fastapi import FastAPI
<p>app = FastAPI()</p><p>@app.get("/stream")
async def stream_data():
try:
for i in range(10):
yield f"data: {i}\n\n"
await asyncio.sleep(1)
except ClientDisconnect:
print("客户端已断开,停止推送")
return  # 提前退出生成器
</p>

为什么 asyncio.CancelledError 不是可靠判断依据

有人尝试用 CancelledError 捕获断连,这是错的。它只在任务被显式 cancel() 时抛出,而客户端断开由 ASGI 服务器(如 Uvicorn)以 ClientDisconnect 通知应用层,两者机制不同。

Uvicorn 在检测到 socket 关闭后,会调用 scope["client"] 对应的 disconnect 逻辑,并让当前任务收到 ClientDisconnect;CancelledError 多半来自超时或手动取消,和网络断开无直接关系。

  • 依赖 CancelledError 会导致漏掉真实断连场景
  • 某些旧版 Uvicorn(ClientDisconnect,建议升级到最新稳定版
  • 若用 asyncio.wait_for 包裹流式逻辑,需注意:超时引发的 TimeoutError 和断连无关,别混为一谈

在中间件中统一处理断连是否可行

不可行。ASGI 中间件无法拦截已开始的响应流中的断连事件——因为 ClientDisconnect 发生在 await send(...) 调用时,而中间件只包裹 receive 和 send 的初始调用点,不介入后续多次 send。

也就是说,你可以在路由函数、依赖、或自定义 StreamingResponse 的 iterator 内部捕获,但没法在中间件里“全局兜底”。强行在中间件里 try/catch 不起作用。

Python Hardener
Python Hardener

通过完整的安全审查、代码整洁重构、健壮的错误处理、正确的日志记录以及完整的文档字符串覆盖,强化 Python 脚本。

下载
  • 想做统一日志?只能在每个流式端点里加 except ClientDisconnect 块
  • 想自动清理资源(如关闭数据库游标、取消后台任务)?必须在捕获后手动处理,框架不帮你做
  • 如果用了 BackgroundTasks,记得在 ClientDisconnect 后调用 task.cancel(),否则任务可能继续跑

使用 httpx.AsyncClient 请求时如何模拟断连测试

本地调试时很难手动“快速断开”,用 httpx.AsyncClient 配合 timeout 和 aclose() 可复现:

import httpx
import asyncio
<p>async def test_disconnect():
async with httpx.AsyncClient() as client:
resp = await client.get("<a href="https://www.php.cn/link/4c9aab06f63ad6870758bb31de6ecec1">https://www.php.cn/link/4c9aab06f63ad6870758bb31de6ecec1</a>", timeout=2)</p><h1>立即关闭连接,触发服务端 ClientDisconnect</h1><pre class="brush:php;toolbar:false;">    await client.aclose()
    # 此时服务端正在 yield,会收到异常

更贴近真实场景的做法是用 curl + Ctrl+C:启动流式接口后,在终端执行 curl https://www.php.cn/link/4c9aab06f63ad6870758bb31de6ecec1,几秒后按 Ctrl+C,服务端日志就能看到 ClientDisconnect 被捕获。

注意:浏览器开发者工具里“Cancel”请求,不一定触发 ClientDisconnect(取决于浏览器实现和 HTTP/2 支持),curl 最可靠。

真正难的是区分“用户主动放弃”和“网络抖动重试”——ClientDisconnect 本身不带上下文,你需要结合请求 ID、客户端 UA、重试头(如 Retry-After)自己判断。这点容易被忽略,但线上排查时很关键。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

python

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1871

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

5104

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1809

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

30737

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3647

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

3667

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1243

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

616

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2843

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程