FastAPI 预期的 ASGI 消息为 ‘websocket.accept’ 或 ‘websocket.close’，但收到了 ‘http.response.start’

在本文中，我们将介绍 FastAPI 中出现预期的 ASGI 消息为 ‘websocket.accept’ 或 ‘websocket.close’，但实际收到的是 ‘http.response.start’ 这一情况，并探讨可能的原因和解决方法。

阅读更多：FastAPI 教程

什么是 FastAPI?

FastAPI 是一个高性能的现代 Web 框架，基于 Python 3.6+ 的异步编程风格构建。它通过使用类型提示和异步特性，提供了强大的静态类型检测和高效的运行时性能。FastAPI 还集成了自动文档生成、输入数据验证和基于 OAuth2 的认证功能，是建立高性能 Web 应用程序的理想选择。

ASGI (Asynchronous Server Gateway Interface)

ASGI 是一个标准化的异步框架接口，用于 Python Web 应用程序和 Web 服务器之间的通信。FastAPI 依赖于 ASGI 来处理请求和响应，从而实现了高性能和并发。

错误现象

当我们在使用 FastAPI 构建的应用程序中进行 WebSocket 通信时，有时可能会遇到上述错误消息：”预期的 ASGI 消息为 ‘websocket.accept’ 或 ‘websocket.close’，但收到了 ‘http.response.start'”。这意味着 FastAPI 在处理 WebSocket 连接时预期收到的消息与实际收到的消息不符。

可能的原因

出现这个错误通常有以下几种可能的原因：

使用了错误的路由处理函数：在处理 WebSocket 连接时，应使用带有 WebSocket 类型提示的函数，并使用 async 关键字声明为异步函数。如果使用了错误的处理函数，FastAPI 可能会将其错误地识别为 HTTP 请求处理而不是 WebSocket 连接处理。
未正确处理 WebSocket 连接阶段：WebSocket 连接建立的过程包括三个阶段：连接建立、接受连接和关闭连接。如果在这些阶段返回了错误的 ASGI 消息类型，FastAPI 可能会引发上述错误。
使用了不兼容的 ASGI 服务器：FastAPI 依赖于 ASGI 服务器来处理请求和响应。如果使用了不兼容的 ASGI 服务器，可能导致消息类型不匹配的错误。

解决方法

针对上述可能的原因，我们可以采取以下解决方法：

使用正确的路由处理函数：确保在处理 WebSocket 连接时使用带有 WebSocket 类型提示的函数，并使用 async 关键字声明为异步函数。例如：

from fastapi import FastAPI, WebSocket

app = FastAPI()

@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
    # WebSocket 连接处理逻辑
    await websocket.accept()
    while True:
        data = await websocket.receive_text()
        # 处理接收到的数据

正确处理 WebSocket 连接阶段：在处理 WebSocket 连接时，确保正确地实现连接建立、接受连接和关闭连接的逻辑，并返回相应的 ASGI 消息类型。例如：

@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()

    try:
        while True:
            data = await websocket.receive_text()
            # 处理接收到的数据
    except WebSocketDisconnect:
        await websocket.close()

使用兼容的 ASGI 服务器：FastAPI 可以与多种 ASGI 服务器兼容，如 uvicorn、daphne 等。确保使用兼容的 ASGI 服务器来运行 FastAPI 应用程序，以避免消息类型不匹配的错误。

总结

在本文中，我们介绍了在使用 FastAPI 构建的应用程序中出现预期的 ASGI 消息为 ‘websocket.accept’ 或 ‘websocket.close’，但实际收到的是 ‘http.response.start’ 这一情况。我们讨论了可能的原因，包括使用错误的路由处理函数、未正确处理 WebSocket 连接阶段和使用不兼容的 ASGI 服务器。我们还提供了相应的解决方法，包括使用正确的路由处理函数、正确处理 WebSocket 连接阶段和使用兼容的 ASGI 服务器来运行 FastAPI 应用程序。通过了解和解决这些问题，我们可以更好地使用 FastAPI 进行 WebSocket 通信，并构建高性能的 Web 应用程序。