Django序列化器创建CustomUser时如何排除ManyToMany字段roles？

问题重现 #

你的模型定义：

class CustomUser(AbstractUser):
    # ... 其他字段
    roles = models.ManyToManyField(Role, blank=True)

序列化器的create方法：

class CustomUserSerializer(serializers.ModelSerializer):
    def create(self, validated_data):
        user = CustomUser.objects.create_user(**validated_data)

触发的报错：

Direct assignment to the forward side of a many-to-many set is prohibited. Use roles.set() instead.

原因分析 #

Django的ManyToMany字段无法通过create或create_user直接赋值，必须先创建主对象，再通过set()方法关联关联对象。如果validated_data中包含roles字段，直接解构传入就会触发上述报错。

优雅实现方式 #

方法1：安全移除roles字段后创建用户

从validated_data中弹出roles字段（用默认值避免KeyError），再创建用户，后续如果需要关联角色可以补充set()操作，不需要的话直接忽略即可：

class CustomUserSerializer(serializers.ModelSerializer):
    class Meta:
        model = CustomUser
        fields = '__all__'  # 根据实际需求指定字段，包含roles也没问题

    def create(self, validated_data):
        # 弹出roles字段，默认空列表防止字段不存在时报错
        validated_data.pop('roles', [])
        # 创建用户，此时validated_data已排除roles
        user = CustomUser.objects.create_user(**validated_data)
        # 如果之后需要关联角色，取消下面注释即可
        # user.roles.set(roles)
        return user

方法2：序列化器Meta中排除roles（仅适用于不需要序列化roles的场景）

如果你的序列化器不需要处理roles字段的序列化/反序列化，可以直接在Meta里排除它：

class CustomUserSerializer(serializers.ModelSerializer):
    class Meta:
        model = CustomUser
        exclude = ['roles']  # 排除roles字段

    def create(self, validated_data):
        user = CustomUser.objects.create_user(**validated_data)
        return user

推荐方案 #

优先用方法1，因为它保留了序列化器对roles字段的支持（比如返回用户数据时可以包含roles），同时解决了创建时的报错，扩展性更强——后续如果需要在创建用户时同时关联角色，只需要把弹出的roles变量用set()方法关联即可。

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