我正在构建一个实时Web应用程序。我希望能够从我的 python 应用程序的服务器端实现发送广播消息。
这是设置:
- 套接字.js在客户端
- TornadIO2 服务器作为 Socket.IO 服务器
- 服务器端的python(Django框架)
我可以成功地将 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 消息的调用者。我想向所有连接的客户端广播一条消息,以便在新用户加入群时可以实时通知他们(例如在聊天应用程序中)。
所以,这是我的问题:
如何向所有连接的客户端发送广播消息?
如何将广播消息发送到在特定频道上订阅的多个连接的客户端?
如何在 python 代码中的任何位置(
BaseConnection
类之外)发送广播消息?这是否需要某种 python Socket.IO 客户端,或者这是内置于 TornadIO2 中的?
所有这些广播都应该以可靠的方式完成,所以我想 websockets 是最好的选择。但我对所有好的解决方案持开放态度。
我最近在类似的设置上编写了一个非常相似的应用程序,所以我确实有几个见解。
执行所需操作的正确方法是拥有一个发布-订阅后端。简单的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/
我在这里写,因为很难写在评论部分。您可以在示例目录中查看 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)
如您所见,他们按设置实现了参与者))
如果你已经在使用 django,为什么不看看 gevent-socketio。