知识点:Serializer(偏底层)、ModelSerializer(重点)、ListModelSerializer(辅助群改)前端
为何要使用序列化组件?
视图中查询到的对象和queryset类型不能直接做为数据返回给前台,因此要使用序列化组件python
路由层 urls.pygit
from django.urls import path, re_path from .views import users urlpatterns = [ path('bookinfo/', users.BookInfo.as_view()), re_path('bookinfo/(?P<pk>.*)/$', users.BookInfo.as_view()), ]
模型层:models.py数据库
class BookInfo(models.Model): PUB_CHOICES = [ (0, '商务印书馆'), (1, '人民出版社'), (2, '人民文学出版社 '), (3, '做家出版社') ] pwd = models.CharField(max_length=32, verbose_name='密码') publisher = models.IntegerField(choices=PUB_CHOICES, default=0, verbose_name='出版社') btitle = models.CharField(max_length=20, verbose_name='名称') bpub_date = models.DateField(verbose_name='发布日期', null=True) created_time = models.DateTimeField(auto_now_add=True, verbose_name="建立时间", help_text='建立时间') bread = models.IntegerField(default=0, verbose_name='阅读量') bcomment = models.IntegerField(default=0, verbose_name='评论量') image = models.ImageField(upload_to='icon', verbose_name='图片', default='icon/default.jpg') class Meta: db_table = 'BookInfo' verbose_name = '书籍信息' verbose_name_plural = verbose_name def __str__(self): return '%s' % self.btitle
为这个模型类提供一个序列化器django
from rest_framework import serializers class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" id = serializers.IntegerField(label='ID', read_only=True) pwd = serializers.CharField(label='密码', required=True) publisher = serializers.IntegerField(label='出版社') btitle = serializers.CharField(label='名称', max_length=20) bpub_date = serializers.DateField(label='发布日期', required=False) created_time = serializers.DateTimeField(label='建立时间', required=False) bread = serializers.IntegerField(label='阅读量', required=False) bcomment = serializers.IntegerField(label='评论量', required=False) image = serializers.ImageField(label='图片', required=False) """ 自定义序列化属性 格式: 属性名随意,值由固定的命名规范方法提供 def get_属性名(self, 参与序列化的model对象): 返回值就是自定义序列化属性的值 """ # 出版社显示名称,而不是0,1。。。 publisher_name = serializers.SerializerMethodField() def get_publisher_name(self, obj): # choice类型的解释型值 get_字段_display() 来访问 return obj.get_publisher_display() # 图片显示全路径 image_path = serializers.SerializerMethodField() def get_image_path(self, obj): # settings.MEDIA_URL: 本身配置的 /media/,给后面高级序列化与视图类准备的 # obj.icon不能直接做为数据返回,由于内容虽然是字符串,可是类型是ImageFieldFile类型 return '%s%s%s' % (r'http://127.0.0.1:8000', settings.MEDIA_URL, str(obj.image)) # 自定义虚拟阅读量,原基础增长10 fictitious_bread = serializers.SerializerMethodField() def get_fictitious_bread(self, obj): return obj.bread + 10
注意:serializer不是只能为数据库模型类定义,也能够为非数据库模型类的数据定义。serializer是独立于数据库以外的存在。json
经常使用字段类型:api
字段 | 字段构造方式 |
---|---|
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 | DictField(child=) |
选项参数:安全
参数名称 | 做用 |
---|---|
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的构造方法为:restful
Serializer(instance=None, data=empty, **kwarg)
说明:
1)用于序列化时,将模型类对象传入instance参数
2)用于反序列化时,将要被反序列化的数据传入data参数
3)除了instance和data参数外,在构造Serializer对象时,还可经过context参数额外添加数据,如
serializer = AccountSerializer(account, context={'request': request})
经过context参数附加的数据,能够经过Serializer对象的context属性获取。
使用序列化器的时候必定要注意,序列化器声明了之后,不会自动执行,须要咱们在视图中进行调用才能够
序列化器没法直接接收数据,须要咱们在视图中建立序列化器对象时把使用的数据传递过来。(data,instance传参)
序列化是:数据对象从数据库中查出,经过instance传入序列化器中,必须经过data属性才能将序列化后的数据传给前端,不能直接传序列化对象
反序列化是:数据是经过request.data从前端获取到数据,经过data传入序列化器中进行校验,保存到数据库中
序列化器的字段声明相似于咱们前面使用过的表单系统
开发restful api时,序列化器会帮咱们把模型数据转换成字典。
drf提供的视图会帮咱们把字典转换成json,或者把客户端发过来的数据转换成字典
序列化器的使用分两个阶段:
from .. import models from ..serializers import BookInfoSerializer class BookInfo(APIView): def get(self, request, *args, **kwargs): pk = kwargs.get('pk') if pk: try: # 1) 查询出图书对象 book_obj = models.BookInfo.objects.get(pk=pk) # 2) 构造序列化器 book_ser = BookInfoSerializer(book_obj) # 3) 获取序列化数据 return Response({ 'status': 200, 'msg': 0, # 在序列化的时候没有.data,那么在传给前端的时候必需要.data 'results': book_ser.data # 经过data属性能够获取序列化后的数据 }) except: return Response({ 'status': 201, 'msg': '书籍信息不存在', }) else: # 1) 查询出图书对象:对象列表(queryset)不能直接做为数据返回给前台 book_obj_list = models.BookInfo.objects.all() # 2) 构造序列化器 PS:将对象交给序列化处理,产生序列化对象,若是序列化的数据是由[]嵌套,必定要设置many=True book_ser_data = BookInfoSerializer(book_obj_list, many=True) # 3) 获取序列化数据 return Response({ 'status': 200, 'msg': 0, 'results': book_ser_data.data # 经过data属性能够获取序列化后的数据 })
class BookInfoDeSerializer(serializers.Serializer): """图书序列化器""" id = serializers.IntegerField(label='ID', read_only=True) pwd = serializers.CharField(label='密码', required=True) publisher = serializers.IntegerField(label='出版社', required=False) btitle = serializers.CharField(label='名称', max_length=20, validators=[about_django]) bpub_date = serializers.DateField(label='发布日期', required=False) created_time = serializers.DateTimeField(label='建立时间', required=False) bread = serializers.IntegerField(label='阅读量', required=True) bcomment = serializers.IntegerField(label='评论量', required=True) image = serializers.ImageField(label='图片', required=False) # 自定义有校验规则的反序列化字段,例如确认密码字段re_pwd re_pwd = serializers.CharField(required=True)
经过构造序列化器对象,并将要反序列化的数据传递给data构造参数,进而进行验证
class BookInfo(APIView): # 单增 def post(self, request, *args, **kwargs): request_data = request.data if not isinstance(request_data, dict) or request_data == {}: return Response({ 'status': 1, 'msg': '数据有误', }) book_ser = BookInfoDeSerializer(data=request_data) # 序列化对象调用is_valid()完成校验,校验失败的失败信息都会被存储在 序列化对象.errors # 检验是否合格 raise_exception=True必填的 book_ser.is_valid(raise_exception=True) # book_result是对象<class 'app01.models.Book'>,群增就是列表套一个个对象 book_obj = book_ser.save() return Response({ 'status': 200, 'msg': 'ok', 'results': BookInfoSerializer(instance=book_obj).data }) 上面两句和下面是同样的 # if book_ser.is_valid(): # # 校验经过,完成新增 # book_obj = book_ser.save() # return Response({ # 'status': 0, # 'msg': 'ok', # 'results': BookInfoSerializer(instance=book_obj).data # }) # else: # # 校验失败 # return Response({ # 'status': 1, # 'msg': book_ser.errors, # })
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)
若是还不够,须要在补充定义验证行为,可使用一下三种方法
validate_<field_name>
-局部钩子对<field_name>
字段进行验证
局部钩子:validate_要校验的字段名(self, 当前要校验字段的值)
校验规则:校验经过返回原值,校验失败,抛出异常
class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" ... # 局部钩子:validate_要校验的字段名(self, 当前要校验字段的值) # 校验规则:校验经过返回原值,校验失败,抛出异常 def validate_btitle(self, value): if 'django' not in value.lower(): raise exceptions.ValidationError('图书不是关于Django的') return value
测试
http://127.0.0.1:8000/bookinfo/ { "btitle":"红楼梦", "bpub_date":"2020-10-07" } { "btitle": [ "图书不是关于Django的" ] }
在序列化器中须要同时对多个字段进行比较验证时,能够定义validate方法来验证
全局钩子:validate(self, 经过系统与局部钩子校验以后的全部数据)
class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" ... # 全局钩子:validate(self, 经过系统与局部钩子校验以后的全部数据) def validate(self, attrs): # attrs是字典格式 pwd = attrs.get('pwd') re_pwd = attrs.pop('re_pwd') # 由于re_pwd不须要存入数据库,因此在全局钩子校验中删除掉这个字段 bread = attrs['bread'] bcomment = attrs['bcomment'] if pwd != re_pwd: raise exceptions.ValidationError({'pwd&re_pwd': '两次密码不一致'}) if bread < bcomment: raise serializers.ValidationError('阅读量小于评论量') return attrs
def about_django(value): if 'django' not in value.lower(): raise serializers.ValidationError("validators-图书不是关于Django的") class BookInfoDeSerializer(serializers.Serializer): id = serializers.IntegerField(label='ID', read_only=True) pwd = serializers.CharField(label='密码', required=True) publisher = serializers.IntegerField(label='出版社', required=False) btitle = serializers.CharField(label='名称', max_length=20, validators=[about_django]) bpub_date = serializers.DateField(label='发布日期', required=False) created_time = serializers.DateTimeField(label='建立时间', required=False) bread = serializers.IntegerField(label='阅读量', required=True) bcomment = serializers.IntegerField(label='评论量', required=True) image = serializers.ImageField(label='图片', required=False)
测试:
Copyfrom booktest.serializers import BookInfoSerializer data = {'btitle': 'python'} serializer = BookInfoSerializer(data=data) serializer.is_valid() # False serializer.errors # {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}
validators--->validate_<field_name>(局部)----->validate(全局)
若是在验证成功后,想要基于validated_data完成数据对象的建立,能够经过实现create()和update()两个方法来实现。
class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" ... # 要完成新增,必须重写create方法,validated_data是校验的数据 def create(self, validated_data): # 尽可能在全部校验规则完毕以后,数据能够直接入库 return models.User.objects.create(**validated_data) def update(self, instance, validated_data): """更新,instance为要更新的对象实例""" instance.btitle = validated_data.get('btitle', instance.btitle) instance.bpub_date = validated_data.get('bpub_date', instance.bpub_date) instance.pwd = validated_data.get('pwd', instance.pwd) instance.bread = validated_data.get('bread', instance.bread) instance.bcomment = validated_data.get('bcomment', instance.bcomment) return instance
若是须要在返回数据对象的时候,也将数据保存到数据库中,则能够进行以下修改
class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" ... def create(self, validated_data): """新建""" return BookInfo.objects.create(**validated_data) def update(self, instance, validated_data): """更新,instance为要更新的对象实例""" instance.btitle = validated_data.get('btitle', instance.btitle) instance.bpub_date = validated_data.get('bpub_date', instance.bpub_date) instance.bread = validated_data.get('bread', instance.bread) instance.bcomment = validated_data.get('bcomment', instance.bcomment) instance.save() return instance
实现了上述两个方法后,在反序列化数据的时候,就能够经过save()方法返回一个数据对象实例了
book = serializer.save()
若是建立序列化器对象的时候,没有传递instance实例,则调用save()方法的时候,create()被调用,相反,若是传递了instance实例,则调用save()方法的时候,update()被调用。
models.py
from django.db import models class BookInfo(models.Model): PUB_CHOICES = [ (0, '商务印书馆'), (1, '人民出版社'), (2, '人民文学出版社 '), (3, '做家出版社') ] pwd = models.CharField(max_length=32, verbose_name='密码') publisher = models.IntegerField(choices=PUB_CHOICES, default=0, verbose_name='出版社') btitle = models.CharField(max_length=20, verbose_name='名称') bpub_date = models.DateField(verbose_name='发布日期', null=True) created_time = models.DateTimeField(auto_now_add=True, verbose_name="建立时间", help_text='建立时间') bread = models.IntegerField(default=0, verbose_name='阅读量') bcomment = models.IntegerField(default=0, verbose_name='评论量') image = models.ImageField(upload_to='icon', verbose_name='图片', default='icon/default.jpg') class Meta: db_table = 'BookInfo' verbose_name = '书籍信息' verbose_name_plural = verbose_name def __str__(self): return '%s' % self.btitle
路由:urls
from django.urls import path, re_path from .views import test, users, books, v2books urlpatterns = [ path('bookinfo/', users.BookInfo.as_view()), re_path('bookinfo/(?P<pk>.*)/$', users.BookInfo.as_view()), ]
views视图
rom rest_framework.views import APIView from rest_framework.response import Response from .. import models from ..serializers import UserSerializer, UserDeserializer, BookInfoSerializer, BookInfoDeSerializer class BookInfo(APIView): def get(self, request, *args, **kwargs): pk = kwargs.get('pk') if pk: try: # 1) 查询出图书对象 book_obj = models.BookInfo.objects.get(pk=pk) # 2) 构造序列化器 book_ser = BookInfoSerializer(instance=book_obj) # 3) 获取序列化数据 return Response({ 'status': 200, 'msg': 0, 'results': book_ser.data # 经过data属性能够获取序列化后的数据 }) except: return Response({ 'status': 201, 'msg': '书籍信息不存在', }) else: # 1) 查询出图书对象 book_obj_list = models.BookInfo.objects.all() # 2) 构造序列化器 PS:若是要被序列化的是包含多条数据的查询集QuerySet,能够经过添加many=True参数补充说明 book_ser_data = BookInfoSerializer(instance=book_obj_list, many=True) # 3) 获取序列化数据 return Response({ 'status': 200, 'msg': 0, 'results': book_ser_data.data # 经过data属性能够获取序列化后的数据 }) def post(self, request, *args, **kwargs): request_data = request.data if not isinstance(request_data, dict) or request_data == {}: return Response({ 'status': 1, 'msg': '数据有误', }) book_ser = BookInfoDeSerializer(data=request_data) # 序列化对象调用is_valid()完成校验,校验失败的失败信息都会被存储在 序列化对象.errors # 检验是否合格 raise_exception=True必填的 book_ser.is_valid(raise_exception=True) # book_result是对象<class 'app01.models.Book'>,群增就是列表套一个个对象 book_obj = book_ser.save() return Response({ 'status': 200, 'msg': 'ok', 'results': BookInfoSerializer(instance=book_obj).data }) # if book_ser.is_valid(): # # 校验经过,完成新增 # book_obj = book_ser.save() # return Response({ # 'status': 0, # 'msg': 'ok', # 'results': BookInfoSerializer(instance=book_obj).data # }) # else: # # 校验失败 # return Response({ # 'status': 1, # 'msg': book_ser.errors, # })
serializers.py
from rest_framework import serializers from django.conf import settings from rest_framework.exceptions import ValidationError from . import models # 序列化 class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" id = serializers.IntegerField(label='ID', read_only=True) pwd = serializers.CharField(label='密码', required=True) publisher = serializers.IntegerField(label='出版社', required=False) btitle = serializers.CharField(label='名称', max_length=20) bpub_date = serializers.DateField(label='发布日期', required=False) created_time = serializers.DateTimeField(label='建立时间', required=False) bread = serializers.IntegerField(label='阅读量', required=False) bcomment = serializers.IntegerField(label='评论量', required=False) image = serializers.ImageField(label='图片', required=False) """ 自定义序列化属性 格式: 属性名随意,值由固定的命名规范方法提供 def get_属性名(self, 参与序列化的model对象): 返回值就是自定义序列化属性的值 """ # 出版社显示名称,而不是0,1。。。 publisher_name = serializers.SerializerMethodField() def get_publisher_name(self, obj): # choice类型的解释型值 get_字段_display() 来访问 return obj.get_publisher_display() # 图片显示全路径 image_path = serializers.SerializerMethodField() def get_image_path(self, obj): # settings.MEDIA_URL: 本身配置的 /media/,给后面高级序列化与视图类准备的 # obj.icon不能直接做为数据返回,由于内容虽然是字符串,可是类型是ImageFieldFile类型 return '%s%s%s' % (r'http://127.0.0.1:8000', settings.MEDIA_URL, str(obj.image)) # 自定义虚拟阅读量,原基础增长10 fictitious_bread = serializers.SerializerMethodField() def get_fictitious_bread(self, obj): return obj.bread + 10 def about_django(value): if 'django' not in value.lower(): raise serializers.ValidationError("validators-图书不是关于Django的") # 反序列化 class BookInfoDeSerializer(serializers.Serializer): id = serializers.IntegerField(label='ID', read_only=True) pwd = serializers.CharField(label='密码', required=True) publisher = serializers.IntegerField(label='出版社', required=False) btitle = serializers.CharField(label='名称', max_length=20, validators=[about_django]) bpub_date = serializers.DateField(label='发布日期', required=False) created_time = serializers.DateTimeField(label='建立时间', required=False) bread = serializers.IntegerField(label='阅读量', required=True) bcomment = serializers.IntegerField(label='评论量', required=True) image = serializers.ImageField(label='图片', required=False) # 自定义有校验规则的反序列化字段,例如确认密码字段re_pwd re_pwd = serializers.CharField(required=True) # 局部钩子:validate_要校验的字段名(self, 当前要校验字段的值) # 校验规则:校验经过返回原值,校验失败,抛出异常 def validate_btitle(self, value): if 'django' not in value.lower(): raise exceptions.ValidationError('validate_btitle-图书不是关于Django的') return value # 全局钩子:validate(self, 经过系统与局部钩子校验以后的全部数据) def validate(self, attrs): # attrs是字典格式 pwd = attrs.get('pwd') re_pwd = attrs.pop('re_pwd') # 由于re_pwd不须要存入数据库,因此在全局钩子校验中删除掉这个字段 bread = attrs['bread'] bcomment = attrs['bcomment'] if pwd != re_pwd: raise exceptions.ValidationError({'pwd&re_pwd': '两次密码不一致'}) if bread < bcomment: raise serializers.ValidationError('阅读量小于评论量') return attrs # 要完成新增,必须重写create方法,validated_data是校验的数据 def create(self, validated_data): # 尽可能在全部校验规则完毕以后,数据能够直接入库 return models.User.objects.create(**validated_data) def update(self, instance, validated_data): """更新,instance为要更新的对象实例""" instance.btitle = validated_data.get('btitle', instance.btitle) instance.bpub_date = validated_data.get('bpub_date', instance.bpub_date) instance.pwd = validated_data.get('pwd', instance.pwd) instance.bread = validated_data.get('bread', instance.bread) instance.bcomment = validated_data.get('bcomment', instance.bcomment) return instance
1) 在对序列化器进行save()保存时,能够额外传递数据,这些数据能够在create()和update()中的validated_data参数获取到
# request.user 是django中记录当前登陆用户的模型对象 serializer.save(owner=request.user)
2)默认序列化器必须传递全部required的字段,不然会抛出验证异常。可是咱们可使用partial参数来容许部分字段更新
# Update `comment` with partial data serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True)