6.0 KiB
WebSockets
Sie können WebSockets mit FastAPI verwenden.
WebSockets installieren
Zuerst müssen Sie WebSockets installieren:
$ pip install websockets
---> 100%
WebSockets-Client
In Produktion
In Ihrem Produktionssystem haben Sie wahrscheinlich ein Frontend, das mit einem modernen Framework wie React, Vue.js oder Angular erstellt wurde.
Und um über WebSockets mit Ihrem Backend zu kommunizieren, würden Sie wahrscheinlich die Werkzeuge Ihres Frontends verwenden.
Oder Sie verfügen möglicherweise über eine native Mobile-Anwendung, die direkt in nativem Code mit Ihrem WebSocket-Backend kommuniziert.
Oder Sie haben andere Möglichkeiten, mit dem WebSocket-Endpunkt zu kommunizieren.
Für dieses Beispiel verwenden wir jedoch ein sehr einfaches HTML-Dokument mit etwas JavaScript, alles in einem langen String.
Das ist natürlich nicht optimal und man würde das nicht in der Produktion machen.
In der Produktion hätten Sie eine der oben genannten Optionen.
Aber es ist die einfachste Möglichkeit, sich auf die Serverseite von WebSockets zu konzentrieren und ein funktionierendes Beispiel zu haben:
{* ../../docs_src/websockets/tutorial001.py hl[2,6:38,41:43] *}
Einen websocket erstellen
Erstellen Sie in Ihrer FastAPI-Anwendung einen websocket:
{* ../../docs_src/websockets/tutorial001.py hl[1,46:47] *}
/// note | Technische Details
Sie können auch from starlette.websockets import WebSocket verwenden.
FastAPI stellt den gleichen WebSocket direkt zur Verfügung, als Annehmlichkeit für Sie, den Entwickler. Er kommt aber direkt von Starlette.
///
Nachrichten erwarten und Nachrichten senden
In Ihrer WebSocket-Route können Sie Nachrichten awaiten und Nachrichten senden.
{* ../../docs_src/websockets/tutorial001.py hl[48:52] *}
Sie können Binär-, Text- und JSON-Daten empfangen und senden.
Es ausprobieren
Wenn Ihre Datei main.py heißt, führen Sie Ihre Anwendung so aus:
$ uvicorn main:app --reload
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
Öffnen Sie Ihren Browser unter http://127.0.0.1:8000.
Sie sehen eine einfache Seite wie:
Sie können Nachrichten in das Eingabefeld tippen und absenden:
Und Ihre FastAPI-Anwendung mit WebSockets antwortet:
Sie können viele Nachrichten senden (und empfangen):
Und alle verwenden dieselbe WebSocket-Verbindung.
Verwendung von Depends und anderen
In WebSocket-Endpunkten können Sie Folgendes aus fastapi importieren und verwenden:
DependsSecurityCookieHeaderPathQuery
Diese funktionieren auf die gleiche Weise wie für andere FastAPI-Endpunkte/Pfadoperationen:
{* ../../docs_src/websockets/tutorial002_an_py310.py hl[68:69,82] *}
/// info
Da es sich um einen WebSocket handelt, macht es keinen Sinn, eine HTTPException auszulösen, stattdessen lösen wir eine WebSocketException aus.
Sie können einen „Closing“-Code verwenden, aus den gültigen Codes, die in der Spezifikation definiert sind.
///
WebSockets mit Abhängigkeiten ausprobieren
Wenn Ihre Datei main.py heißt, führen Sie Ihre Anwendung mit Folgendem aus:
$ uvicorn main:app --reload
<span style="color: green;">INFO</span>: Uvicorn running on http://127.0.0.1:8000 (Press CTRL+C to quit)
Öffnen Sie Ihren Browser unter http://127.0.0.1:8000.
Dort können Sie einstellen:
- Die „Item ID“, die im Pfad verwendet wird.
- Das „Token“, das als Query-Parameter verwendet wird.
/// tip | Tipp
Beachten Sie, dass der Query-„Token“ von einer Abhängigkeit verarbeitet wird.
///
Damit können Sie den WebSocket verbinden und dann Nachrichten senden und empfangen:
Verbindungsabbrüche und mehreren Clients handhaben
Wenn eine WebSocket-Verbindung geschlossen wird, löst await websocket.receive_text() eine WebSocketDisconnect-Exception aus, die Sie dann wie in folgendem Beispiel abfangen und behandeln können.
{* ../../docs_src/websockets/tutorial003_py39.py hl[79:81] *}
Zum Ausprobieren:
- Öffnen Sie die Anwendung mit mehreren Browser-Tabs.
- Schreiben Sie Nachrichten in den Tabs.
- Schließen Sie dann einen der Tabs.
Das wird die Ausnahme WebSocketDisconnect auslösen und alle anderen Clients erhalten eine Nachricht wie:
Client #1596980209979 left the chat
/// tip | Tipp
Die obige Anwendung ist ein minimales und einfaches Beispiel, das zeigt, wie Nachrichten verarbeitet und an mehrere WebSocket-Verbindungen gesendet werden.
Beachten Sie jedoch, dass, da alles nur im Speicher in einer einzigen Liste verwaltet wird, es nur funktioniert, während der Prozess ausgeführt wird, und nur mit einem einzelnen Prozess.
Wenn Sie etwas benötigen, das sich leicht in FastAPI integrieren lässt, aber robuster ist und von Redis, PostgreSQL und anderen unterstützt wird, sehen Sie sich encode/broadcaster an.
///
Mehr Informationen
Weitere Informationen zu Optionen finden Sie in der Dokumentation von Starlette: