Uvicorn项目中WebSocket断开连接后协程未完成的解决方案

在FastAPI和Uvicorn项目中处理WebSocket连接时，开发者可能会遇到一个常见问题：当WebSocket连接意外断开后，后续的协程任务无法正常完成执行。本文将深入分析这一问题的成因，并提供有效的解决方案。

问题现象分析

在FastAPI应用中，当WebSocket连接建立后，如果客户端突然断开连接，服务器端捕获WebSocketDisconnect异常后尝试执行一些异步操作（如HTTP请求）时，这些操作会被意外取消。具体表现为：

1. 在WebSocket断开后的异常处理块中发起的异步HTTP请求会被中断
2. 后续的日志记录语句不会执行
3. 控制台会输出CancelledError异常

问题根源

这种现象的根本原因在于FastAPI/Starlette/Uvicorn的WebSocket处理机制。当WebSocket连接断开时，整个请求上下文会被取消，包括所有相关的异步任务。这种设计是为了确保资源能够及时释放，避免内存泄漏。

在底层实现上，这通过AnyIO或asyncio的任务取消机制实现。当WebSocket断开时，框架会取消所有相关的协程，导致正在执行的异步操作被中断。

解决方案

要解决这个问题，我们需要使用"屏蔽取消"(shield)机制来保护关键操作不被意外取消。根据使用的异步库不同，有两种实现方式：

使用AnyIO的解决方案

import anyio

async def websocket_handler(websocket: WebSocket):
    try:
        await websocket.accept()
        # 正常WebSocket处理逻辑
    except WebSocketDisconnect:
        async with anyio.create_task_group() as tg:
            with anyio.CancelScope(shield=True):
                # 受保护的异步操作
                client = httpx.AsyncClient(timeout=10)
                resp = await client.get("https://example.com/api")
                logging.warning("操作完成")

使用asyncio的解决方案

import asyncio

async def websocket_handler(websocket: WebSocket):
    try:
        await websocket.accept()
        # 正常WebSocket处理逻辑
    except WebSocketDisconnect:
        try:
            # 受保护的异步操作
            await asyncio.shield(
                httpx.AsyncClient(timeout=10).get("https://example.com/api")
            )
            logging.warning("操作完成")
        except Exception as e:
            logging.error(f"操作失败: {e}")

最佳实践建议

1. 精确控制屏蔽范围：只屏蔽真正需要完成的操作，避免过度使用shield导致资源无法及时释放
2. 异常处理：即使在屏蔽块中，也要妥善处理可能发生的异常
3. 超时设置：为受保护的操作设置合理的超时时间，避免长时间阻塞
4. 资源清理：确保在操作完成后正确关闭和清理资源（如HTTP客户端）

总结

在Uvicorn和FastAPI项目中处理WebSocket断开后的异步操作时，理解框架的取消机制至关重要。通过合理使用取消屏蔽技术，可以确保关键操作能够完整执行，同时保持系统的健壮性和资源管理效率。开发者应根据具体场景选择AnyIO或asyncio的实现方式，并遵循最佳实践来构建可靠的WebSocket应用。