FastAPI WebSocket并发处理教程

1. WebSocket简介

WebSocket是一种网络通信协议，它允许在单个TCP连接上进行全双工通信。与传统的HTTP请求不同，WebSocket提供了持久的连接，使得服务器和客户端可以实时交换数据，非常适合聊天应用、实时游戏、股票行情等场景。

2. FastAPI中的WebSocket支持

FastAPI基于Starlette构建，原生支持WebSocket协议。它提供了简单易用的方式来定义WebSocket端点，并利用Python的异步特性来处理高并发连接，无需额外配置就能实现非阻塞通信。

3. 异步编程基础

为了理解WebSocket并发处理，您需要了解Python的异步编程。异步编程使用async和await关键字，允许程序在等待IO操作（如网络请求）时执行其他任务，从而避免阻塞，提高并发性能。FastAPI默认使用异步服务器（如Uvicorn），天生适合处理并发连接。

4. 定义WebSocket端点

在FastAPI中，通过@app.websocket装饰器可以轻松定义WebSocket端点。以下是一个基本示例，展示如何创建接收和发送消息的WebSocket路由：

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()
        # 发送回执消息
        await websocket.send_text(f"服务器已接收: {data}")

这个例子中，/ws是WebSocket路径，服务器会持续监听客户端消息并回复。

5. 并发处理原理

FastAPI通过异步服务器（如Uvicorn）运行，该服务器使用事件循环（event loop）来管理多个并发连接。对于WebSocket，每个连接在独立的协程中运行，这样即使有大量客户端同时连接，也不会阻塞服务器。服务器会根据资源自动处理并发，但您也可以通过配置（例如Uvicorn的工作线程数）来优化性能。

6. 示例：处理多个WebSocket连接

在实际应用中，经常需要处理多个WebSocket连接，并实现广播或群发功能。以下是一个示例，展示如何在FastAPI中管理连接列表并广播消息：

from fastapi import FastAPI, WebSocket
from typing import List

app = FastAPI()
# 存储活跃连接
connections: List[WebSocket] = []

@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()
    connections.append(websocket)
    try:
        while True:
            data = await websocket.receive_text()
            # 广播消息到所有其他连接（不包括发送者）
            for connection in connections:
                if connection != websocket:
                    await connection.send_text(f"广播消息: {data}")
    except Exception as e:
        print(f"连接错误: {e}")
    finally:
        # 连接关闭时清理
        connections.remove(websocket)
        await websocket.close()

这个示例维护了一个全局连接列表，实现消息广播。注意要添加错误处理和资源清理，以避免内存泄漏。

7. 最佳实践和常见问题

• 资源管理：确保在连接断开时从列表中移除WebSocket对象，防止内存泄漏。
• 错误处理：使用try-except块捕获异常，如websocket.receive_text()可能引发断开错误，以保持应用程序稳定。
• 性能调优：对于高并发场景，可以考虑使用消息队列（如Redis）或异步任务工具（如Celery）来分发负载，避免在单个服务器上处理过多连接。
• 测试并发：使用工具（如websocket-client库）模拟多个客户端连接，测试并发处理能力。

8. 总结

FastAPI结合Python的异步特性，为WebSocket并发处理提供了强大而简单的解决方案。通过掌握异步编程基础和合理设计端点，您可以轻松构建实时应用程序。本教程帮助您入门WebSocket并发处理，逐步实践能提升技能。如有疑问，请参考FastAPI官方文档以获取更多高级功能。