如何从 websocket 端点外部发出 websocket 消息？

Posted 2023-04-18

【中文标题】如何从 websocket 端点外部发出 websocket 消息？

【英文标题】：How to emit websocket message from outside a websocket endpoint?

【发布时间】：2015-07-19 10:06:23

【问题描述】：

我正在使用Flask 构建一个网站，其中我还使用Flask-socketIO 使用Websockets，但有一点我不明白。

我构建了一个聊天功能。当一个用户发送消息时，我使用 websockets 将该消息发送到服务器，之后我从同一个调用中将消息发送给另一个用户：

@socketio.on('newPM', namespace='/test')
@login_required_with_global
def io_newMessage(theJson):
    emit('message', 'message': theJson['message'], room=str(theJson['toUserId']))

但是假设我想在保存文件时向用户发送消息。这意味着我需要从发布文件的视图中发出一条消息。所以根据flask_socketio docs 我可以在发射中添加一个命名空间。所以我写了这个：

@app.route('/doc', methods=['POST'])
@login_required
def postDoc():
    saveDocument(request.files['file'], g.user.id)
    emit('my response', 'data': 'A NEW FILE WAS POSTED', room=current_user.id, namespace='/test')
    return jsonify('id': str(doc.id))

但是看到下面的堆栈跟踪仍然存在命名空间的问题； werkzeug 有一个AttributeError: 'Request' object has no attribute 'namespace'。

有人知道我在这里做错了什么吗？或者这是flask_socketio中的一个错误？欢迎所有提示！

Traceback (most recent call last):
  File "/usr/local/lib/python2.7/dist-packages/flask/app.py", line 1820, in wsgi_app
    response = self.make_response(self.handle_exception(e))
  File "/usr/local/lib/python2.7/dist-packages/flask/app.py", line 1403, in handle_exception
    reraise(exc_type, exc_value, tb)
  File "/usr/local/lib/python2.7/dist-packages/flask/app.py", line 1817, in wsgi_app
    response = self.full_dispatch_request()
  File "/usr/local/lib/python2.7/dist-packages/flask/app.py", line 1477, in full_dispatch_request
    rv = self.handle_user_exception(e)
  File "/usr/local/lib/python2.7/dist-packages/flask/app.py", line 1381, in handle_user_exception
    reraise(exc_type, exc_value, tb)
  File "/usr/local/lib/python2.7/dist-packages/flask/app.py", line 1475, in full_dispatch_request
    rv = self.dispatch_request()
  File "/usr/local/lib/python2.7/dist-packages/flask/app.py", line 1461, in dispatch_request
    return self.view_functions[rule.endpoint](**req.view_args)
  File "/usr/local/lib/python2.7/dist-packages/flask_login.py", line 758, in decorated_view
    return func(*args, **kwargs)
  File "/home/vg/app/views.py", line 768, in emitNotificationCount
    emit('menuInit', emitJson, room=current_user.id, namespace='/test')
  File "/usr/local/lib/python2.7/dist-packages/flask_socketio/__init__.py", line 444, in emit
    return request.namespace.emit(event, *args, **kwargs)
  File "/usr/local/lib/python2.7/dist-packages/werkzeug/local.py", line 338, in __getattr__
    return getattr(self._get_current_object(), name)
AttributeError: 'Request' object has no attribute 'namespace'

【问题讨论】：

@Shashank - 太棒了，就是这样，谢谢！如果您将评论添加为答案，我可以接受。

【参考方案1】：

引用 Miguel Grinberg 在an open issue page on the Flask-SocketIO GitHub 上的回复：

当您想从常规路线发射时，您必须使用 socketio.emit()，只有套接字处理程序有 socketio 上下文 有必要调用普通的 emit()。

举个例子：

from flask_socketio import SocketIO

app = Flask(__name__)
app.config.from_object('config')
socketio = SocketIO(app)

@app.route('/doc', methods=['POST'])
def postDoc():
    saveDocument(request.files['file'], g.user.id)
    socketio.emit('my response', 'data': 'A NEW FILE WAS POSTED', room=current_user.id)
    return jsonify('id': str(doc.id))