FastAPI WebSocket.close 调用时现有的awaits会发生什么

在本文中，我们将介绍在 FastAPI 中使用 WebSocket 时，当调用 WebSocket.close 方法时，现有的awaits会发生什么。

了解 FastAPI WebSocket

FastAPI 是一个基于 Python 的现代、高性能、Web 框架。它提供了对 WebSocket 协议的原生支持，使得在构建实时应用程序时变得非常方便。

使用 FastAPI 进行 WebSocket 编程时，我们可以通过 WebSocket.connect 方法建立与客户端的连接，并返回一个 WebSocket 对象用于管理与客户端的通信。然后，我们可以使用该 WebSocket 对象的一些方法（如 send_text 和 receive_text）来发送和接收消息。

WebSocket.close 方法用于关闭与客户端的连接。但在关闭连接之前，我们需要了解一下当调用 WebSocket.close 方法时，现有的awaits会发生什么。

WebSocket.close 方法的行为

当我们调用 WebSocket.close 方法来关闭连接时，FastAPI 的 WebSocket 实现会相应地终止当前正在等待的任务（awaits）。

具体来说，如果在调用 WebSocket.close 方法之前，我们在某个任务中等待（await）了某个 WebSocket 对象的发送方法（如 send_text）或接收方法（如 receive_text）完成，而此时 WebSocket.close 方法被调用，那么该任务将被中断。

以下是一个示例，演示在 WebSocket 关闭时现有的awaits会发生什么：

from fastapi import FastAPI, WebSocket

app = FastAPI()

@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()
    # 等待接收消息
    message = await websocket.receive_text()
    print("Received message:", message)

    # WebSocket 关闭时现有的awaits会发生什么？
    await websocket.close()

    await websocket.send_text("Connection closed.")

在上述示例中，我们定义了一个 WebSocket endpoint，当客户端连接到该 endpoint 时，会立即发送一条消息。该消息通过 await websocket.receive_text() 方法接收。然后，我们调用了 WebSocket.close 方法来关闭连接。

由于 await websocket.receive_text() 正在等待该消息的到达，而在调用 WebSocket.close 方法后，该任务被中断。因此，代码中的 print(“Received message:”, message) 不会被执行。