python - 如何在 Tornado 中创建多个 websocket 聊天？

Question

我正在尝试创建一个包含多个聊天的 Tornado 应用程序。聊天应该基于 HTML5 websocket。 Websockets 通信很好，但我总是遇到每条消息发布两次的问题。

该应用程序使用四个类来处理聊天:

• Chat 包含到目前为止所有的书面消息和一个包含所有应通知的waiters 的列表

• ChatPool 用作新 Websocket 的查找 - 当没有人具有所需的 scratch_id 时，它会创建一个新的聊天或返回一个现有的聊天实例。

• ScratchHandler 是所有 HTTP 请求的入口点 - 它解析基本模板并返回客户端的所有详细信息。

• ScratchWebSocket 查询数据库以获取用户信息，建立连接并在必须传播新消息时通知聊天实例。

如何防止消息被多次发布？ 如何使用 tornado 构建多聊天应用程序？

import uuid
import tornado.websocket
import tornado.web
import tornado.template

from site import models
from site.handler import auth_handler

class ChatPool(object):

    # contains all chats

    chats = {}

    @classmethod
    def get_or_create(cls, scratch_id):

        if scratch_id in cls.chats:
            return cls.chats[scratch_id]
        else:
            chat = Chat(scratch_id)
            cls.chats[scratch_id] = chat
            return chat


    @classmethod
    def remove_chat(cls, chat_id):

        if chat_id not in cls.chats: return
        del(cls.chats[chat_id])


class Chat(object):

    def __init__(self, scratch_id):

        self.scratch_id = scratch_id
        self.messages = []
        self.waiters = []

    def add_websocket(self, websocket):
        self.waiters.append(websocket)

    def send_updates(self, messages, sending_websocket):
        print "WAITERS", self.waiters   
        for waiter in self.waiters:
            waiter.write_message(messages)
        self.messages.append(messages)


class ScratchHandler(auth_handler.BaseHandler):

    @tornado.web.authenticated
    def get(self, scratch_id):

        chat = ChatPool.get_or_create(scratch_id)
        return self.render('scratch.html', messages=chat.messages,
                                           scratch_id=scratch_id)


class ScratchWebSocket(tornado.websocket.WebSocketHandler):

    def allow_draft76(self):
        # for iOS 5.0 Safari
        return True

    def open(self, scratch_id):

        self.scratch_id = scratch_id
        scratch = models.Scratch.objects.get(scratch_id=scratch_id)

        if not scratch:
            self.set_status(404)
            return

        self.scratch_id = scratch.scratch_id

        self.title = scratch.title
        self.description = scratch.description
        self.user = scratch.user

        self.chat = ChatPool.get_or_create(scratch_id)
        self.chat.add_websocket(self)        

    def on_close(self):
        # this is buggy - only remove the websocket from the chat.
        ChatPool.remove_chat(self.scratch_id)

    def on_message(self, message):
        print 'I got a message'
        parsed = tornado.escape.json_decode(message)
        chat = {
            "id": str(uuid.uuid4()),
            "body": parsed["body"],
            "from": self.user,
            }

        chat["html"] = tornado.escape.to_basestring(self.render_string("chat-message.html", message=chat))
        self.chat.send_updates(chat, self)

注意:@A反馈后。 Jesse 我更改了 Chat 中的 send_updates 方法。不幸的是，它仍然返回 double 值。

class Chat(object):

    def __init__(self, scratch_id):

        self.scratch_id = scratch_id
        self.messages = []
        self.waiters = []

    def add_websocket(self, websocket):
        self.waiters.append(websocket)

    def send_updates(self, messages, sending_websocket):

        for waiter in self.waiters:
            if waiter == sending_websocket:
                continue
            waiter.write_message(messages)

         self.messages.append(messages)

2.EDIT:我将我的代码与示例提供的演示进行了比较。在 websocket 示例中，一条新消息通过 WebSocketHandler 子类和类方法传播给服务员。在我的代码中，它是用一个单独的对象完成的:

来自演示:

class ChatSocketHandler(tornado.websocket.WebSocketHandler):

    @classmethod
    def send_updates(cls, chat):
        logging.info("sending message to %d waiters", len(cls.waiters))

        for waiter in cls.waiters:
            try:
                waiter.write_message(chat)
            except:
                logging.error("Error sending message", exc_info=True)

我的应用程序使用一个对象而不是 WebSocketHandler 的子类

class Chat(object):

    def send_updates(self, messages, sending_websocket):

        for waiter in self.waiters:
            if waiter == sending_websocket:
                continue
            waiter.write_message(messages)

        self.messages.append(messages)

Answer 1

如果您想基于 Tornado 创建多聊天应用程序，我建议您使用某种消息队列来分发新消息。这样你就可以在像 nginx 这样的负载均衡器后面启动多个应用程序进程。否则，您将只能使用一个进程，从而严重限制扩展。

我更新了旧的 Tornado 聊天示例以支持您要求的多房间聊天。查看存储库:

Tornado-Redis-Chat

Live Demo

这个简单的 Tornado 应用程序使用 Redis Pub/Sub 功能和 websockets 向客户端分发聊天消息。只需将聊天室 ID 用作 Pub/Sub channel ，即可轻松扩展多房间功能。