如何在FastAPI中使用WebSocket進行雙向通信

如何在FastAPI中使用WebSocket進行雙向通訊

引言：
WebSocket是一種在Web應用程式中實現雙向通訊的協定。與傳統的HTTP請求-回應模式不同，WebSocket允許伺服器直接向客戶端發送訊息，而不需要客戶端明確地發起請求。在FastAPI中，我們可以很方便地使用WebSocket來實現即時的雙向通訊。本文將介紹如何在FastAPI中使用WebSocket實現雙向通信，並附帶程式碼範例。

步驟一：安裝FastAPI和uvicorn
首先，我們需要確保已經安裝了Python 3.7或更高版本。然後，我們可以使用pip安裝FastAPI和uvicorn：

pip install fastapi uvicorn

步驟二：建立FastAPI應用程式
接下來，我們可以建立一個FastAPI應用程式。在一個新的.py檔案中，新增以下程式碼：

from fastapi import FastAPI, WebSocket

app = FastAPI()

@app.websocket("/ws")
async def websocket_endpoint(websocket: WebSocket):
    await websocket.accept()
    while True:
        data = await websocket.receive_text()
        await websocket.send_text(f"Message received: {data}")

上述程式碼建立了一個FastAPI應用，並定義了一個websocket_endpoint函數用於處理WebSocket連線。在這個函數中，我們先呼叫await websocket.accept()來接受WebSocket連線。然後，我們使用一個無限循環來持續監聽從客戶端發送的訊息。一旦接收到訊息，我們使用await websocket.send_text()將回覆訊息傳回客戶端。

步驟三：啟動應用程式
我們可以使用uvicorn指令啟動FastAPI應用程式。在終端機執行以下命令：

uvicorn main:app --reload

這將啟動一個本機伺服器，並監聽在http://localhost:8000上。

步驟四：測試WebSocket連線
使用任何WebSocket客戶端工具（例如瀏覽器的開發者工具或Postman），我們可以測試WebSocket連線。開啟WebSocket客戶端工具，並建立到ws://localhost:8000/ws的連線。

一旦連線建立成功，我們可以發送訊息到伺服器。伺服器會將接收到的訊息回覆給客戶端。

程式碼範例：
下面是一個使用JavaScript的程式碼範例，透過WebSocket連接發送並接收訊息：

const socket = new WebSocket('ws://localhost:8000/ws');

socket.onopen = () => {
  console.log('WebSocket连接已建立');
  socket.send('Hello, server!');
};

socket.onmessage = (event) => {
  console.log('收到服务器的消息:', event.data);
};

socket.onclose = () => {
  console.log('WebSocket连接已关闭');
};

這段程式碼使用WebSocket的API來建立連接，並監聽連接的開啟、訊息的接收和連接的關閉事件。當連接打開時，發送訊息到伺服器。當收到伺服器的訊息時，列印訊息內容。當連線關閉時，列印連線關閉的訊息。

結論：
透過上述步驟，我們可以在FastAPI中使用WebSocket實現雙向通訊。我們可以使用FastAPI提供的WebSocket類別來處理和管理WebSocket連接，實現即時的雙向通訊。在本文中，我們也附帶了一個JavaScript程式碼範例，示範如何使用WebSocket連線發送和接收訊息。希望這篇文章對你理解和應用WebSocket技術有幫助。

以上是如何在FastAPI中使用WebSocket進行雙向通信的詳細內容。更多資訊請關注PHP中文網其他相關文章！