python Socket.IO 客户端，用于向 TornadIO2 服务器发送广播消息

Posted 2023-04-18

【中文标题】python Socket.IO 客户端，用于向 TornadIO2 服务器发送广播消息

【英文标题】：python Socket.IO client for sending broadcast messages to TornadIO2 server

【发布时间】：2012-06-12 14:27:49

【问题描述】：

我正在构建一个实时 Web 应用程序。 我希望能够从我的 python 应用程序的服务器端实现发送广播消息。

设置如下：

socketio.js

在客户端

TornadIO2

服务器作为 Socket.IO 服务器

python

在服务器端（

Django

框架）

我可以成功地将 socket.io 消息从客户端发送到服务器。服务器处理这些并可以发送响应。下面我将描述我是如何做到的。

当前设置和代码

首先，我们需要定义一个 Connection 来处理 socket.io 事件：

class BaseConnection(tornadio2.SocketConnection):
    def on_message(self, message):
        pass

    # will be run if client uses socket.emit('connect', username)
    @event
    def connect(self, username):
        # send answer to client which will be handled by socket.on('log', function)
        self.emit('log', 'hello ' + username)

通过一个Django管理自定义方法来启动服务器：

class Command(BaseCommand):
    args = ''
    help = 'Starts the TornadIO2 server for handling socket.io connections'

    def handle(self, *args, **kwargs):
        autoreload.main(self.run, args, kwargs)

    def run(self, *args, **kwargs):
        port = settings.SOCKETIO_PORT

        router = tornadio2.TornadioRouter(BaseConnection)

        application = tornado.web.Application(
            router.urls,
            socket_io_port = port
        )

        print 'Starting socket.io server on port %s' % port
        server = SocketServer(application)

很好，服务器现在运行。让我们添加客户端代码：

<script type="text/javascript">    
    var sio = io.connect('localhost:9000');

    sio.on('connect', function(data) 
        console.log('connected');
        sio.emit('connect', ' user.username ');
    );

    sio.on('log', function(data) 
        console.log("log: " + data);
    );
</script>

显然， user.username 将被当前登录用户的用户名替换，在本例中用户名是“alp”。

现在，每次刷新页面时，控制台输出为：

connected
log: hello alp

因此，调用消息和发送响应是有效的。 但现在是棘手的部分。

问题

响应“hello alp”仅发送给 socket.io 消息的调用者。我想向所有连接的客户端广播一条消息，以便在新用户加入聚会时实时通知他们（例如在聊天应用程序中）。

所以，这是我的问题：

如何向所有连接的客户端发送广播消息？

如何向在特定频道订阅的多个连接的客户端发送广播消息？

如何在我的 python 代码中的任何地方（BaseConnection 类之外）发送广播消息？这需要某种用于 python 的 Socket.IO 客户端还是 TornadIO2 内置的？

所有这些广播都应该以可靠的方式完成，所以我想 websockets 是最好的选择。但我对所有好的解决方案持开放态度。

【问题讨论】：

我不使用龙卷风，但是当我在 gevent 上创建具有类似功能的应用程序时。 Gevent 不存储已连接用户池，我将所有新传入连接添加到列表中，并在需要时向此列表中的对象发送消息))

好的，这是一种可能性。但据我所知，socket.io 支持广播消息。也许有办法利用它们？

【参考方案1】：

我最近在类似的设置上编写了一个非常类似的应用程序，所以我确实有一些见解。

做你需要的正确方法是拥有一个 pub-sub 后端。简单的ConnectionHandlers 能做的只有这么多。最终，处理类级别的连接集开始变得丑陋（更不用说有问题了）。

理想情况下，您会想要使用 Redis 之类的东西，异步绑定到 tornado（查看 brukva）。这样一来，您就不必为将客户端注册到特定渠道而烦恼 - Redis 开箱即用。

基本上，你有这样的东西：

class ConnectionHandler(SockJSConnection):
    def __init__(self, *args, **kwargs):
        super(ConnectionHandler, self).__init__(*args, **kwargs)
        self.client = brukva.Client()
        self.client.connect()
        self.client.subscribe('some_channel')

    def on_open(self, info):
        self.client.listen(self.on_chan_message)

    def on_message(self, msg):
        # this is a message broadcast from the client
        # handle it as necessary (this implementation ignores them)
        pass

    def on_chan_message(self, msg):
        # this is a message received from redis
        # send it to the client
        self.send(msg.body)

    def on_close(self):
        self.client.unsubscribe('text_stream')
        self.client.disconnect()

请注意，我使用了sockjs-tornado，我发现它比 socket.io 稳定得多。

无论如何，一旦您进行了这种设置，从任何其他客户端（例如 Django，在您的情况下）发送消息就像打开 Redis 连接（redis-py 是一个安全的选择）并发布消息一样简单：

import redis
r = redis.Redis()
r.publish('text_channel', 'oh hai!')

---

这个答案结果很长，所以我加倍努力并用它写了一篇博文：http://blog.y3xz.com/blog/2012/06/08/a-modern-python-stack-for-a-real-time-web-application/

【讨论】：

老兄，你甚至读过这个问题吗？这个问题：“在向所有连接的客户端发送消息的函数中是否存在龙卷风”，而不是关于如何为存储连接对象创建后端。

@Denis，我认为 Yuval Adam 回答的正是我想知道的。我还不能 100% 确定，但请考虑撤消您的反对票。

@Yuval Adam：你能解释一下为什么你发现 sockjs 比 socket.io 更好吗？我仍然可以切换，因为我没有绑定到特定的库

当然。我也从 socket.io 开始，实际上与 MrJoes（tornadio/sockjs-tornado 维护者）讨论了它。他声称 sockjs 具有 100% 的测试覆盖率，并且已知 socket.io 存在一些协议错误。我发现这是真的，当进入生产环境时，sockjs 确实感觉更可靠（尽管我们确实遇到了一些与传输无关的其他问题）。

@Alp - 对于“常规”应用程序，此设置就像一个魅力。我构建的应用程序执行 serious 消息传递（每秒数十条消息，不要问 ;)），事实证明 Chrome 真的不喜欢那些东西。 Chrome 会在这种 WebSocket 使用 1-5 分钟后崩溃。

【参考方案2】：

我在这里写，因为在 cmets 部分很难写。您可以在可以找到聊天实现的示例目录中查看 tornadoio2 的示例，并且：

class ChatConnection(tornadio2.conn.SocketConnection):
    # Class level variable
    participants = set()

    def on_open(self, info):
        self.send("Welcome from the server.")
        self.participants.add(self)

    def on_message(self, message):
        # Pong message back
        for p in self.participants:
            p.send(message)

如您所见，他们将参与者设置为集合））

【讨论】：

这是一个幼稚的实现。任何比这更严重的事情都应该使用适当的 pub-sub 后端（请参阅我的回答）。

感谢您展示其工作原理。但正如 Yuval Adam 指出的那样，使用 Redis 之类的东西可能是更好的选择，因为我的应用程序会很大并且需要很好地扩展

@Alp 如果你真的想创建简单的聊天应用，你不需要任何数据库后端。

聊天只是我 Web 应用程序的一小部分，还有很多事情需要实时完成

我打赌这个解决方案比使用 Redis 和 Tornado 更快。如果您使用的是无状态后端，则需要使用 Redis，而不是 Tornado，后者作为单个进程运行。

【参考方案3】：

如果您已经在使用 django，为什么不看看 gevent-socketio。

【讨论】：

我试过了，但广播也有问题。我切换到 sockjs + tornado + redis 并且效果非常好