嵌套Serializer的get_or_create唯一约束验证错误解决方案咨询

我定义了如下两个Serializer：

class UserModelSerializer(ModelSerializer):

    class Meta:
        model = User
        fields = ['id', 'username', 'email', 'date_joined', 'is_active', 'is_verified', 'is_superuser', 'is_staff', 'is_hidden', 'created_date']
        read_only_fields = ['id', 'date_joined', 'is_active', 'is_verified', 'is_superuser', 'is_staff', 'is_hidden', 'created_date']

以及：

class UserBanModelSerializer(ModelSerializer):
    user = UserModelSerializer()

    class Meta:
        model = UserBan
        fields = ['id', 'user', 'until', 'reason', 'description', 'created_date']
        read_only_fields = ['id', 'created_date']

    def create(self, validated_data):
        user_data = validated_data.pop('user')
        user, created = User.objects.get_or_create(**user_data)
        user_ban = UserBan.objects.create(user=user, **validated_data)

        return user_ban

需求是：序列化返回时包含完整的User数据，同时允许前端将完整的User数据回传给服务器（若仅在to_representation中添加UserModelSerializer，前端需传user id而非完整数据）。但调用serializer的is_valid方法时，出现以下验证错误：

"username": [
    "A user with that username already exists."
],
"email": [
    "A user with that email already exists."
]

我知道可以通过extra_kwargs移除username和email的验证器，但不想移除username的验证器，希望由数据库来处理唯一约束；且仅当用户不存在时才创建User，创建UserBan时不强制新建User。

方法一：自定义专用反序列化Serializer #

核心思路是：反序列化时用移除了唯一验证器的Serializer（保留格式等其他验证），序列化输出时用原有的UserModelSerializer返回完整用户数据。

1. 定义用于反序列化的UserCreateOrGetSerializer：

from rest_framework.validators import UniqueValidator

class UserCreateOrGetSerializer(UserModelSerializer):
    class Meta(UserModelSerializer.Meta):
        extra_kwargs = {
            # 移除唯一验证器，保留其他验证逻辑
            'email': {'validators': [v for v in User._meta.get_field('email').validators if not isinstance(v, UniqueValidator)]},
            'username': {'validators': [v for v in User._meta.get_field('username').validators if not isinstance(v, UniqueValidator)]},
        }

2. 修改UserBanModelSerializer，重写to_representation方法实现序列化输出的转换：

class UserBanModelSerializer(ModelSerializer):
    # 反序列化时用自定义的Serializer
    user = UserCreateOrGetSerializer()

    class Meta:
        model = UserBan
        fields = ['id', 'user', 'until', 'reason', 'description', 'created_date']
        read_only_fields = ['id', 'created_date']

    def create(self, validated_data):
        user_data = validated_data.pop('user')
        user, created = User.objects.get_or_create(**user_data)
        user_ban = UserBan.objects.create(user=user, **validated_data)
        return user_ban

    def to_representation(self, instance):
        # 序列化输出时切换回原有的UserModelSerializer
        representation = super().to_representation(instance)
        representation['user'] = UserModelSerializer(instance.user).data
        return representation

方法二：动态移除验证器 #

无需额外定义Serializer，在UserBanModelSerializer初始化时，根据操作类型动态移除嵌套User字段的唯一验证器：

from rest_framework.validators import UniqueValidator

class UserBanModelSerializer(ModelSerializer):
    user = UserModelSerializer()

    class Meta:
        model = UserBan
        fields = ['id', 'user', 'until', 'reason', 'description', 'created_date']
        read_only_fields = ['id', 'created_date']

    def __init__(self, *args, **kwargs):
        super().__init__(*args, **kwargs)
        # 仅在创建操作（无instance）时移除唯一验证器
        if self.instance is None:
            for field_name in ['username', 'email']:
                field = self.fields['user'].fields.get(field_name)
                if field:
                    # 过滤掉UniqueValidator类型的验证器
                    field.validators = [v for v in field.validators if not isinstance(v, UniqueValidator)]

    def create(self, validated_data):
        user_data = validated_data.pop('user')
        user, created = User.objects.get_or_create(**user_data)
        user_ban = UserBan.objects.create(user=user, **validated_data)
        return user_ban

说明 #

两种方法都能实现：

• 前端可以传递完整的User数据，不会触发唯一约束的验证错误
• 序列化返回时依然输出完整的User数据
• 保留了username、email的格式等其他验证逻辑，仅移除了重复校验
• 数据库层面的唯一约束会通过get_or_create自动处理，存在则获取用户，不存在则新建

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