Bagaimana anda menangani WebSocket di FastAPI?

Question

Accepted Answer

FastAPI menyokong **WebSocket** untuk komunikasi real-time, bidireksional (chat, pembaruan langsung, notifikasi) melalui dekorator `@app.websocket`. Tidak seperti model permintaan-respons HTTP, koneksi WebSocket tetap terbuka, memungkinkan server dan klien mengirim pesan dengan bebas.

## Endpoint WebSocket dasar

```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)
```

Polanya: `accept()` koneksi, kemudian loop — `receive_text()`/`receive_json()` membaca pesan, `send_text()`/`send_json()` mengirimnya. Pengecualian `WebSocketDisconnect` menandakan klien pergi (di mana anda membersihkan).

## Menyiarkan ke beberapa klien (misalnya chat)

```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
```

Mengelola daftar koneksi aktif memungkinkan anda **menyiarkan** ke semua klien — dasar fitur chat dan pembaruan langsung.

## Peringatan penskalaan

```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.)
```

## Mengapa hal ini penting

WebSocket memungkinkan fitur **real-time, bidireksional** — chat, notifikasi langsung, kehadiran, pengeditan kolaboratif, dasbor langsung — yang model permintaan-respons HTTP tidak dapat berikan (server dapat mendorong ke klien, bukan hanya merespons).

Memahami dukungan WebSocket FastAPI berharga untuk membangun aplikasi interaktif modern: dekorator `@app.websocket` dengan loop accept/receive/send mencakup komunikasi real-time dasar, dan mengelola koneksi aktif memungkinkan **penyiaran** (inti fitur multi-pengguna seperti chat).

Fondasi asinkron FastAPI cocok untuk WebSocket.

Yang sangat penting adalah **peringatan penskalaan**: koneksi WebSocket bersifat stateful dan terikat ke satu instans server, jadi penskalaan di beberapa instans memerlukan **backplane Redis Pub/Sub** untuk meneruskan pesan antar instans — jebakan umum, karena (seperti sesi) status koneksi tidak dapat berada dalam memori satu proses saat menjalankan beberapa instans.

Memahami pola WebSocket dasar, penyiaran, penanganan putus sambung, dan pertimbangan penskalaan adalah pengetahuan tingkat senior yang penting untuk membangun pengalaman real-time, interaktif yang semakin diharapkan dalam aplikasi modern.