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

2024-01-28

我正在尝试创建一个可以从服务器向客户端发送消息的 python 应用程序。目前我正在使用这个示例代码here https://github.com/j2kun/flask-sockets-example。这是一个聊天应用程序,并且运行良好。我尝试修改应用程序并在服务器端 python 代码中添加一个新函数,该函数将向客户端打印消息“Dummy”,但似乎不起作用。

这是我的 html 代码:

索引.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')

main.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()

我可以在终端中看到“收到消息:虚拟”,但网络浏览器上没有任何变化。


你有two阻止您这样做的错误:

First,您正在尝试从套接字上下文外部使用 socket.io 发出事件。

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

如果没有初始化此上下文,您的socketio.emit('output', str(json), namespace='/chat')不会执行任何操作,因为服务器不知道应该向谁发回响应。

无论如何,发出事件有一个小技巧manually to a 特定客户(即使您不在其上下文中)。每次打开套接字时,服务器都会将其分配给一个与套接字 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))

...

那么你可能会按如下方式使用它:

main.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")

...

但即使你尝试这样做,它也不会起作用(这给我们带来了第二个错误)。


Second,您将 eventlet 与常规 Python 线程混合在一起,这不是一个好主意。 eventlet 使用的绿色线程不能与常规线程很好地配合。相反,您应该使用绿色线程来满足所有线程需求。

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

import eventlet
eventlet.monkey_patch()

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

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

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

随机推荐