Flask使用SocketIO實現(xiàn)WebSocket與Vue進行實時推送

更新時間：2022年06月08日 10:11:58 作者：洲的學習筆記

本文主要介紹了Flask使用SocketIO實現(xiàn)WebSocket與Vue進行實時推送，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧

前言

本文旨在記錄使用Flask框架過程中與前端Vue對接過程中，存在WebSocket總是連接失敗導致前端取不到數(shù)據(jù)的問題。以及在使用WebSocket相關功能的庫包gevent-websocket之后，導致運行Flask項目之后，控制臺沒有顯示running on 127.0.0.1:5000 問題、以及沒有輸出log日志記錄的問題、以及總是報錯Websocket connection to‘ws://127.0.0.1:5000/socket.io/?EIO=4&transport=websocket’failed：Error during Websocket handshake：Unexpected response code：400’的問題！

如下圖所示：只有三行控制臺輸出的記錄、總是報錯（該錯在網(wǎng)上沒有解決方法）等。

技術選型：前端Vue、后端Flask。

核心問題

需要著重注意的是，F(xiàn)lask框架中有原生的Websocket寫法，也有對Websocket封裝之后的依賴包SocketIO寫法，所以在進行與前端對接的過程中，需要與前端對接好接口標準。在本次項目中，后端最開始用的是封裝好WebSocket后的socketio進行編寫，而前端使用了原生的websocket-vue寫法，導致一直對接不上，獲取不到數(shù)據(jù)。以及所有的報錯或者各種bug問題，筆者都推測是跟gevent-websocket這個包有關。

在前端更改為vue-socketio之后，成功解決對接失敗問題。（也可以后端改用原生寫法，總之兩邊需要同時使用一個標準。）前端Vue可以參考Vue的文檔去看使用哪種寫法即可。

Flask的原生WebSocket（flask-sockets）與封裝SocketIO

Flask-Sockets和Flask-SocketIO之間的主要區(qū)別在于前者僅僅將WebSocket協(xié)議（通過使用gevent-websocket項目）進行包裝，因此它只適用于原生支持WebSocket協(xié)議的瀏覽器，對于那些不支持WebSocket協(xié)議的較老的瀏覽器，就無法使用它了。

Flask-SocketIO則不同，它不僅實現(xiàn)了WebSocket協(xié)議，并且對于那些不支持WebSocket協(xié)議的舊版瀏覽器，使用它也能夠實現(xiàn)相同的效果。新版舊版的瀏覽器都能使用他?？梢赃@么理解，flask把websocket功能封裝在了socketio這個新的包里面。

另一個區(qū)別是Flask-SocketIO實現(xiàn)了SocketIO Javascript庫公開的消息傳遞協(xié)議。
而Flask-Sockets只是實現(xiàn)通信通道，發(fā)送的是完全取決于應用程序。

1、Flask-SocketIO（封裝寫法）

使用SocketIO之前需要導入該包，即pip install flask-socketio。也可以直接在代碼中import該包中的兩個功能。
即：from flask_socketio import SocketIO, emit。

下面是服務端代碼：（關于如何在實戰(zhàn)中應用，可以看筆者上一篇關于flask博客中的代碼實現(xiàn)，大致思路是使用線程）

from flask import Flask, render_template
from flask_socketio import SocketIO, emit

app = Flask(__name__)
app.config['SECRET_KEY'] = 'secret!'
socketio = SocketIO(app)

@app.route('/')
def index():
    return render_template('index.html')

@socketio.on('my event', namespace='/test')
def test_message(message):
    emit('my response', {'data': message['data']})

@socketio.on('my broadcast event', namespace='/test')
def test_message(message):
    emit('my response', {'data': message['data']}, broadcast=True)

@socketio.on('connect', namespace='/test')
def test_connect():
    emit('my response', {'data': 'Connected'})

@socketio.on('disconnect', namespace='/test')
def test_disconnect():
    print('Client disconnected')
 


if __name__ == '__main__':
    socketio.run(app)

而對于js來說，客戶端代碼十分簡單，直接上代碼：（注意是socketio的標準）

$(document).ready(function(){
    var socket = io.connect('http://' + document.domain + ':' + location.port + '/test');
    //注意如果使用var socket = io.connect(location.protocol + ‘//' + document.domain.....的寫法，這里的protocol是http協(xié)議，而不是走的是ws，筆者推測是對ws進行了封裝，導致最終走的是http協(xié)議。
    //上面代碼中的/test 就是namespace
    
    socket.on('my response', function(msg) {
        $('#log').append('<p>Received: ' + msg.data + '</p>');
    });.
    
    $('form#emit').submit(function(event) {
        socket.emit('my event', {data: $('#emit_data').val()});
        return false;
    });
    
    $('form#broadcast').submit(function(event) {
        socket.emit('my broadcast event', {data: $('#broadcast_data').val()});
        return false;
    });
});

2、Flask-Sockets（原生Websocket寫法）

服務端：

from flask import Flask
from flask_sockets import Sockets
import datetime
import time
import random

app = Flask(__name__)
sockets = Sockets(app)

@sockets.route('/echo')
def echo_socket(ws):
    while not ws.closed:
        now = datetime.datetime.now().isoformat() + 'Z'
        ws.send(now)  #發(fā)送數(shù)據(jù)
        time.sleep(1)

@app.route('/')
def hello():
    return 'Hello World!'

if __name__ == "__main__":
    from gevent import pywsgi
    from geventwebsocket.handler import WebSocketHandler
    server = pywsgi.WSGIServer(('', 5000), app, handler_class=WebSocketHandler)
    print('server start')
    server.serve_forever()

客戶端代碼：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <script src="https://cdn.bootcss.com/jquery/3.2.0/jquery.js"></script>
</head>
<body>
    <div id="time" style="width: 300px;height: 50px;background-color: #0C0C0C;
    color: white;text-align: center;line-height: 50px;margin-left: 40%;font-size: 20px"></div>

    <script>
            var ws = new WebSocket("ws://127.0.0.1:5000/echo");  #連接server
			//這是websocket的前端原生寫法，直接連接ws。
            ws.onmessage = function (event) {
                content = document.createTextNode(event.data); # 接收數(shù)據(jù)
                $("#time").html(content);

            };

    </script>
    </body>
</html>