FastAPIでWebSocketをどのように処理しますか？

Question

Accepted Answer

FastAPIは、`@app.websocket`デコレータを使用して、リアルタイムで双方向通信（チャット、ライブアップデート、通知）を行うための**WebSocket**をサポートしています。HTTPのリクエスト-レスポンスモデルとは異なり、WebSocket接続は開いたままになり、サーバーとクライアントがメッセージを自由に送受信できます。

## 基本的なWebSocketエンドポイント

```python
from fastapi import WebSocket, WebSocketDisconnect

@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()                  # accept the connection
    try:
        while True:
            data = await websocket.receive_text()    # receive a message from the client
            await websocket.send_text(f"Echo: {data}")  # send a message back
    except WebSocketDisconnect:
        print("client disconnected")           # handle disconnection (cleanup)
```

パターン：`accept()`で接続を受け入れ、ループを実行します。`receive_text()`/`receive_json()`はメッセージを読み取り、`send_text()`/`send_json()`は送信します。`WebSocketDisconnect`例外はクライアントが去ったことを示します（クリーンアップを行います）。

## 複数クライアントへのブロードキャスト（例：チャット）

```python
class ConnectionManager:
    def __init__(self): self.active: list[WebSocket] = []
    async def connect(self, ws): await ws.accept(); self.active.append(ws)
    def disconnect(self, ws): self.active.remove(ws)
    async def broadcast(self, msg):
        for conn in self.active:
            await conn.send_text(msg)          # send to ALL connected clients

manager = ConnectionManager()

@app.websocket("/chat")
async def chat(ws: WebSocket):
    await manager.connect(ws)
    try:
        while True:
            msg = await ws.receive_text()
            await manager.broadcast(msg)        # everyone gets the message
    except WebSocketDisconnect:
        manager.disconnect(ws)                  # remove on disconnect
```

アクティブな接続のリストを管理することで、すべてのクライアントに**ブロードキャスト**できます。これはチャットとライブアップデート機能の基礎です。

## スケーリング注意点

```text
⚠️ WebSocket connections are STATEFUL and live on ONE server instance.
To scale across multiple instances, use a Redis Pub/Sub (or similar) backplane so
messages/broadcasts reach clients connected to OTHER instances.
(Like sessions, don't keep connection state only in one process when scaling horizontally.)
```

## なぜ重要なのか

WebSocketは**リアルタイムで双方向**な機能（チャット、ライブ通知、プレゼンス、協調編集、ライブダッシュボード）を実現します。HTTPのリクエスト-レスポンスモデルではサーバーがクライアントにプッシュできません。

FastAPIのWebSocketサポートを理解することは、最新のインタラクティブアプリケーションを構築する上で価値があります。`@app.websocket`デコレータとaccept/receive/sendループは基本的なリアルタイム通信をカバーしており、アクティブな接続を管理することで**ブロードキャスト**（チャットのような複数ユーザー機能のコア）が実現できます。

FastAPIの非同期基盤はWebSocketに適しています。

重要なのは**スケーリング注意点**です。WebSocket接続はステートフルであり、単一のサーバーインスタンスに紐付いているため、複数インスタンス間でのスケーリングには、インスタンス間でメッセージをリレーする**Redis Pub/Subバックプレーン**が必要です。これは一般的な落とし穴です。セッションと同様に、複数インスタンスを実行する場合、接続状態は単一プロセスのメモリに存在できません。

基本的なWebSocketパターン、ブロードキャスト、切断処理、およびスケーリングの考慮事項を理解することは、現代のアプリケーションで期待されるリアルタイムで対話的な経験を構築するためのシニアレベルの知識として重要です。