Django Channels 实现 WebSocket 在线用户列表实时获取-Python教程-PHP中文网

Django Channels 实现 WebSocket 在线用户列表实时获取

本文详解如何在 Django Channels 的 AsyncWebsocketConsumer 中准确获取并广播当前房间内所有已连接用户的 channel 名称列表，通过 Redis 集合（Set）持久化在线状态，兼顾准确性、可扩展性与生产可用性。

本文详解如何在 django channels 的 asyncwebsocketconsumer 中准确获取并广播当前房间内所有已连接用户的 channel 名称列表，通过 redis 集合（set）持久化在线状态，兼顾准确性、可扩展性与生产可用性。

在基于 Django Channels 构建实时聊天室或协作系统时，一个常见且关键的需求是：新用户接入房间后，立即获知当前在线成员列表。然而，Django Channels 的 channel_layer 本身不提供查询某 Group 内所有活跃 channel 的 API——group_add/group_discard 是单向操作，底层频道层（如 channels-redis）仅负责消息路由，并不维护“谁在组里”的可读状态快照。

因此，必须引入外部状态存储机制。Redis 是最推荐的方案：它轻量、高性能、原生支持集合（Set）操作，且与 Channels 生态天然兼容（channels-redis 即基于 Redis 实现）。下面以完整、可落地的方式说明实现步骤。

✅ 正确实现：用 Redis Set 管理房间成员

首先确保已安装并配置好 channels-redis 和 aioredis（v2+）：

pip install channels-redis aioredis==2.0.1

并在 settings.py 中配置频道层：

YouTube Channel Banner

管理YouTube频道横幅。使用此技能插入或上传频道横幅，适用于处理YouTube频道横幅相关操作。

下载

# settings.py
CHANNEL_LAYERS = {
    "default": {
        "BACKEND": "channels_redis.core.RedisChannelLayer",
        "CONFIG": {
            "hosts": [("127.0.0.1", 6379)],
        },
    },
}

然后在消费者中管理成员状态：

# consumers.py
import json
import logging
import aioredis
from channels.generic.websocket import AsyncWebsocketConsumer

logger = logging.getLogger(__name__)

class ChatConsumer(AsyncWebsocketConsumer):
    async def connect(self):
        self.room_name = self.scope["url_route"]["kwargs"]["room_name"]
        self.room_group_name = f"chat_{self.room_name}"

        # 1. 加入 Channels Group（用于广播消息）
        await self.channel_layer.group_add(
            self.room_group_name,
            self.channel_name
        )

        # 2. 获取 Redis 连接（推荐使用连接池，此处为简化示例）
        self.redis = await aioredis.from_url("redis://localhost", decode_responses=True)

        # 3. 将当前 channel_name 存入 Redis Set（自动去重）
        await self.redis.sadd(self.room_group_name, self.channel_name)

        # 4. 获取当前房间全部在线成员（返回 list of str）
        members = await self.redis.smembers(self.room_group_name)
        members = list(members)  # aioredis v2+ 默认返回 str，无需 decode

        await self.accept()

        # 5. 向新连接用户发送欢迎消息 + 成员列表
        await self.send(text_data=json.dumps({
            "type": "welcome",
            "channel_name": self.channel_name,
            "room_group_name": self.room_group_name,
            "member_list": members,
            "total": len(members),
        }))

        # 6. （可选）向房间内其他成员广播「新用户加入」
        await self.channel_layer.group_send(
            self.room_group_name,
            {
                "type": "user_joined",
                "username": self.scope.get("user", {}).get("username", "anonymous"),
                "channel": self.channel_name,
                "total": len(members),
            }
        )

    async def disconnect(self, close_code):
        # 1. 从 Redis Set 中移除自身
        if hasattr(self, "redis") and self.redis:
            await self.redis.srem(self.room_group_name, self.channel_name)

        # 2. 退出 Channels Group
        await self.channel_layer.group_discard(
            self.room_group_name,
            self.channel_name
        )

        # 3. 关闭 Redis 连接（若为临时连接）
        if hasattr(self, "redis") and self.redis:
            self.redis.close()
            await self.redis.wait_closed()

    # 处理群组广播事件（如 user_joined）
    async def user_joined(self, event):
        await self.send(text_data=json.dumps({
            "type": "user_joined",
            "username": event["username"],
            "total": event["total"],
        }))

⚠️ 注意事项与最佳实践

不要依赖 channel_layer.group_send 的隐式成员发现：Channels 不暴露 group 成员枚举接口，强行轮询或扫描是反模式，且无法跨进程一致。
Redis Set 是原子操作：SADD/SREM/SMEMBERS 全部原子执行，避免并发导致的状态不一致。
生命周期对齐：务必在 disconnect 中清理 Redis 数据，否则会残留“僵尸连接”；建议配合 redis 的过期策略（如 EXPIRE）做双重保障。
生产环境优化：
- 使用 aioredis.ConnectionPool 或 redis-py 的连接池复用连接；
- 对高频房间，可缓存 SMEMBERS 结果并设置短 TTL，减少 Redis 压力；
- 若需用户身份（非 channel_name），应在 connect 中解析 self.scope['user'] 并存入 Hash 或 JSON 字段。
替代方案对比：
- ❌ 内存字典（dict/defaultdict）：仅限单进程，集群部署失效；
- ❌ 数据库记录：IO 开销大，不适合毫秒级状态更新；
- ✅ Redis：低延迟、高并发、分布式友好，是事实标准。