FastAPI Learning Road (44) WebSockets

2024-07-12

Η προηγούμενη ανάλυσή μας βασίστηκε όλη σε αιτήματα http, οπότε αν τα websockets μπορούν να την υποστηρίξουν, η απάντηση είναι ναι, ας ρίξουμε μια ματιά στον τρόπο εφαρμογής της.


from fastapi import WebSocket, FastAPI
from fastapi.responses import HTMLResponse
 
app = FastAPI()
 
html = """
 
<!DOCTYPE html>
 
<html>
 
    <head>
 
        <title>Chat</title>
 
    </head>
 
    <body>
 
        <h1>WebSocket 聊天</h1>
 
        <form action="" onsubmit="sendMessage(event)">
 
            <input type="text" id="messageText" autocomplete="off"/>
 
            <button>Send</button>
 
        </form>
 
        <ul id='messages'>
 
        </ul>
 
        <script>
 
            var ws = new WebSocket("ws://localhost:8000/ws");
 
            ws.onmessage = function(event) {
 
                var messages = document.getElementById('messages')
 
                var message = document.createElement('li')
 
                var content = document.createTextNode(event.data)
 
                message.appendChild(content)
 
                messages.appendChild(message)
 
            };
 
            function sendMessage(event) {
 
                var input = document.getElementById("messageText")
 
                ws.send(input.value)
 
                input.value = ''
 
                event.preventDefault()
 
            }
</script>
 
    </body>
 
</html>
 
"""
 
 
@app.get("/")
async def get_page():
    return HTMLResponse(html)
 
 
@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()
    while True:
        data = await websocket.receive_text()
        await websocket.send_text(f"接收到的消息是：{data}")

Στην πραγματικότητα, είναι πολύ απλό. Γράφουμε μια διεπαφή για τη λήψη μηνυμάτων στο πίσω μέρος του μηνύματος. Επιστρέψαμε το μήνυμα που λάβαμε απευθείας στο μπροστινό μέρος.

Ας ρίξουμε μια ματιά στο αποτέλεσμα:

Με αυτόν τον τρόπο, υλοποιούμε απλώς τη λειτουργία ενός websocket. Έχουμε λοιπόν ένα συγκεκριμένο μήνυμα και κλείνουμε το chat, πώς να το αντιμετωπίσουμε;


# 接收特定的消息后，终止该聊天
@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()
    while True:
        data = await websocket.receive_text()
        if data == "bye":
            await websocket.send_text(f"请注意：窗口即将关闭")
            await websocket.send_text("窗口已关闭")
            await websocket.close()
            break
        else:
            await websocket.send_text(f"接收到的消息是：{data}")

Ο κωδικός του μπροστινού μέρους δεν έχει αλλάξει, μόνο το back-end έχει τροποποιηθεί.

Στην πραγματικότητα, είναι πολύ απλό να εφαρμοστεί η επικοινωνία websocket εδώ.

Φυσικά μπορούμε να το χρησιμοποιήσουμε και σε αιτήματα

Εξαρτάται
Ασφάλεια
Κουλουράκι
Επί κεφαλής
Μονοπάτι
Ερώτηση

Μπορούμε να δούμε το ακόλουθο παράδειγμα μιας απλής γραφής backend


# 使用多种参数，比如获取cookie等
from typing import Optional
from fastapi import Cookie, Query, status, Depends
 
 
async def get_cookie_or_token(
    websocket: WebSocket,
    session: Optional[str] = Cookie(None),
    token: Optional[str] = Query(None),
):
    if session is None and token is None:
        await websocket.close(code=status.WS_1008_POLICY_VIOLATION)
    return session or token
 
 
@app.websocket("item/ws")
async def websocket_endpoint(
    websocket: WebSocket,
    q: Optional[int] = None,
    cookie_or_token: str = Depends(get_cookie_or_token),
):
    await websocket.accept()
    while True:
        data = await websocket.receive_text()
        await websocket.send_text(
            f"Session cookie or query token value is: {cookie_or_token}"
        )
        if q is not None:
            await websocket.send_text(f"parameter q is: {q}")
        await websocket.send_text(f"Message text was: {data}, for : {q}")

Αν και έχουμε απλώς εφαρμόσει το backend, μπορούμε να δούμε ότι το fastapi έχει καλή υποστήριξη για το websocket

Κοινή χρήση τεχνολογίας

FastAPI Learning Road (44) WebSockets

Προσωπικό προφίλ

τα στοιχεία επικοινωνίας μου