Django-restframework Serializer验证

最新推荐文章于 2024-05-29 14:02:25 发布

原创最新推荐文章于 2024-05-29 14:02:25 发布 · 3.9k 阅读

6 ·

CC 4.0 BY-SA版权

文章标签：

#serilizer验证

Python 同时被 3 个专栏收录

28 篇文章

订阅专栏

Django

20 篇文章

订阅专栏

Djangorestframework

16 篇文章

订阅专栏

本文介绍了Django-restframework中自带的Serializer验证器，包括UniqueValidator用于唯一性验证，UniqueTogetherValidator确保特定字段组合的唯一性，以及如何在序列化类中定义和自定义字段验证。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

自带验证器

1、UniqueValidator

用于验证（唯一）unique=True的字段，常用参数：

queryset： required，用于明确验证唯一性集合，必须设置
message：当验证失败时的提示信息

from rest_framework.validators import UniqueValidator

slug = SlugField(
    max_length=100,
    validators=[UniqueValidator(queryset=BlogPost.objects.all())]
)

2、 UniqueTogetherValidator

queryset：required，用于明确验证唯一性集合，必须设置
fields: required，字段列表或者元组，字段必须是序列化类中存在的字段
message：当验证失败时的提示信息
UniqueTogetherValidator有一个隐性要求就是验证的字段必须要提供值，除非设置了一个默认值

from rest_framework.validators import UniqueTogetherValidator

class ExampleSerializer(serializers.Serializer):
    class Meta:
        validators = [
            UniqueTogetherValidator(
                queryset=ToDoItem.objects.all(),
                fields=('list', 'position')
            )
        ]

3、serializer 返回字段定义

 	# 所有字段。attrs是字段验证合法之后返回的总的dict
    def validate(self, attrs):
        #前端没有传mobile值到后端，这里添加进来
        attrs["mobile"] = attrs["username"]
        #code是自己添加得，数据库中并没有这个字段，验证完就删除掉
        del attrs["code"]
        return attrs

4、自定义字段验证格式validate_<field_name>，返回的是验证字段的值或是serializers.ValidationError

class MobileVerifySerializer(serializers.ModelSerializer):

    #CareerUser中没有code字段，这里需要自定义一个code序列化字段
    code = serializers.CharField(required=True, write_only=True, max_length=4, min_length=4,
                                 error_messages={
                                        "blank": "请输入验证码",
                                        "required": "请输入验证码",
                                        "max_length": "验证码格式错误",
                                        "min_length": "验证码格式错误"
                                 },
                                help_text="验证码")
    #验证用户名是否存在
    username = serializers.CharField(label="用户名", help_text="用户名", required=True, allow_blank=False,
                                     validators=[UniqueValidator(queryset=CareerUser.objects.all(), message="用户已经存在")])

    #验证code
    def validate_code(self, code):
        # 用户注册，已post方式提交注册信息，post的数据都保存在initial_data里面
        #username就是用户注册的手机号，验证码按添加时间倒序排序，为了后面验证过期，错误等
        verify_records = VerifyCode.objects.filter(mobile=self.initial_data["username"]).order_by("-add_time")

        if verify_records:
            # 最近的一个验证码
            last_record = verify_records[0]
            # 有效期为五分钟。
            five_mintes_ago = datetime.now() - timedelta(hours=0, minutes=5, seconds=0)
            if five_mintes_ago > last_record.add_time:
                raise serializers.ValidationError("验证码过期")

            if last_record.code != code:
                raise serializers.ValidationError("验证码错误")

        else:
            raise serializers.ValidationError("验证码错误")

5、验证器
序列化程序上的各个字段可以包含验证程序，通过在字段实例上声明它们

def multiple_of_ten(value):
    if value % 10 != 0:
        raise serializers.ValidationError('Not a multiple of ten')

class GameRecord(serializers.Serializer):
    score = IntegerField(validators=[multiple_of_ten])
    ...