Cf序列化器-Serializer解析
Cf序列化器-Serializer定义序列化器Django REST framework中的Serializer使用类来定义,须继承自rest_framework.serializers.Serializer。 例如,我们已有了一个数据库模型类BookInfo class BookInfo(models.Model): btitle = models.CharField(max_length=20,verbose_name='名称') bpub_date = models.DateField(verbose_name='发布日期',null=True) bread = models.IntegerField(default=0,verbose_name='阅读量') bcomment = models.IntegerField(default=0,verbose_name='评论量') image = models.ImageField(upload_to='booktest',verbose_name='图片',null=True) 我们想为这个模型类提供一个序列化器,可以定义如下: 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) 注意:serializer不是只能为数据库模型类定义,也可以为非数据库模型类的数据定义。serializer是独立于数据库之外的存在。 常用字段类型:
选项参数:
通用参数:
创建Serializer对象定义好Serializer类后,就可以创建Serializer对象了。 Serializer的构造方法为: Serializer(instance=None,data=empty,**kwarg) 说明: 1)用于序列化时,将模型类对象传入instance参数 2)用于反序列化时,将要被反序列化的数据传入data参数 3)除了instance和data参数外,在构造Serializer对象时,还可通过context参数额外添加数据,如 serializer = AccountSerializer(account,context={'request': request}) 通过context参数附加的数据,可以通过Serializer对象的context属性获取。
序列化器的使用序列化器的使用分两个阶段:
序列化基本使用1) 先查询出一个图书对象 from booktest.models import BookInfo book = BookInfo.objects.get(id=2) 2) 构造序列化器对象 from booktest.serializers import BookInfoSerializer serializer = BookInfoSerializer(book) 3)获取序列化数据 通过data属性可以获取序列化后的数据 serializer.data # {'id': 2,'btitle': '天龙八部','bpub_date': '1986-07-24','bread': 36,'bcomment': 40,'image': None} 4)如果要被序列化的是包含多条数据的查询集QuerySet,可以通过添加many=True参数补充说明 book_qs = BookInfo.objects.all() serializer = BookInfoSerializer(book_qs,many=True) serializer.data # [OrderedDict([('id',2),('btitle','天龙八部'),('bpub_date','1986-07-24'),('bread',36),('bcomment',40),('image',N]),OrderedDict([('id',3),'笑傲江湖'),'1995-12-24'),20),80),('image'ne)]),4),'雪山飞狐'),'1987-11-11'),58),24),('ima None)]),5),'西游记'),'1988-01-01'),10),('im','booktest/xiyouji.png')])] 反序列化数据验证使用序列化器进行反序列化时,需要对数据进行验证后,才能获取验证成功的数据或保存成模型类对象。 在获取反序列化的数据前,必须调用is_valid()方法进行验证,验证成功返回True,否则返回False。 验证失败,可以通过序列化器对象的errors属性获取错误信息,返回字典,包含了字段和字段的错误。如果是非字段错误,可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。 验证成功,可以通过序列化器对象的validated_data属性获取数据。 在定义序列化器时,指明每个字段的序列化类型和选项参数,本身就是一种验证行为。 如我们前面定义过的BookInfoSerializer class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" id = serializers.IntegerField(label='ID',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_字段名对 class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" ... def validate_btitle(self,value): if 'django' not in value.lower(): raise serializers.ValidationError("图书不是关于Django的") return value 测试 from booktest.serializers import BookInfoSerializer data = {'btitle': 'python'} serializer = BookInfoSerializer(data=data) serializer.is_valid() # False serializer.errors # {'btitle': [ErrorDetail(string='图书不是关于Django的',code='invalid')]} 2) validate在序列化器中需要同时对多个字段进行比较验证时,可以定义validate方法来验证,如 class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" ... def validate(self,attrs): bread = attrs['bread'] bcomment = attrs['bcomment'] if bread < bcomment: raise serializers.ValidationError('阅读量小于评论量') return attrs 测试 from booktest.serializers import BookInfoSerializer data = {'btitle': 'about django','bread': 10,'bcomment': 20} s = BookInfoSerializer(data=data) s.is_valid() # False s.errors # {'non_field_errors': [ErrorDetail(string='阅读量小于评论量',code='invalid')]} 3) validators在字段中添加validators选项参数,也可以补充验证行为,如 def about_django(value): if 'django' not in value.lower(): raise serializers.ValidationError("图书不是关于Django的") class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" id = serializers.IntegerField(label='ID',max_length=20,validators=[about_django]) bpub_date = serializers.DateField(label='发布日期',required=False) 测试: from booktest.serializers import BookInfoSerializer data = {'btitle': 'python'} serializer = BookInfoSerializer(data=data) serializer.is_valid() # False serializer.errors # {'btitle': [ErrorDetail(string='图书不是关于Django的',code='invalid')]} 反序列化-保存数据前面的验证数据成功后,我们可以使用序列化器来完成数据反序列化的过程.这个过程可以把数据转成模型类对象. 可以通过实现create()和update()两个方法来实现。 class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" ... def create(self,validated_data): """新建""" return BookInfo(**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) return instance 如果需要在返回数据对象的时候,也将数据保存到数据库中,则可以进行如下修改 class BookInfoSerializer(serializers.Serializer): """图书数据序列化器""" ... def create(self,validated_data): """新建""" return BookInfo.objects.create(**validated_data) def update(self,instance.bcomment) instance.save() return instance 实现了上述两个方法后,在反序列化数据的时候,就可以通过save()方法返回一个数据对象实例了 book = serializer.save() 如果创建序列化器对象的时候,没有传递instance实例,则调用save()方法的时候,create()被调用,相反,如果传递了instance实例,则调用save()方法的时候,update()被调用。 from db.serializers import BookInfoSerializer data = {'btitle': '封神演义'} serializer = BookInfoSerializer(data=data) serializer.is_valid() # True serializer.save() # <BookInfo: 封神演义> from db.models import BookInfo book = BookInfo.objects.get(id=2) data = {'btitle': '倚天剑'} serializer = BookInfoSerializer(book,data=data) serializer.is_valid() # True serializer.save() # <BookInfo: 倚天剑> book.btitle # '倚天剑' 附加说明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) 模型类序列化器如果我们想要使用序列化器对应的是Django的模型类,DRF为我们提供了ModelSerializer模型类序列化器来帮助我们快速创建一个Serializer类。 ModelSerializer与常规的Serializer相同,但提供了:
定义比如我们创建一个BookInfoSerializer class BookInfoSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = BookInfo fields = '__all__'
我们可以在python manage.py shell中查看自动生成的BookInfoSerializer的具体实现 >>> from booktest.serializers import BookInfoSerializer >>> serializer = BookInfoSerializer() >>> serializer BookInfoSerializer(): id = IntegerField(label='ID',read_only=True) btitle = CharField(label='名称',max_length=20) bpub_date = DateField(allow_null=True,label='发布日期',required=False) bread = IntegerField(label='阅读量',max_value=2147483647,min_value=-2147483648,required=False) bcomment = IntegerField(label='评论量',required=False) image = ImageField(allow_null=True,label='图片',max_length=100,required=False) 指定字段1) 使用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','bpub_date', 'bread','bcomment') read_only_fields = ('id','bread','bcomment') 添加额外参数我们可以使用extra_kwargs参数为ModelSerializer添加或修改原有的选项参数 class BookInfoSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = BookInfo fields = ('id','bpub_date','bcomment') extra_kwargs = { 'bread': {'min_value': 0,'required': True},'bcomment': {'min_value': 0,} # BookInfoSerializer(): # id = IntegerField(label='ID',read_only=True) # btitle = CharField(label='名称',max_length=20) # bpub_date = DateField(allow_null=True,required=False) # bread = IntegerField(label='阅读量',min_value=0,required=True) # bcomment = IntegerField(label='评论量',required=True) (编辑:李大同) 【声明】本站内容均来自网络,其相关言论仅代表作者个人观点,不代表本站立场。若无意侵犯到您的权利,请及时与联系站长删除相关内容! |