如何使用 Flask-Socket IO 从服务器向客户端发送消息

Question

我正在尝试创建一个可以将消息从服​​务器发送到客户端的 python 应用程序。目前我正在使用来自here 的示例代码。这是一个聊天应用程序，它工作正常。我尝试修改应用程序并在服务器端 python 代码中添加一个新函数，该函数将向客户端打印一条消息“Dummy”，但似乎它不起作用。

这是我的 html 代码：

index.html

<body>
    <ul id="messages"></ul>
    <ul id="output"></ul>
    <form action="">
      <input id="m" autocomplete="off" /><button>Send</button>
    </form>

<script src="{{url_for('static', filename='assets/vendor/socket.io.min.js')}}"></script>
<script src="{{url_for('static', filename='assets/vendor/jquery.js')}}"></script>

<script>
  var socket = io.connect('http://127.0.0.1:5000/chat');

  $('form').submit(function(){
    socket.emit('chat message', $('#m').val());
    $('#m').val('');
    return false;
  });

  socket.on('chat message', function(msg){
    $('#messages').html($('<li>').text(msg));
  });

  socket.on('output', function(msg){
    alert(msg)
    $('#messages').html($('<li>').text(msg));
  });
</script>

这是我的后端代码：

web_app.py

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

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

def socket_onload(json):
    socketio.emit('output', str(json), namespace='/chat')
    print('received message: ' + str(json))


@socketio.on('chat message', namespace='/chat')
def handle_chat_message(json):
    print('received message: ' + str(json))
    emit('chat message', str(json), broadcast=True)


@socketio.on('connect')  # global namespace
def handle_connect():
    global connected
    connected = True
    print('Client connected')

@socketio.on('connect', namespace='/chat')
def handle_chat_connect():
    print('Client connected to chat namespace')
    emit('chat message', 'welcome!')

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


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


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

ma​​in.py

import web_app
import threading
import time

def main():
    import web_app
    webapp_thread = threading.Thread(target=run_web_app)
    webapp_thread.start()
    # webapp_thread = threading.Thread(target=run_web_app, args=(i,))

    while web_app.connected==False:
        print "waiting for client to connect"
        time.sleep(1)
        pass

    print "Connected..."
    time.sleep(3)
    print "Trying to print dummy message..."
    web_app.socket_onload("Dummy")

def run_web_app():
    web_app.socketio.run(web_app.app)

if __name__ == '__main__':
    main()

我可以在终端中看到“received message: Dummy”，但网络浏览器上没有任何变化。

Answer 1

你有两个错误阻止你这样做：

首先，您正尝试在套接字上下文之外使用 socket.io 发出一个事件。

当一个函数用@socketio.on 装饰器包装时，它就变成了Event-Handlers。 在服务器端触发事件时，它将搜索正确的处理程序来处理事件并将上下文初始化到发出事件的特定客户端。

如果没有初始化这个上下文，你的socketio.emit('output', str(json), namespace='/chat') 将什么都不做，因为服务器不知道它应该向谁发回响应。

无论如何，手动向特定客户端发送事件有一个小技巧（即使您不在其上下文中）。每次打开一个套接字时，服务器都会将它分配给一个与套接字 id (sid) 同名的“私人”房间。因此，为了从客户端上下文向外部客户端发送消息，您可以创建一个已连接客户端 id 的列表并使用 room=<id> 参数调用发出函数。

例如：

web_app.py：

...
from flask import Flask, request

clients = []

@socketio.on('connect')
def handle_connect():
    print('Client connected')
    clients.append(request.sid)

@socketio.on('disconnect')
def handle_disconnect():
    print('Client disconnected')
    clients.remove(request.sid)

def send_message(client_id, data):
    socketio.emit('output', data, room=client_id)
    print('sending message "{}" to client "{}".'.format(data, client_id))

...

那么你可能会这样使用：

ma​​in.py:

import web_app
import threading
import time

def main():
    webapp_thread = threading.Thread(target=run_web_app)
    webapp_thread.start()

    while not web_app.clients:
        print "waiting for client to connect"
        time.sleep(1)

    print "Connected..."
    time.sleep(3)
    print "Trying to print dummy message..."
    web_app.send_message(web_app.clients[0], "Dummy")

...

但是即使你尝试这个，它也不会起作用（这给我们带来了第二个错误）。

---

第二，您将 eventlet 与常规 Python 线程混合，这不是一个好主意。 eventlet 使用的绿色线程不适用于常规线程。相反，您应该使用绿色线程来满足所有线程需求。

我在互联网上找到的一个选项是对 Python 标准库进行猴子补丁，以便将线程、套接字等替换为对 eventlet 友好的版本。您可以在 main.py 脚本的最顶部执行此操作：

import eventlet
eventlet.monkey_patch()

之后它应该可以正常工作（我自己尝试过）。如果您还有其他问题，请告诉我...

Answer 2

这些装饰器用于简单地加载页面 index.html 和 blah.html 这些不做任何事情 --- 不传递任何变量或不向模板写入任何内容，它们只是渲染它，同时所有如果您必须打印或传递这些函数中必须包含的任何内容，那么您正在做的事情就是命令行：

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


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