Python的Socket.IO客户端,用于向TornadIO2服务器发送广播消息

20

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

以下是设置:

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

当前设置和代码

首先,我们需要定义一个连接来处理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消息的调用者。我希望向所有连接的客户端广播消息,以便实时通知他们新用户加入聊天室(例如在聊天应用程序中)。

所以,这里是我的问题:

  1. 如何将广播消息发送给所有连接的客户端?

  2. 如何将广播消息发送给订阅特定频道的多个连接的客户端?

  3. 如何在我的Python代码中的任何位置发送广播消息(在BaseConnection类之外)?这是否需要一些用于Python的Socket.IO客户端或内置于TornadIO2中?

所有这些广播都应该以可靠的方式完成,因此我认为WebSockets是最佳选择。但我对所有好的解决方案持开放态度。


我不使用tornado,但是当我使用类似功能的gevent创建应用程序时,gevent不会存储连接用户池。我将所有新进入的连接添加到列表中,并在需要时向此列表中的对象发送消息)) - Denis
好的,那也许是一种可能性。但据我所知,socket.io支持广播消息。也许有一种方法可以利用它们? - Alp
3个回答

16

最近我在类似的设置中编写了一个非常相似的应用程序,因此我有几个见解。

做你需要的事情的正确方法是使用发布-订阅后端。只有使用简单的ConnectionHandler有限的操作。 最终,处理类级别的连接集合开始变得丑陋(更不用说有漏洞)。

理想情况下,您应该使用像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/


1
@Denis,我认为Yuval Adam已经回答了我想知道的问题。虽然我还不确定,但请考虑取消你的反对票。 - Alp
5
好的。我也开始使用socket.io,并与MrJoes(tornadio/sockjs-tornado维护者)讨论过它。他声称sockjs有100%的测试覆盖率,而socket.io已知存在一些协议错误。当我们进入实际生产时,我发现这是真的,sockjs确实更加稳定(尽管我们还遇到了一些与传输无关的其他问题)。 - Yuval Adam
谢谢您的见解。您还遇到了哪些问题?我可能有类似的机制,我想避免类似的问题。 - Alp
2
@Alp-对于“通常”的应用程序,这种设置非常有效。我构建的应用程序进行了严肃的消息传递(每秒钟数十条消息,别问;)),结果发现Chrome真的不喜欢这些东西。在使用WebSocket 1-5分钟后,Chrome会崩溃。 - Yuval Adam
Python 3解决方案,使用SockJS和tornado-redis:http://blog.kristian.io/post/47460001334/sockjs-and-tornado-for-python-real-time-web-projects/ - Alp
显示剩余8条评论

3

我写在这里,因为在评论区写比较困难。您可以在示例目录中查看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)

正如您所看到的,他们将参与者实现为集合))

那是一个天真的实现。任何比那更严肃的东西都应该使用适当的发布-订阅后端(请参见我的答案)。 - Yuval Adam
感谢您展示了它的工作原理。但正如Yuval Adam所指出的那样,使用像Redis这样的东西可能是更好的选择,因为我的应用程序将非常庞大,并且需要良好的扩展性。 - Alp
@Alp 如果你真的想要创建一个简单的聊天应用程序,你不需要任何数据库后端。 - Denis
聊天只是我的Web应用程序的一小部分,还有更多实时工作要完成。 - Alp
我敢打赌,这个解决方案比在Tornado中使用Redis更快。如果你正在使用无状态后端而不是运行为单个进程的Tornado,则应该使用Redis。 - Ron Reiter

2
如果你已经在使用django,为什么不试试gevent-socketio呢?

我尝试过那种方法,但它在广播方面存在问题。我改用SockJS + Tornado + Redis,现在效果非常好。 - Alp

网页内容由stack overflow 提供, 点击上面的
可以查看英文原文,
原文链接