TypeError报错排查：群组名称不符合规范（附ChatConsumer代码）

报错信息 #

TypeError: 群组名称必须是长度小于100的有效Unicode字符串，仅可包含ASCII字母数字、连字符、下划线或句点，当前不符合该规范。

问题原因 #

你的代码中直接使用user.username作为Channels的群组名称，但当前系统中存在用户名包含非ASCII字符（如中文、特殊符号），或用户名长度超过99字符的情况，违反了Channels对群组名称的格式限制规则。

解决方案 #

方案1：改用用户ID作为群组名称（推荐） #

用户ID是整数类型，转换为字符串后完全符合ASCII数字要求，不会出现字符或长度问题，是最可靠的解决方案。修改代码中所有涉及群组名称的部分：

1. connect方法

# 原代码
async_to_sync(self.channel_layer.group_add)(
    self.username, self.channel_name
)
# 修改为
async_to_sync(self.channel_layer.group_add)(
    str(user.id), self.channel_name
)

2. disconnect方法

# 原代码
async_to_sync(self.channel_layer.group_discard)(
    self.username, self.channel_name
)
# 修改为
async_to_sync(self.channel_layer.group_discard)(
    str(user.id), self.channel_name
)

3. receive方法中的send_group调用

# 发送给当前用户的部分
self.send_group(str(user.id), 'message.send', data)
# 发送给接收方的部分
self.send_group(str(recipient.id), 'message.send', data)
# message.list场景的发送
self.send_group(str(user.id), 'message.list', data)

方案2：清洗用户名后使用（如需保留用户名作为群组名） #

如果必须使用用户名作为群组名称，需要对用户名进行过滤处理，仅保留允许的字符并截断长度：

import re

def clean_group_name(name):
    # 过滤掉ASCII字母数字、连字符、下划线、句点之外的所有字符
    cleaned = re.sub(r'[^a-zA-Z0-9\-\_\.]', '', name)
    # 截断到99字符以内
    return cleaned[:99]

之后在所有使用群组名称的位置，替换为清洗后的用户名：

cleaned_name = clean_group_name(user.username)
async_to_sync(self.channel_layer.group_add)(cleaned_name, self.channel_name)

方案3：从源头约束用户名格式 #

在User模型中添加验证规则，确保新注册的用户名符合Channels的群组名称要求：

from django.db import models
from django.core.validators import RegexValidator

class User(models.Model):
    username = models.CharField(
        max_length=99,
        validators=[
            RegexValidator(
                regex=r'^[a-zA-Z0-9\-\_\.]+$',
                message='用户名仅可包含ASCII字母数字、连字符、下划线或句点',
                code='invalid_username'
            )
        ],
        unique=True
    )
    # 其他字段...

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