python学习-使用Flask-SocketIO完成服务端和客户端的双向通信

小知 python框架 2018年7月23日

1.68W 0 0

flask-socketio模块实际上是封装了flask对websocket的支持，websocket在连接建立阶段是通过HTTP的握手方式进行的，这可以看做是为了兼容浏览器或者使用一些现成的功能来实现，这样一种捷径。当连接建立之后，客户端和服务端之间就不再进行HTTP通信了，所有信息交互都由websocket接管。Flask-SocketIO使Flask应用程序可以访问客户端和服务器之间的低延迟双向通信，使客户端建立与服务器的永久连接。

适用的场景：后台产生新的数据，需要在前台页面马上展示出来，例如数据监控、统计图实时变化更新等。

当然，我们可以使用ajax来完成，通过ajax使得前台定时去后台索要数据，但如果消息频繁，ajax需要不断的建立和释放连接，效果明显不如后端直接推送数据到前台更加合适。

Flask-SocketIO的使用

首先安装依赖：

1	pip install flask-socketio

一个简单的示例（对Flask代码加了一层包装）：

from flask import Flask, render_template
from flask_socketio import SocketIO
 
app = Flask(__name__)
app.config['SECRET_KEY'] = 'secret!'
socketio = SocketIO(app)
 
if __name__ == '__main__':
socketio.run(app)

SocketIO发送消息

SocketIO可以使用send（）和emit（）函数向连接的客户端发送消息，两个函数有些区别，send（）用于发送未命名事件消息，而emit（）用于发送已命名事件消息。

实例代码：

@socketio.on('message')
def handle_message(message):
     send(message, namespace='/chat')
 
@socketio.on('my event')
def handle_my_custom_event(json):
      emit('my response', json, namespace='/chat')

namespace表示传入消息的命名空间，前台可以对应这个命名空间选择接收消息，如：

$(document).ready(function() {
        namespace = '/test';
        var socket = io.connect(location.protocol
    + '//' + document.domain + ':'
    + location.port + namespace);
 
        socket.on('server_response', function(res) {
            //res表示接收的数据，这里做数据的处理
        });
 
    });

一个简单使用SocketIO的完整实例

功能：后台五秒随机产生十个数字，在前台模版中动态刷新显示

后台代码：

#encoding:utf-8
#!/usr/bin/env python
from flask import Flask, render_template
from flask_socketio import SocketIO
import random
async_mode = None
app = Flask(__name__)
app.config['SECRET_KEY'] = 'secret!'
socketio = SocketIO(app)
 
@app.route('/')
def index():
    return render_template('test.html')
 
@socketio.on('connect', namespace='/test_conn')
def test_connect():
    while True:
        socketio.sleep(5)
        t = random_int_list(1, 100, 10)
        socketio.emit('server_response',
                      {'data': t},
                      namespace='/test_conn')
 
def random_int_list(start, stop, length):
    start, stop = (int(start), int(stop)) if start <= stop else (int(stop), int(start))
    length = int(abs(length)) if length else 0
    random_list = []
    for i in range(length):
        random_list.append(random.randint(start, stop))
    return random_list
 
if __name__ == '__main__':
    socketio.run(app, debug=True)

模版页面：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title></title>
    <script type="text/javascript" src="//cdn.bootcss.com/jquery/3.1.1/jquery.min.js"></script>
    <script type="text/javascript" src="//cdn.bootcss.com/socket.io/1.5.1/socket.io.min.js"></script>
</head>
<body>
<h2 id="t"></h2>
<script type="text/javascript">
    $(document).ready(function() {
        namespace = '/test_conn';
        var socket = io.connect(location.protocol + '//' + document.domain + ':' + location.port + namespace);
        socket.on('server_response', function(res) {
            var t = res.data;
            $("#t").text(t);
        });
 
    });
</script>
</body>
</html>