flask_socketio主动调用emit/send发送消息失败解决（伪同步flask上下文）

问题

flask_socketio 有两大问题。

第一大问题是 socket 依赖版本间的互相制约，仅限于固定的版本内才可以互通，关于这一点，可以查看 python-socketio 提供的说明表：

如果不按照对应版本安装依赖，socketio 将失效，且不会有任何提示。

第二大问题便是异步或多线程时 flask app 不在同一个上下文，导致主动 emit / send 失效，无法发送消息，但是在通过 on 侦听的作用域内则可以生效，正常返回消息（这是因为在此作用域内上下文已先置确认了）。

解决

由于 flask 的 socketio 生态较弱，解决可以采用 flask_socketio 提供的 background 运行 + 队列 flush 法。

import queue
from flask import Flask
from flask_socketio import SocketIO

app = Flask(__name__)
sio = SocketIO(app)

is_connect = False

# 维护一个全局队列
msg_queue = queue.Queue()

def flush_queue():
    while msg_queue.empty() == False:
        msg = msg_queue.get()
        # 执行业务发送逻辑，此处可以正确获取上下文
        sio.emit(__MSG_TRANSFER_EVENT__, msg)


def handle_queue():
    while True:
        flush_queue()
        sio.sleep(1)


@sio.on("disconnect", namespace=__BOT_NAMESPACE__)
def disconnect():
    global is_connect
    is_connect = False
    logger.info("connect disabled!!")


@sio.on("connect", namespace=__BOT_NAMESPACE__)
def connect():
    global is_connect
    is_connect = True
    logger.info("connect enabled!")
    # [hack]: because `app` not in only one context
    #         hack pseudo sync for keep consistent context
    #         https://www.imooc.com/wenda/detail/558273
    sio.start_background_task(target=handle_queue)

def start_connect():
    sio.run(app, port=__SOCKET_PORT__, debug=True,
            host=__SOCKET_HOST__, use_reloader=False)


threading.Thread(target=start_connect).start()

可以看出，我们使用 flask_socketio 默认提供的方法 start_background_task 伪同步的执行一个后台任务，该任务需要持续存在，所以每隔 1s 释放执行一次队列，当然，此处是源源不断的出口，入口的入队则在你自己的业务函数里。

由于 app 上下文在伪同步中被保持，所以可以正确主动执行发送 emit / send 。