Django如何通过WebSocket向所有已连接客户端推送事件消息

问题根因分析 #

• 错误1：手动实例化EventWebSocket类没有意义。Consumer类实例是Channels框架在客户端建立WebSocket连接时自动创建绑定的，自行初始化的实例没有关联真实连接、也没有初始化channel_layer等核心属性，无法完成推送。
• 错误2：手动覆盖self.channel_name = "CHANNEL_1"会导致所有连接共用同一个通道名，组播只会推送给最后一个接入的客户端，还会引发断开逻辑异常，Channels会自动生成全局唯一的通道名，不需要手动赋值。
• 错误3：组播事件的type字段与消费方法不匹配。group_send中type为global.message时，框架会自动调用消费者类中名为global_message的方法处理事件，当前写的global_event方法完全不会被触发。

修复步骤 #

1. 修正consumers.py代码 #

from channels.generic.websocket import WebsocketConsumer
from asgiref.sync import async_to_sync

class EventWebSocket(WebsocketConsumer):
    def connect(self):
        # 去掉手动设置channel_name的代码，使用框架自动生成的唯一值
        print("CALL_ACCEPT")
        async_to_sync(self.channel_layer.group_add)("global", self.channel_name)
        self.accept()

    def disconnect(self, close_code):
        async_to_sync(self.channel_layer.group_discard)("global", self.channel_name)

    def receive(self, text_data):
        print("RRR_ receive ", text_data)
        async_to_sync(self.channel_layer.group_send)(
            "global",
            {
                "type": "global.message",
                "text": text_data,
            },
        )

    # 方法名和type字段对应：点替换为下划线
    def global_message(self, event):
        print("GLOB_MESSAGE")
        self.send(text_data=event["text"])

2. 重写事件推送函数event_producer #

不需要引入Consumer类，直接调用channel_layer的组播方法即可：

from channels.layers import get_channel_layer
from asgiref.sync import async_to_sync

def event_producer():
    channel_layer = get_channel_layer()
    # 直接向global组广播消息，所有加入组的客户端都会收到
    async_to_sync(channel_layer.group_send)(
        "global",
        {
            "type": "global.message",
            "text": "你要推送的事件字符串，可直接传JSON序列化后的结果"
        }
    )

注意事项 #

• 请先确认Django Channels已正确配置Channel Layer后端，生产环境推荐使用RedisChannelLayer，默认的内存层仅支持单进程内调用，独立脚本/其他进程触发推送时无法生效。
• 如果需要推送JSON格式数据，可先将Python字典用json.dumps()序列化为字符串后再传入text字段，客户端收到后再反序列化即可。

内容的提问来源于stack exchange，提问作者Alex