验证过程
使用序列化器进行反序列化时,需要对数据进行验证后,才能获取验证成功的数据或保存成模型类对象
在获取反序列化的数据前,必须调用
is_valid()
方法进行验证,验证成功返回True
,否则返回False
验证成功: 可以通过序列化器对象的
validated_data
属性获取数据,验证成errors
为空验证失败: 可以通过序列化器对象的
errors
属性取错误信息,返回字典,包含了字段和字段的错误,验证失败validated_data
为空
验证例子
# 班级类用例
class ClassInfoSerializer(serializers.Serializer)
name = serializers.CharField(label='班级名称', max_length=20)
Info = serializers.CharField(label='班级信息', max_length=20)
- 验证成功
data = {'name': 'python'}
serializer = ClassInfoSerializer(data=data)
serializer.is_valid() # True
# 验证成功没有错误信息
serializer.errors # {}
print(serializer.validated_data) # OrderedDict([('name', 'python')])
- 验证失败
data = {'name': 123}
serializer = ClassInfoSerializer(data=data)
serializer.is_valid() # 返回False
# {'btitle': [ErrorDetail(string='This field is required.', code='required')], 'name': [ErrorDetail(string='Date has wrong format. Use one of these formats instead: YYYY[-MM[-DD]].', code='invalid')]}
验证失败validated_data就是空
print(serializer.validated_data) # {}
自定义验证器
单字段验证 validate_*
class ClassInfoSerializer(serializers.Serializer)
name = serializers.CharField(label='班级名称', max_length=20)
Info = serializers.CharField(label='班级信息', max_length=20)
# 对info字段进行单独校验
def validate_info(self, value): # value 就是传进来的info的值
if 'shanghaidaxue' not in value:
raise serializers.ValidationError("上海大学没有这个班级")
#中间可以对信息为所欲为的操作
value += '这个是上海大学的班级'
return value
多字段验证 validate
class ClassInfoSerializer(serializers.Serializer)
name = serializers.CharField(label='班级名称', max_length=20)
Info = serializers.CharField(label='班级信息', max_length=20)
def validate(self, attr): # attr 代表所有的传进来的值,里面是一个字典
#中间对数据为所欲为
attr['name'] += '姓名已经校验过了'
attr['info'] += '信息符合规范'
return attr
validate
发生在validate_
之后,是校验数据的最后一步,中间是对整个数据集的校验一次可以对多个字段进行校验
自定义校验
# 第一步:定义校验器
def about_class(value):
if 'shanghaidaxue' not in value:
raise serializers.ValidationError("上海大学没有这个班级")
# 班级类用例
class ClassInfoSerializer(serializers.Serializer):
name = serializers.CharField(label='班级名称', max_length=20)
#第二步:给字段添加自定义的校验参数
Info = serializers.CharField(label='班级信息', max_length=20, validators=[about_class])
保存信息
# 构造序列化器
class ClassInfoSerializer(serializers.Serializer)
name = serializers.CharField(label='班级名称', max_length=20)
Info = serializers.CharField(label='班级信息', max_length=20)
# 重写创建方法
def create(self, validated_data) #validated_data是已经校验过的数据
instance = ClassInfo.objects.create(**validated_data) # 在数据库创建数据 并返回一个数据库对象
return instance
# 重写更新方法
def update(self, instance, validated_data):# instance 是传进来的数据库对象,是要更新的对象
instance.name = validated_data.get('name', instance.name)#得到validated_data中的name信息
instance.info = validated_data.get('info', instance.info)#如果得不到则使用instance中的name
return instance
- 测试
# 构造一个数据
data = { name:'九年级三班', info:'上海大学九年级三班'}
# 创建数据PYTHON
class3 = ClassInfoSerializer(data)# 得到一个序列化器对象
class3.is_valid()
classinstance = class3.save() # classinstance此时就是一个数据库的对象
# 更新数据
data = { name:'九年级3班'} #只更新 name字段,因为 info不是必传的
classserializer = ClassInfoSerializer(classinstance, data)# 得到序列化器对象
classserializer.is_valid()
classinstance = classserializer.save() #序列化器保存时 调用重写的update方法 并返回一个更新后的数据库对象
- 如果在验证成功后,想要基于
validated_data
完成数据对象的创建,可以通过实现create()和update()两个方法来实现 - 序列化器内部会根据有无传入
instance
(数据库对象) 来判定是创建数据还是更新数据,如果传入instance
就代表需要更新 反之就是创建
字段定义时的校验(校验参数 -> validators参数校验列表) -> 进行单字段的校验 -> 进行多字段联合校验