热门标签 | HotTags
当前位置:  开发笔记 > 编程语言 > 正文

DRF框架中Serializer反序列化验证机制详解:深入探讨Validators的应用与优化

在DRF框架的反序列化验证机制中,除了基本的字段类型和长度校验外,还常常需要进行更为复杂的条件限制校验。通过引入`validators`模块,可以实现自定义校验逻辑,如唯一字段校验等。本文将详细探讨`validators`的使用方法及其优化策略,帮助开发者更好地理解和应用这一重要功能。

  反序列化过程中,除了校验字段类型和长度大小之外,还需要有其它的条件限制的校验,这时我们可以使用validators自定义校验项


一、唯一字段校验

1.引入validators模块


from rest_framework import validators

2.在需要唯一校验的字段类里面设置validators字段的属性,值为一个列表,在列表里面添加唯一校验UniqueValidator,除了UniqueValidator的唯一校验,还有其它的唯一校验,根据不同的场景选择使用即可

技术分享图片

唯一校验UniqueValidator类一般接收两个参数,一个是queryset,需要传一个查询集,一个是message,为自定义的异常校验信息,代码如下:


from rest_framework import serializers
from rest_framework import validators
from .models import Projects
class ProjectSerializer(serializers.Serializer):
name
= serializers.CharField(max_length=200, label="项目名称", help_text=项目名称,
validators
=[validators.UniqueValidator(queryset=Projects.objects.all(), message="项目名字段name必须唯一")])
leader
= serializers.CharField(max_length=50, label="项目负责人", help_text=项目负责人)
programmer
= serializers.CharField(max_length=50, label="开发人员", help_text="开发人员")
tester
= serializers.CharField(max_length=50, label="测试人员", help_text="测试人员")

验证结果:

技术分享图片


二、自定义校验器函数

假设我们规定name字段不能包含字符“X”,我们可以在类的外面定义一个函数,这个函数需要给定一个形参,用来接收待校验的数据,并且指定条件下要抛出serializers.ValidationError的异常,如果validators字段值的列表中有多个校验规则,校验过程中会全部进行校验,并以列表的形式返回一组异常校验信息


from rest_framework import serializers
from rest_framework import validators
from .models import Projects
def name_is_not_contain_x(value):
if X in value.upper():
raise serializers.ValidationError("项目名字段name不能包含x的大小写字符")
class ProjectSerializer(serializers.Serializer):
name
= serializers.CharField(max_length=200, label="项目名称", help_text=项目名称,
validators
=[validators.UniqueValidator(queryset=Projects.objects.all(), message="项目名字段name必须唯一"),
name_is_not_contain_x],)
leader
= serializers.CharField(max_length=50, label="项目负责人", help_text=项目负责人)
programmer
= serializers.CharField(max_length=50, label="开发人员", help_text="开发人员")
tester
= serializers.CharField(max_length=50, label="测试人员", help_text="测试人员")

验证结果:

技术分享图片


三、自定义校验器方法

上面第二种采用的是在序列化器类外面创建的校验器函数,同样的也可以在类里面创建一个校验器方法,不同的有以下几点:



  • 方法名必须以validate_作为前缀,后缀为对应的字段名

  • 一定要返回校验之后的值

  • 不需要放在validators的列表中就可以生效


def validate_name(self, value):
if 项目 in value:
raise serializers.ValidationError("项目名称name字段不能包含‘项目’字符")
return value

验证结果:

技术分享图片


三、自定义多字段校验器方法



  • 上面我们都是单字段进行校验,如果是多字段同时进行校验,就需要用到该方法

  • 方法名固定为validate,形参固定为attrs

  • attrs返回一个QueryDict,字段名可以通过字典的方法进行取值,如:attrs[‘name‘]  或者 attrs.get(‘name‘)

  • 必须返回attrs

不需要放在validators的列表中就可以生效


def validate(self, attrs):
if ‘A in attrs.get(name) and ‘B in attrs.get(leader):
raise serializers.ValidationError("项目名称字段name不包含A的同时项目负责人字段leader也不能包含B")

验证结果:

技术分享图片

 我们可以看到该异常校验信息字段的key并不是我们想要的,接下来我们针对这个key进行修改

我们从DRF的源码settings.py模块中可以找到这个字段配置信息

技术分享图片

修改方法:在django项目下的settings.py模块中,修改REST_FRAMEWORK字典中的‘NON_FIELD_ERRORS_KEY‘的值即可


REST_FRAMEWORK = {
NON_FIELD_ERRORS_KEY: more_errors
}

验证结果:
技术分享图片


推荐阅读
  • iOS 开发技巧:TabBarController 自定义与本地通知设置
    本文介绍了如何在 iOS 中自定义 TabBarController 的背景颜色和选中项的颜色,以及如何使用本地通知设置应用程序图标上的提醒个数。通过这些技巧,可以提升应用的用户体验。 ... [详细]
  • ListView简单使用
    先上效果:主要实现了Listview的绑定和点击事件。项目资源结构如下:先创建一个动物类,用来装载数据:Animal类如下:packagecom.example.simplelis ... [详细]
  • Django Token 认证详解与 HTTP 401、403 状态码的区别
    本文详细介绍了如何在 Django 中配置和使用 Token 认证,并解释了 HTTP 401 和 HTTP 403 状态码的区别。通过具体的代码示例,帮助开发者理解认证机制及权限控制。 ... [详细]
  • 深入解析动态代理模式:23种设计模式之三
    在设计模式中,动态代理模式是应用最为广泛的一种代理模式。它允许我们在运行时动态创建代理对象,并在调用方法时进行增强处理。本文将详细介绍动态代理的实现机制及其应用场景。 ... [详细]
  • 深入解析 Android IPC 中的 Messenger 机制
    本文详细介绍了 Android 中基于消息传递的进程间通信(IPC)机制——Messenger。通过实例和源码分析,帮助开发者更好地理解和使用这一高效的通信工具。 ... [详细]
  • 本文详细介绍了如何在Android 4.4及以上版本中配置WebView以实现内容的自动高度调整和屏幕适配,确保中文显示正常,并提供代码示例。 ... [详细]
  • 本文探讨了在 SQL Server 中使用 JDBC 插入数据时遇到的问题。通过详细分析代码和数据库配置,提供了解决方案并解释了潜在的原因。 ... [详细]
  • 本题要求在一组数中反复取出两个数相加,并将结果放回数组中,最终求出最小的总加法代价。这是一个经典的哈夫曼编码问题,利用贪心算法可以有效地解决。 ... [详细]
  • 程序员如何优雅应对35岁职业转型?这里有深度解析
    本文探讨了程序员在职业生涯中如何通过不断学习和技能提升,优雅地应对35岁左右的职业转型挑战。我们将深入分析当前热门技术趋势,并提供实用的学习路径。 ... [详细]
  • 本文详细介绍了get和set方法的作用及其在编程中的实现方式,同时探讨了点语法的使用场景。通过具体示例,解释了属性声明与合成存取方法的概念,并补充了相关操作的最佳实践。 ... [详细]
  • 本文详细介绍了 Android 开发中 layout_gravity 属性的使用方法及其在不同布局下的效果,旨在帮助开发者更好地理解和利用这一属性来精确控制视图的布局。 ... [详细]
  • 本文介绍如何从字符串中移除大写、小写、特殊、数字和非数字字符,并提供了多种编程语言的实现示例。 ... [详细]
  • 深入理解ExtJS:从入门到精通
    本文详细介绍了ExtJS的功能及其在大型企业前端开发中的应用。通过实例和详细的文件结构解析,帮助初学者快速掌握ExtJS的核心概念,并提供实用技巧和最佳实践。 ... [详细]
  • 本文探讨了如何利用HTML5和JavaScript在浏览器中进行本地文件的读取和写入操作,并介绍了获取本地文件路径的方法。HTML5提供了一系列API,使得这些操作变得更加简便和安全。 ... [详细]
  • 本文介绍了如何通过在数据库表中增加一个字段来记录文章的访问次数,并提供了一个示例方法用于更新该字段值。 ... [详细]
author-avatar
大豆子
这个家伙很懒,什么也没留下!
PHP1.CN | 中国最专业的PHP中文社区 | DevBox开发工具箱 | json解析格式化 |PHP资讯 | PHP教程 | 数据库技术 | 服务器技术 | 前端开发技术 | PHP框架 | 开发工具 | 在线工具
Copyright © 1998 - 2020 PHP1.CN. All Rights Reserved | 京公网安备 11010802041100号 | 京ICP备19059560号-4 | PHP1.CN 第一PHP社区 版权所有