定义序列化器
- django REST_Farmework中Serializer使用类定义,虚继承rest_framework.serializer.Serializer
- 作用:
1. 序列化,序列化器会把模型对象转换成字典,经过response以后编程json字符串
2. 反序列化,把客户端发送过来得数据,经过request以后编程字典,序列化器可以把字典转换成模型
3. 反序列化,完成数据校验功能 - 注意:serializer不是只能为数据库模型类定义,也可以为非数据库模型类得数据定义,serializer是独立于数据之外得存在
常用字段类型
常用字段类型:
字段 | 字段构造方式 |
---|---|
BooleanField | BooleanField() |
NullBooleanField | NullBooleanField() |
CharField | CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True) |
EmailField | EmailField(max_length=None, min_length=None, allow_blank=False) |
RegexField | RegexField(regex, max_length=None, min_length=None, allow_blank=False) |
SlugField | SlugField(maxlength=50, min_length=None, allow_blank=False) 正则字段,验证正则模式 [a-zA-Z0-9-]+ |
URLField | URLField(max_length=200, min_length=None, allow_blank=False) |
UUIDField | UUIDField(format='hex_verbose') format: 1) 'hex_verbose' 如"5ce0e9a5-5ffa-654b-cee0-1238041fb31a" 2) 'hex' 如 "5ce0e9a55ffa654bcee01238041fb31a" 3)'int' - 如: "123456789012312313134124512351145145114" 4)'urn' 如: "urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a" |
IPAddressField | IPAddressField(protocol='both', unpack_ipv4=False, **options) |
IntegerField | IntegerField(max_value=None, min_value=None) |
FloatField | FloatField(max_value=None, min_value=None) |
DecimalField | DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None) max_digits: 最多位数 decimal_palces: 小数点位置 |
DateTimeField | DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None) |
DateField | DateField(format=api_settings.DATE_FORMAT, input_formats=None) |
TimeField | TimeField(format=api_settings.TIME_FORMAT, input_formats=None) |
DurationField | DurationField() |
ChoiceField | ChoiceField(choices) choices与Django的用法相同 |
MultipleChoiceField | MultipleChoiceField(choices) |
FileField | FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL) |
ImageField | ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL) |
ListField | ListField(child=, min_length=None, max_length=None) |
DictField |
选项参数:
参数名称 | 作用 |
---|---|
max_length | 最大长度 |
min_lenght | 最小长度 |
allow_blank | 是否允许为空 |
trim_whitespace | 是否截断空白字符 |
max_value | 最小值 |
min_value | 最大值 |
通用参数:
参数名称 | 说明 |
---|---|
read_only | 表明该字段仅用于序列化输出,默认False |
write_only | 表明该字段仅用于反序列化输入,默认False |
required | 表明该字段在反序列化时必须输入,默认True |
default | 反序列化时使用的默认值 |
allow_null | 表明该字段是否允许传入None,默认False |
validators | 该字段使用的验证器 |
error_messages | 包含错误编号与错误信息的字典 |
label | 用于HTML展示API页面时,显示的字段名称 |
help_text | 用于HTML展示API页面时,显示的字段帮助提示信息 |
创建Serializer对象
定义好Serializer类后,就可以创建Serializer对象了
Serializer得构造方法为:
Serializer(instance=None, data=empty, **kwargs)
说明:
1)用于序列化时,将模型类对象传入instance参数
2)用于反序列化时,将要被反序列化得数据传入data参数
3)除了instance和data参数外,再构造Serializer对象时,还可以通过context参数额外添加数据如:
serializer = AccountSerializer(account, context={'request': request})
#通过context参数附加得数据,可以通过Serializer对象得context属性获取
注意:
-
-
序列化器无法直接接收数据,需要我们在视图中创建序列化器对象时把使用的数据传递过来。
-
序列化器的字段声明类似于我们前面使用过的表单系统。
-
开发restful api时,序列化器会帮我们把模型数据转换成字典.
-
drf提供的视图会帮我们把字典转换成json,或者把客户端发送过来的数据转换字典.
序列化器得使用
序列化器得使用分为两个阶段:
-
在客户端请求时,使用序列化器可以完成对数据的反序列化。
-
在服务器响应时,使用序列化器可以完成对数据的序列化。
序列化
1) 先查询出一个学生对象
from students.models import Student student = Student.objects.get(id=3)
2) 构造序列化器对象
from .serializers import StudentSerializer serializer = StudentSerializer(instance=student)
3)获取序列化数据
通过data属性可以获取序列化后的数据
serializer.data # {'id': 4, 'name': '小张', 'age': 18, 'sex': True, 'description': '猴赛雷'}
完整视图代码:
from django.views import View from students.models import Student from .serializers import StudentSerializer from django.http.response import JsonResponse class StudentView(View): """使用序列化器序列化转换单个模型数据""" def get(self,request,pk): # 获取数据 student = Student.objects.get(pk=pk) # 数据转换[序列化过程] serializer = StudentSerializer(instance=student) print(serializer.data) # 响应数据 return JsonResponse(serializer.data)
"""使用序列化器序列化转换多个模型数据""" def get(self,request): # 获取数据 student_list = Student.objects.all() # 转换数据[序列化过程] # 如果转换多个模型对象数据,则需要加上many=True serializer = StudentSerializer(instance=student_list,many=True) print( serializer.data ) # 序列化器转换后的数据 # 响应数据给客户端 # 返回的json数据,如果是列表,则需要声明safe=False return JsonResponse(serializer.data,safe=False) # 访问结果: # [OrderedDict([('id', 1), ('name', 'xiaoming'), ('age', 20), ('sex', True), ('description', '测试')]), OrderedDict([('id', 2), ('name', 'xiaohui'), ('age', 22), ('sex', True), ('description', '后面来的测试')]), OrderedDict([('id', 4), ('name', '小张'), ('age', 18), ('sex', True), ('description', '猴赛雷')])]
反序列化
用途:
1.使用序列化进行反序列化时,需要对数据进行验证后,才能获取验证成功得数据或保存成模型类对象
2.再获取反序列化得数据前,必须调用is_valid()方法进行验证,验证成功后返回True,否则返回False
3.验证失败,可以通过序列化器对象的errors属性获取错误信息,返回字典,包含字段和字段的错误。如果是非字段错误,可以通过修改REST framework配置中的NON_FILED_ERRORS_KEY来控制字典中的键名
4. 验证成功,可以通过序列化器对象的validated_data属性获取数据。
5. 在定义序列化器时,指明每个字段的序列化类型和选项参数,本身就是一种验证行为。
如我们前面定义过的BookInfoSerializer
class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" id = serializers.IntegerField(label='ID', read_only=True) btitle = serializers.CharField(label='名称', max_length=20) bpub_date = serializers.DateField(label='发布日期', required=False) bread = serializers.IntegerField(label='阅读量', required=False) bcomment = serializers.IntegerField(label='评论量', required=False) image = serializers.ImageField(label='图片', required=False)
通过构造序列化器对象,并将要反序列化的数据传递给data构造参数,进而进行验证
from booktest.serializers import BookInfoSerializer data = {'bpub_date': 123} serializer = BookInfoSerializer(data=data) serializer.is_valid() # 返回False serializer.errors # {'btitle': [ErrorDetail(string='This field is required.', code='required')], 'bpub_date': [ErrorDetail(string='Date has wrong format. Use one of these formats instead: YYYY[-MM[-DD]].', code='invalid')]} serializer.validated_data # {} data = {'btitle': 'python'} serializer = BookInfoSerializer(data=data) serializer.is_valid() # True serializer.errors # {} serializer.validated_data # OrderedDict([('btitle', 'python')])
is_valid()方法还可以在验证失败时抛出异常serializers.ValidationError,可以通过传递raise_exception=True参数开启,REST framework接收到此异常,会向前端返回HTTP 400 Bad Request响应。
# Return a 400 response if the data was invalid. serializer.is_valid(raise_exception=True)
如果觉得这些还不够,需要再补充定义验证行为,可以使用以下三种方法:
1) validate_字段名
对<field_name>
字段进行验证,如
class StudentSerializer(serializers.Serializer): """学生数据序列化器""" ... # 序列化器中可以自定义单个字段的验证方法 def validate_<字段名>(用户提交的字段数据): def validate_name(self,data): if(data=="老男孩"): raise serializers.ValidationError("用户名不能是老男孩") # 验证完成以后务必要返回字段值 return data
2) validate
在序列化器中需要同时对多个字段进行比较验证时,可以定义validate方法来验证,如
class StudentSerializer(serializers.Serializer): """学生数据序列化器""" ... # 方法名时固定的,用于验证多个字段,参数就是实例化序列化器类时的data参数 def validate(self,data): name = data.get("name") if(name == "python"): raise serializers.ValidationError("用户名不能是python") age = data.get("age") if(age==0): raise serializers.ValidationError("年龄不能是0") # 验证完成以后务必要返回data return data
3) validators
在字段中添加validators选项参数,也可以补充验证行为,如
def check_age(age): if age ==50: raise serializers.ValidationError("年龄不能刚好是50") return age class StudentSerializer(serializers.Serializer): # 需要转换的字段声明 # 小括号里面声明主要提供给反序列化使用的 name = serializers.CharField(required=True, max_length=20) age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age]) sex = serializers.BooleanField(default=True) description = serializers.CharField(required=False,allow_null=True, allow_blank=True)
反序列化-保存数据
前面的验证数据成功后,我们可以使用序列化器来完成数据反序列化的过程.这个过程可以把数据转成模型类对象.
可以通过实现create()和update()两个方法来实现。
from rest_framework import serializers from students.models import Student def check_age(age): if age ==50: raise serializers.ValidationError("年龄不能刚好是50") return age class StudentSerializer(serializers.Serializer): # 需要转换的字段声明 # 小括号里面声明主要提供给反序列化使用的 name = serializers.CharField(required=True, max_length=20) age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age]) sex = serializers.BooleanField(default=True) description = serializers.CharField(required=False,allow_null=True, allow_blank=True) # 如果序列化器调用的模型中的字段声明,则需要声明Meta类 # 验证 # 序列化器中可以自定义单个字段的验证方法 def validate_<字段名>(用户提交的字段数据): def validate_name(self,data): if(data=="老男孩"): raise serializers.ValidationError("用户名不能是老男孩") # 验证完成以后务必要返回字段值 return data # 方法名时固定的,用于验证多个字段,参数就是实例化序列化器类时的data参数 def validate(self,data): name = data.get("name") if(name == "python"): raise serializers.ValidationError("用户名不能是python") age = data.get("age") if(age==0): raise serializers.ValidationError("年龄不能是0") # 验证完成以后务必要返回data return data # 添加和更新代码 # 序列化器中会提供了两个方法: create 和 update,方法名是固定的 def create(self, validated_data): # validated_data 参数,在序列化器调用时,会自动传递验证完成以后的数据 student = Student.objects.create( name=self.validated_data.get("name"), age=self.validated_data.get("age"), sex=self.validated_data.get("sex") ) return student def update(self,instance,validated_data): """更新学生信息""" instance.name=validated_data.get("name") instance.sex=validated_data.get("sex") instance.age=validated_data.get("age") instance.description=validated_data.get("description") # 调用模型的save更新保存数据 instance.save() return instance
book = serializer.save()
视图代码:
# Create your views here. from django.http import JsonResponse from django.views import View from .serializers import StudentSerializer from students.models import Student class StudentView(View): def post(self,request): """添加一个学生""" .... def put(self,request): """更新学生信息""" # 接受参数 data = { "id":9, "name":"abc", "age":18, "sex":1, "description":"测试", } # 获取要修改的数据 instance = Student.objects.get(pk=data.get("id")) # 调用序列化器 serializer = StudentSerializer(instance=instance,data=data) # 验证 serializer.is_valid(raise_exception=True) # 转换成模型数据 student = serializer.save() return JsonResponse({"message": "ok"})
附加说明
# request.user 是django中记录当前登录用户的模型对象 serializer.save(owner=request.user)
2)默认序列化器必须传递所有required的字段,否则会抛出验证异常。但是我们可以使用partial参数来允许部分字段更新
# 更新学生的部分字段信息,当数据库允许为空,但是序列化器要求必须字段填写的时候,可以使用以下方式避开 serializer = StudentSerializer(instance=instance, data=data, partial=True)
把上面序列化器子应用sers和反序列化器子应用unsers里面的序列化器进行对比。
from rest_framework import serializers # 声明序列化器,所有的序列化器都要直接或者间接继承于 Serializer # 其中,ModelSerializer是Serializer的子类,ModelSerializer在Serializer的基础上进行了代码简化 class StudentSerializer(serializers.Serializer): """学生信息序列化器""" # 1. 需要进行数据转换的字段 id = serializers.IntegerField() name = serializers.CharField() age = serializers.IntegerField() sex = serializers.BooleanField() description = serializers.CharField()
from rest_framework import serializers from students.models import Student def check_age(age): if age ==50: raise serializers.ValidationError("年龄不能刚好是50") return age class StudentSerializer(serializers.Serializer): # 需要转换的字段声明 # 小括号里面声明主要提供给反序列化使用的 name = serializers.CharField(required=True, max_length=20) age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age]) sex = serializers.BooleanField(default=True) description = serializers.CharField(required=True, allow_null=True, allow_blank=True) # 如果序列化器调用的模型中的字段声明,则需要声明Meta类 # 验证 # 序列化器中可以自定义单个字段的验证方法 def validate_<字段名>(用户提交的字段数据): def validate_name(self,data): if(data=="老男孩"): raise serializers.ValidationError("用户名不能是老男孩") # 验证完成以后务必要返回字段值 return data # 方法名时固定的,用于验证多个字段,参数就是实例化序列化器类时的data参数 def validate(self,data): name = data.get("name") if(name == "python"): raise serializers.ValidationError("用户名不能是python") age = data.get("age") if(age==0): raise serializers.ValidationError("年龄不能是0") # 验证完成以后务必要返回data return data # 添加和更新代码 # 序列化器中会提供了两个方法: create 和 update,方法名是固定的 def create(self, validated_data): # validated_data 参数,在序列化器调用时,会自动传递验证完成以后的数据 student = Student.objects.create( name=self.validated_data.get("name"), age=self.validated_data.get("age"), sex=self.validated_data.get("sex") ) return student def update(self,instance,validated_data): """更新学生信息""" instance.name=validated_data.get("name") instance.sex=validated_data.get("sex") instance.age=validated_data.get("age") instance.description=validated_data.get("description") # 调用模型的save更新保存数据 instance.save() return instance
所以在开发的时候,我们一般都是直接写在一起,那么有些字段只会出现在序列化器阶段,例如ID。还有些字段只会出现在反序列化阶段,例如:用户密码。
那么, 我们需要在序列化器类中,声明那些字段是在序列化时使用,哪些字段在反序列化中使用了。
最终序列化器中的代码:
from rest_framework import serializers from students.models import Student def check_age(age): if age ==50: raise serializers.ValidationError("年龄不能刚好是50") return age class StudentSerializer(serializers.Serializer): # 需要转换的字段声明 # 小括号里面声明主要提供给反序列化使用的 id=serializers.IntegerField(read_only=True) name = serializers.CharField(required=True, max_length=20) age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age]) sex = serializers.BooleanField(default=True,write_only=True) description = serializers.CharField(required=True, allow_null=True, allow_blank=True) # 如果序列化器调用的模型中的字段声明,则需要声明Meta类 # 验证 # 序列化器中可以自定义单个字段的验证方法 def validate_<字段名>(用户提交的字段数据): def validate_name(self,data): if(data=="老男孩"): raise serializers.ValidationError("用户名不能是老男孩") # 验证完成以后务必要返回字段值 return data # 方法名时固定的,用于验证多个字段,参数就是实例化序列化器类时的data参数 def validate(self,data): name = data.get("name") if(name == "python"): raise serializers.ValidationError("用户名不能是python") age = data.get("age") if(age==0): raise serializers.ValidationError("年龄不能是0") # 验证完成以后务必要返回data return data # 添加和更新代码 # 序列化器中会提供了两个方法: create 和 update,方法名是固定的 def create(self, validated_data): # validated_data 参数,在序列化器调用时,会自动传递验证完成以后的数据 student = Student.objects.create( name=self.validated_data.get("name"), age=self.validated_data.get("age"), sex=self.validated_data.get("sex") ) return student def update(self,instance,validated_data): """更新学生信息""" instance.name=validated_data.get("name") instance.sex=validated_data.get("sex") instance.age=validated_data.get("age") instance.description=validated_data.get("description") # 调用模型的save更新保存数据 instance.save() return instance
模型类序列化器
如果我们想要使用序列化器对应的是Django的模型类,DRF为我们提供了ModelSerializer模型类序列化器来帮助我们快速创建一个Serializer类。
ModelSerializer与常规的Serializer相同,但提供了:
-
基于模型类自动生成一系列字段
-
基于模型类自动为Serializer生成validators,比如unique_together
-
包含默认的create()和update()的实现
定义:
-
-
fields 指明为模型类的哪些字段生成
指定字段
class BookInfoSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = BookInfo fields = ('id', 'btitle', 'bpub_date')
2) 使用exclude可以明确排除掉哪些字段
class BookInfoSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = BookInfo exclude = ('image',)
3) 显示指明字段,如:
class HeroInfoSerializer(serializers.ModelSerializer): hbook = BookInfoSerializer() class Meta: model = HeroInfo fields = ('id', 'hname', 'hgender', 'hcomment', 'hbook')
4) 指明只读字段
可以通过read_only_fields指明只读字段,即仅用于序列化输出的字段
class BookInfoSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = BookInfo fields = ('id', 'btitle', 'bpub_date', 'bread', 'bcomment') read_only_fields = ('id', 'bread', 'bcomment')
from rest_framework import serializers from students.models import Student class StudentModelSerializer(serializers.ModelSerializer): # 额外字段声明,必须在fields里面也要声明上去,否则序列化器不会调用 # password2 = serializers.CharField(write_only=True,required=True) # 如果模型类序列化器,必须声明本次调用是哪个模型,模型里面的哪些字段 class Meta: model = Student # fields = ["id","name","age","description","sex","password2"] fields = ["id","name","age","description","sex"] # fields = "__all__" # 表示操作模型中的所有字段 # 添加额外的验证选项 extra_kwargs = { "sex":{"write_only":True,}, "id":{"read_only":True,} } # 验证代码 # 也可以重新声明一个create和update