如何使用Flask-SocketIO實現即時Web應用-Python教學-PHP中文網

如何使用Flask-SocketIO實現即時Web應用

王林

發布： 2023-08-03 13:07:43

原創

987 人瀏覽過

如何使用Flask-SocketIO實現即時Web應用

引言：
隨著Web應用的發展，使用者對於即時互動和即時更新的需求也越來越高。傳統的HTTP協定無法滿足這些需求，而WebSocket協定則提供了一個即時通訊的解決方案。在Python中，Flask-SocketIO是一個強大的函式庫，可以幫助我們快速實現即時Web應用。本文將介紹如何使用Flask-SocketIO建造一個簡單的即時聊天室。

準備工作
首先，我們需要安裝Flask-SocketIO庫。可以使用pip指令進行安裝：
```
pip install flask-socketio
```
登入後複製
設定Flask-SocketIO
在你的Flask應用程式中，透過匯入Flask-SocketIO來設定SocketIO：
```
from flask import Flask, render_template
from flask_socketio import SocketIO

app = Flask(__name__)
app.config['SECRET_KEY'] = 'secret!'
socketio = SocketIO(app)
```
登入後複製
在上面的程式碼中，我們建立了一個Flask應用，並設定了一個SECRET_KEY。 SECRET_KEY用於加密WebSocket通信，預設情況下是一個隨機產生的字串。然後，我們建立了一個SocketIO對象，並將其關聯到Flask應用程式上。
建立路由和事件處理器
接下來，我們需要建立路由和事件處理器。在Flask應用中，使用@socketio.on裝飾器來註冊事件處理器。以下是一個簡單的範例：
```
@app.route('/')
def index():
 return render_template('index.html')

@socketio.on('message')
def handle_message(message):
 print('received message: ' + message)
 socketio.emit('message', message, broadcast=True)
```
登入後複製
在上面的程式碼中，我們先定義了一個路由/，對應的視圖函數回傳了一個名為index.html的模板。接著，我們使用@socketio.on裝飾器來註冊了一個message事件的處理器。當伺服器接收到message事件時，會呼叫handle_message函數，並將訊息作為參數傳遞給它。 handle_message函數列印收到的訊息，並透過socketio.emit方法將訊息廣播給所有連接的用戶端。

建立HTML範本
在專案的根目錄下，建立一個名為templates的資料夾，並在其中建立一個名為 index.html的文件。以下是一個簡單的範例：

<!DOCTYPE html>
<html>
<head>
 <meta charset="UTF-8">
 <title>实时聊天室</title>
 <script src="https://cdn.socket.io/socket.io-1.4.5.js"></script>
</head>
<body>
 <h1>实时聊天室</h1>
 <div id="messages"></div>
 <div id="input">
     <input type="text" id="message">
     <button id="send">发送</button>
 </div>

 <script>
     var socket = io();

     document.getElementById('send').onclick = function() {
         var message = document.getElementById('message').value;
         socket.emit('message', message);
     };

     socket.on('message', function(message) {
         var div = document.createElement('div');
         div.textContent = message;
         document.getElementById('messages').appendChild(div);
     });
 </script>
</body>
</html>

登入後複製

在上面的程式碼中，我們透過<script src="https://cdn.socket.io/socket.io-1.4.5.js "></script>引進了Socket.IO的客戶端函式庫。然後，我們建立了一個Socket.IO的實例，並使用socket.emit方法在發送按鈕點擊時發送訊息。同時，我們使用socket.on方法監聽伺服器發送的message事件，並在接收到訊息時將其顯示在頁面上。

啟動應用程式
完成以上步驟後，我們可以透過以下指令啟動應用程式：
```
python your_app.py
```
登入後複製
其中your_app.py是你的Flask應用的入口檔名。啟動應用程式後，在瀏覽器中造訪http://localhost:5000，你就可以看到一個簡單的即時聊天室了！在其中輸入訊息並點擊發送按鈕，訊息會即時顯示在頁面上，並廣播給所有連接到伺服器的用戶端。