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

时间:2012-06-08 14:03:36

标签: python django websocket socket.io tornado

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

以下是设置:

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

当前设置和代码

首先,我们需要定义一个处理socket.io事件的Connection:

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?

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

3 个答案:

答案 0 :(得分:16)

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

正确的做法是拥有一个pub-sub后端。你可以用简单的ConnectionHandler做很多事情。最终,处理类级别的连接开始变得丑陋(更不用说错误)。

理想情况下,您需要使用类似Redis的东西,使用龙卷风的异步绑定(请查看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 :(得分:3)

我在这里写,因为在评论部分很难写。您可以在examples目录中查看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)

正如你所看到的,他们按照设定的方式实施了参与者))

答案 2 :(得分:2)

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