在Django REST Framework的序列化器使用过程中,全局校验是处理跨字段业务逻辑的重要环节,不少开发者会遇到全局校验方法里无法获取到预期参数的问题,导致校验逻辑无法正常运行。

DRF序列化器全局校验的基本逻辑
DRF序列化器的校验流程分为字段级校验和全局校验两步,字段级校验通过validate_字段名方法实现,仅能获取到单个字段的值;全局校验通过重写validate方法实现,该方法会接收所有字段级校验通过后的参数字典,正常情况下可以在方法内直接通过参数字典获取所有字段的值。
全局校验方法的基本结构如下:
from rest_framework import serializers
class UserRegisterSerializer(serializers.Serializer):
username = serializers.CharField(max_length=20)
password = serializers.CharField(max_length=20)
confirm_password = serializers.CharField(max_length=20)
def validate(self, attrs):
# attrs就是所有字段级校验通过后的参数字典
username = attrs.get('username')
password = attrs.get('password')
confirm_password = attrs.get('confirm_password')
# 这里可以写跨字段的校验逻辑
if password != confirm_password:
raise serializers.ValidationError('两次输入的密码不一致')
return attrs无法获取参数的常见原因
1. 字段未通过字段级校验
全局校验validate方法只有在所有字段级校验都通过之后才会执行,如果某个字段的字段级校验失败,参数不会传递到全局校验方法中,此时在validate里尝试获取该字段的值就会得到None或者触发报错。
比如下面的错误示例,username的字段级校验要求长度不小于5,如果传入的username长度不足,字段级校验就会失败,全局校验不会执行:
from rest_framework import serializers
class UserRegisterSerializer(serializers.Serializer):
username = serializers.CharField(max_length=20)
password = serializers.CharField(max_length=20)
def validate_username(self, value):
if len(value) < 5:
raise serializers.ValidationError('用户名长度不能小于5位')
return value
def validate(self, attrs):
# 如果username字段级校验失败,这里不会执行
username = attrs.get('username')
print(username) # 不会输出
return attrs2. 自定义字段未正确返回校验后的值
如果重写了字段级校验方法,但是没有正确返回校验后的字段值,那么该字段的值不会传递到全局校验的参数中。字段级校验方法必须返回经过校验和处理后的字段值,否则参数会丢失。
from rest_framework import serializers
class UserRegisterSerializer(serializers.Serializer):
username = serializers.CharField(max_length=20)
def validate_username(self, value):
# 错误示例:没有返回value,全局校验里就拿不到username
if len(value) < 5:
raise serializers.ValidationError('用户名长度不能小于5位')
# 缺少return value
def validate(self, attrs):
username = attrs.get('username') # 这里会得到None
return attrs3. 嵌套序列化器的参数传递问题
如果使用了嵌套序列化器,外层序列化器的全局校验方法默认只能获取到嵌套序列化器对应的字段对象,无法直接获取嵌套字段内部的参数,需要先从嵌套对象中提取对应的值。
from rest_framework import serializers
class ProfileSerializer(serializers.Serializer):
age = serializers.IntegerField()
phone = serializers.CharField(max_length=11)
class UserSerializer(serializers.Serializer):
username = serializers.CharField(max_length=20)
profile = ProfileSerializer()
def validate(self, attrs):
# 错误示例:直接获取profile里的age会失败
# age = attrs.get('profile').get('age') # 嵌套序列化器的attrs里profile是OrderedDict,需要正确提取
profile_data = attrs.get('profile')
age = profile_data.get('age')
return attrs对应的解决方法
1. 先排查字段级校验是否全部通过
可以在全局校验方法开头打印attrs参数,查看实际传递过来的字段有哪些,如果缺少某个字段,先检查该字段的字段级校验逻辑是否存在问题,确保字段级校验都通过之后再执行全局校验。
2. 规范字段级校验方法的返回值
所有自定义的字段级校验方法,无论是否对字段值做了处理,都必须返回校验后的字段值,保证该字段的值能够正常传递到全局校验中。
from rest_framework import serializers
class UserRegisterSerializer(serializers.Serializer):
username = serializers.CharField(max_length=20)
def validate_username(self, value):
if len(value) < 5:
raise serializers.ValidationError('用户名长度不能小于5位')
return value # 必须返回处理后的字段值
def validate(self, attrs):
username = attrs.get('username') # 现在可以正常获取
return attrs3. 正确处理嵌套序列化器的参数
对于嵌套序列化器的场景,先通过attrs.get('嵌套字段名')获取到嵌套字段的数据对象,再从该对象中提取需要的内部字段值,如果需要更复杂的嵌套校验,也可以在嵌套序列化器内部单独定义全局校验方法。
总结
DRF序列化器全局校验无法获取参数的问题大多和校验流程的执行顺序、字段级校验的返回值、嵌套参数的提取方式有关,开发者可以通过打印参数字典、检查字段级校验逻辑、规范返回值等方式快速定位问题,掌握这些排查思路后就能轻松解决这类常见问题,保障全局校验逻辑的正常执行。