1. [
  1. 课程介绍
  2. ](_index_)
    1. [
  1. 引入DjangoRESTframework
  2. ](c01-introducetodrf_index)
  3. -
  4. [
  5. Web应用模式
  6. ](c01-introducetodrf_separatedfrontendandbackend)
    1. [
  1. 认识RESTful
  2. ](c01-introducetodrf_introducetorest)
    1. [
  1. RESTful设计方法
  2. ](c01-introducetodrf_howtodesignrest)
    1. [
  1. 使用Django开发REST接口
  2. ](c01-introducetodrf_developrestapiwithdjango)
    1. [
  1. 明确REST接口开发的核心任务
  2. ](c01-introducetodrf_coretasktodeveloprestapi)
    1. [
  1. DjangoRESTframework简介
  2. ](c01-introducetodrf_aboutdrf)
    1. [
  1. DRF工程搭建
  2. ](c02-drfproject_index)
  3. -
  4. [
  5. 环境安装与配置
  6. ](c02-drfproject_installandconfig)
    1. [
  1. 见识DRF的魅力
  2. ](c02-drfproject_thefirstdrfprogram)
    1. [
  1. Serializer序列化器
  2. ](c03-serializer_index)
  3. -
  4. [
  5. 定义Serializer
  6. ](c03-serializer_declaring)
    1. [
  1. 序列化使用
  2. ](c03-serializer_serializing)
    1. [
  1. 反序列化使用
  2. ](c03-serializer_deserializing)
    1. [
  1. 模型类序列化器ModelSerializer
  2. ](c03-serializer_modelserializer)
    1. [
  1. 视图
  2. ](c04-view_index)
  3. -
  4. [
  5. RequestResponse
  6. ](c04-view_requestandresponse)
    1. [
  1. 视图概览
  2. ](c04-view_view)
    1. [
  1. 视图说明
  2. ](c04-view_viewintroduction)
    1. [
  1. 视图集ViewSet
  2. ](c04-view_viewset)
    1. [
  1. 路由Router
  2. ](c04-view_routers)
    1. [
  1. 其他功能
  2. ](c05-components_index)
  3. -
  4. [
  5. 认证
  6. ](c05-components_authentication)
    1. [
  1. 权限
  2. ](c05-components_permissions)
    1. [
  1. 限流
  2. ](c05-components_throttling)
    1. [
  1. 过滤
  2. ](c05-components_filtering)
    1. [
  1. 排序
  2. ](c05-components_ordering)
    1. [
  1. 分页
  2. ](c05-components_pagination)
    1. [
  1. 版本
  2. ](c05-components_versioning)
    1. [
  1. 异常处理
  2. ](c05-components_exceptions)
    1. [
  1. 自动生成接口文档
  2. ](c05-components_documents)
    1. [
    2. Published with GitBook
    3. ](https://www.gitbook.com)

课程介绍

反序列化使用

1. 验证

使用序列化器进行反序列化时,需要对数据进行验证后,才能获取验证成功的数据或保存成模型类对象。
在获取反序列化的数据前,必须调用is_valid()方法进行验证,验证成功返回True,否则返回False。
验证失败,可以通过序列化器对象的errors属性获取错误信息,返回字典,包含了字段和字段的错误。如果是非字段错误,可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。
验证成功,可以通过序列化器对象的validated_data属性获取数据。
在定义序列化器时,指明每个字段的序列化类型和选项参数,本身就是一种验证行为。
如我们前面定义过的BookInfoSerializer

  1. class BookInfoSerializer(serializers.Serializer):
  2. """图书数据序列化器"""
  3. id = serializers.IntegerField(label='ID', read_only=True)
  4. btitle = serializers.CharField(label='名称', max_length=20)
  5. bpub_date = serializers.DateField(label='发布日期', required=False)
  6. bread = serializers.IntegerField(label='阅读量', required=False)
  7. bcomment = serializers.IntegerField(label='评论量', required=False)
  8. image = serializers.ImageField(label='图片', required=False)

通过构造序列化器对象,并将要反序列化的数据传递给data构造参数,进而进行验证

  1. from booktest.serializers import BookInfoSerializer
  2. data = {'bpub_date': 123}
  3. serializer = BookInfoSerializer(data=data)
  4. serializer.is_valid() # 返回False
  5. serializer.errors
  6. # {'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')]}
  7. serializer.validated_data # {}
  8. data = {'btitle': 'python'}
  9. serializer = BookInfoSerializer(data=data)
  10. serializer.is_valid() # True
  11. serializer.errors # {}
  12. serializer.validated_data # OrderedDict([('btitle', 'python')])

is_valid()方法还可以在验证失败时抛出异常serializers.ValidationError,可以通过传递raise_exception=True参数开启,REST framework接收到此异常,会向前端返回HTTP 400 Bad Request响应。

  1. # Return a 400 response if the data was invalid.
  2. serializer.is_valid(raise_exception=True)

如果觉得这些还不够,需要再补充定义验证行为,可以使用以下三种方法:

1)validators

在字段中添加validators选项参数,也可以补充验证行为,如

  1. def about_django(value):
  2. if 'django' not in value.lower():
  3. raise serializers.ValidationError("图书不是关于Django的")
  4. class BookInfoSerializer(serializers.Serializer):
  5. """图书数据序列化器"""
  6. id = serializers.IntegerField(label='ID', read_only=True)
  7. btitle = serializers.CharField(label='名称', max_length=20, validators=[about_django])
  8. bpub_date = serializers.DateField(label='发布日期', required=False)
  9. bread = serializers.IntegerField(label='阅读量', required=False)
  10. bcomment = serializers.IntegerField(label='评论量', required=False)
  11. image = serializers.ImageField(label='图片', required=False)

测试:

  1. from booktest.serializers import BookInfoSerializer
  2. data = {'btitle': 'python'}
  3. serializer = BookInfoSerializer(data=data)
  4. serializer.is_valid() # False
  5. serializer.errors
  6. # {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}

2)validate_<field_name>

<field_name>字段进行验证,如

  1. class BookInfoSerializer(serializers.Serializer):
  2. """图书数据序列化器"""
  3. ...
  4. def validate_btitle(self, value):
  5. if 'django' not in value.lower():
  6. raise serializers.ValidationError("图书不是关于Django的")
  7. return value

测试

  1. from booktest.serializers import BookInfoSerializer
  2. data = {'btitle': 'python'}
  3. serializer = BookInfoSerializer(data=data)
  4. serializer.is_valid() # False
  5. serializer.errors
  6. # {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}

3)validate

在序列化器中需要同时对多个字段进行比较验证时,可以定义validate方法来验证,如

  1. class BookInfoSerializer(serializers.Serializer):
  2. """图书数据序列化器"""
  3. ...
  4. def validate(self, attrs):
  5. bread = attrs['bread']
  6. bcomment = attrs['bcomment']
  7. if bread < bcomment:
  8. raise serializers.ValidationError('阅读量小于评论量')
  9. return attrs

测试

  1. from booktest.serializers import BookInfoSerializer
  2. data = {'btitle': 'about django', 'bread': 10, 'bcomment': 20}
  3. s = BookInfoSerializer(data=data)
  4. s.is_valid() # False
  5. s.errors
  6. # {'non_field_errors': [ErrorDetail(string='阅读量小于评论量', code='invalid')]}

REST framework提供的validators:

  • UniqueValidator
    单字段唯一,如
  1. from rest_framework.validators import UniqueValidator
  2. slug = SlugField(
  3. max_length=100,
  4. validators=[UniqueValidator(queryset=BlogPost.objects.all())]
  5. )
  • UniqueTogetherValidation
    联合唯一,如
  1. from rest_framework.validators import UniqueTogetherValidator
  2. class ExampleSerializer(serializers.Serializer):
  3. # ...
  4. class Meta:
  5. validators = [
  6. UniqueTogetherValidator(
  7. queryset=ToDoItem.objects.all(),
  8. fields=('list', 'position')
  9. )
  10. ]

2. 保存

如果在验证成功后,想要基于validated_data完成数据对象的创建,可以通过实现create()和update()两个方法来实现。

  1. class BookInfoSerializer(serializers.Serializer):
  2. """图书数据序列化器"""
  3. ...
  4. def create(self, validated_data):
  5. """新建"""
  6. return BookInfo(**validated_data)
  7. def update(self, instance, validated_data):
  8. """更新,instance为要更新的对象实例"""
  9. instance.btitle = validated_data.get('btitle', instance.btitle)
  10. instance.bpub_date = validated_data.get('bpub_date', instance.bpub_date)
  11. instance.bread = validated_data.get('bread', instance.bread)
  12. instance.bcomment = validated_data.get('bcomment', instance.bcomment)
  13. return instance

如果需要在返回数据对象的时候,也将数据保存到数据库中,则可以进行如下修改

  1. class BookInfoSerializer(serializers.Serializer):
  2. """图书数据序列化器"""
  3. ...
  4. def create(self, validated_data):
  5. """新建"""
  6. return BookInfo.objects.create(**validated_data)
  7. def update(self, instance, validated_data):
  8. """更新,instance为要更新的对象实例"""
  9. instance.btitle = validated_data.get('btitle', instance.btitle)
  10. instance.bpub_date = validated_data.get('bpub_date', instance.bpub_date)
  11. instance.bread = validated_data.get('bread', instance.bread)
  12. instance.bcomment = validated_data.get('bcomment', instance.bcomment)
  13. instance.save()
  14. return instance

实现了上述两个方法后,在反序列化数据的时候,就可以通过save()方法返回一个数据对象实例了

  1. book = serializer.save()

如果创建序列化器对象的时候,没有传递instance实例,则调用save()方法的时候,create()被调用,相反,如果传递了instance实例,则调用save()方法的时候,update()被调用。

  1. from db.serializers import BookInfoSerializer
  2. data = {'btitle': '封神演义'}
  3. serializer = BookInfoSerializer(data=data)
  4. serializer.is_valid() # True
  5. serializer.save() # <BookInfo: 封神演义>
  6. from db.models import BookInfo
  7. book = BookInfo.objects.get(id=2)
  8. data = {'btitle': '倚天剑'}
  9. serializer = BookInfoSerializer(book, data=data)
  10. serializer.is_valid() # True
  11. serializer.save() # <BookInfo: 倚天剑>
  12. book.btitle # '倚天剑'

两点说明:

1) 在对序列化器进行save()保存时,可以额外传递数据,这些数据可以在create()和update()中的validated_data参数获取到

  1. serializer.save(owner=request.user)

2)默认序列化器必须传递所有required的字段,否则会抛出验证异常。但是我们可以使用partial参数来允许部分字段更新

  1. # Update `comment` with partial data
  2. serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True)