定义serializer
Django REST framework中的Serializer使用类来定义,须继承自rest_framework.serializers.Serializer。
# 学院表 class College(models.Model): collegename=models.CharField('学院名称',max_length=30) def __str__(self): return self.collegename # 班级表 class Classes(models.Model): classxuhao=models.IntegerField('班级序号') classname=models.CharField('班级名称',max_length=30) college=models.ForeignKey(to=College,on_delete=models.CASCADE)
为模型插入一个序列化器
from rest_framework import serializers from .models import * class Collegeserializers(serializers.Serializer): collegename = serializers.CharField(max_length=20) class Classesserializers(serializers.Serializer): classxuhao = serializers.CharField() classname = serializers.CharField(max_length=20,validators=[myva]) # 根据StringRelatedField可以查询到关联字段学院名称,设置只读属性,序列化的时候使用 college = serializers.StringRelatedField(read_only=True) # 获取关联的数据的id,需要设置成IntegerField, college_id = serializers.IntegerField()
注:serializer不是只能为数据库模型类定义,也可以为非数据库模型类的数据定义。serializer是独立于数据库之外的存在。
序列化的使用
data获取序列化后数据
如果要被序列化的是包含多条数据的查询集QuerySet,可以通过添加many=True参数补充说明
class GetView(View): def get(self, request): data = Classes.objects.all() serial = Classesserializers(data, many=True) return JsonResponse(serial.data, safe=False) # 添加和修改是反序列化,需要进行验证 # 序列化过程:将获取到的数据对象转化为json返回前端,获取后端数据库中的数据-->json返回前端 # 反序列化:将前端的数据转化为数据对象,接收前端->验证数据->保存或更新新的数据对象
反序列化的使用
验证
使用序列化器进行反序列化时,需要对数据进行验证后,才能获取验证成功的数据或保存成模型类对象。
在获取反序列化的数据前,必须调用is_valid()方法进行验证,验证成功返回True,否则返回False。
验证失败,可以通过序列化器对象的errors属性获取错误信息,返回字典,包含了字段和字段的错误。如果是非字段错误,可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。
验证成功,可以通过序列化器对象的validated_data属性获取数据。
is_valid()方法还可以在验证失败时抛出异常serializers.ValidationError,可以通过传递raise_exception=True参数开启,REST framework接收到此异常,会向前端返回HTTP 400 Bad Request响应。
保存
如果在验证成功后,想要基于validated_data完成数据对象的创建,可以通过实现create()和update()两个方法来实现。
如果创建序列化器对象的时候,没有传递instance实例,则调用save()方法的时候,create()被调用,相反,如果传递了instance实例,则调用save()方法的时候,update()被调用。
注意: 在对序列化器进行save()保存时,可以额外传递数据,这些数据可以在create()和update()中的validated_data参数获取到
模型类序列化器ModelSerializer
如果我们想要使用序列化器对应的是Django的模型类,DRF为我们提供了ModelSerializer模型类序列化器来帮助我们快速创建一个Serializer类。
ModelSerializer与常规的Serializer相同,但提供了:
- 基于模型类自动生成一系列字段
- 基于模型类自动为Serializer生成validators,比如unique_together
- 包含默认的create()和update()的实现
from rest_framework import serializersclass Modelserialz(serializers.ModelSerializer): class Meta: # model=需要关联的模型里表的名称 model=Classes fields='__all__' #fields里面可以选择__all__获取所有的字段,也可以指定获取哪些字段 fields('','',) extra_kwargs={ 'classname':{'max_length':5} } # extra_kwargs可以为modelserialzer添加或者修改原有的选项参数 # read_only_fields=('classxuhao') read_only_fields设置哪几个字段为只读属性
model 指明参照哪个模型类
fields 指明为模型类的哪些字段生成
使用fields来明确字段,__all__
表名包含所有字段,也可以写明具体哪些字段
使用exclude可以明确排除掉哪些字段
可以通过read_only_fields指明只读字段,即仅用于序列化输出的字段
我们可以使用extra_kwargs参数为ModelSerializer添加或修改原有的选项参数