A股上市公司传智教育(股票代码 003032)旗下技术交流社区北京昌平校区

 找回密码
 加入黑马

QQ登录

只需一步,快速开始

© chengdupython1 初级黑马   /  2019-6-20 16:14  /  925 人查看  /  0 人回复  /   0 人收藏 转载请遵从CC协议 禁止商业使用本文

序列化器作用:
1.进行数据的校验
2.对数据对象进行转换

序列化:  模型类对象  ----->  python字典    用于输出, 返回给前端使用
反序列化:  前端传送的数据  -------> 经过验证 -----> python的字典   用于输入  接受前端数据时使用
序列化器作用: 帮助我们进行序列化, 反序列化
总结 :
在开发REST API接口时,我们在视图中需要做的最核心的事是:
将数据库数据序列化为前端所需要的格式,并返回;
将前端发送的数据反序列化为模型类对象,并保存到数据库中。

在开发REST API的视图中,虽然每个视图具体操作的数据不同,但增、删、改、查的实现流程基本套路化,所以这部分代码也是可以复用简化编写的:
增:校验请求数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
删:判断要删除的数据是否存在 -> 执行数据库删除
改:判断要修改的数据是否存在 -> 校验请求的数据 -> 执行反序列化过程 -> 保存数据库 -> 将保存的对象序列化并返回
查:查询数据库 -> 将数据序列化并返回

1.序列化的定义
根据模型类定义序列化器
示例:
<wiz_code_mirror>







模型类
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)


<wiz_code_mirror>







class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    id = serializers.IntegerField(label='ID', read_only=True) # read_only只在序列化中使用, 反序列化不使用
    # write_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)



序列化:  模型类对象  ----->  python字典    用于输出, 返回给前端使用
反序列化:  前端传送的数据  -------> 经过验证 ----->save python的字典   用于输入  接受前端数据时使用
序列化器作用: 帮助我们进行序列化, 反序列化
注意: serializer不是只能为数据库模型类定义,也可以为非数据库模型类的数据定义

2. 创建serializer对象
定义好Serializer类后,就可以创建Serializer对象了。
Serializer的构造方法为:
<wiz_code_mirror>







Serializer(instance=None, data=empty, **kwarg)


说明:
1)用于序列化时,将模型类对象传入instance参数
2)用于反序列化时,获取数据前进行验证 (  is_valid()   ),  将要被反序列化的数据传入data参数
3)除了instance和data参数外,在构造Serializer对象时,还可通过context参数额外添加数据,如
<wiz_code_mirror>







serializer = AccountSerializer(account, context={'request': request})


通过context参数附加的数据,可以通过Serializer对象的context属性获取。

3. 序列化的使用
1. 基本使用
1) 先查询出一个图书对象

<wiz_code_mirror>







from booktest.models import BookInfo
book = BookInfo.objects.get(id=2)


2) 构造序列化器对象

<wiz_code_mirror>







from booktest.serializers import BookInfoSerializer
serializer = BookInfoSerializer(book)


3)获取序列化数据
通过data属性可以获取序列化后的数据

<wiz_code_mirror>







serializer.data
# {'id': 2, 'btitle': '天龙八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40, 'image': None}



4)如果要被序列化的是包含多条数据的查询集QuerySet,可以通过添加many=True参数补充说明

<wiz_code_mirror>







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), ('btitle', '笑傲江湖'), ('bpub_date', '1995-12-24'), ('bread', 20), ('bcomment', 80), ('image'ne)]), OrderedDict([('id', 4), ('btitle', '雪山飞狐'), ('bpub_date', '1987-11-11'), ('bread', 58), ('bcomment', 24), ('ima None)]), OrderedDict([('id', 5), ('btitle', '西游记'), ('bpub_date', '1988-01-01'), ('bread', 10), ('bcomment', 10), ('im', 'booktest/xiyouji.png')])]


2. 关联对象
1) PrimaryKeyRelatedField
此字段将被序列化为关联对象的主键。


<wiz_code_mirror>







hbook = serializers.PrimaryKeyRelatedField(label='图书', read_only=True)

hbook = serializers.PrimaryKeyRelatedField(label='图书', queryset=BookInfo.objects.all())


指明字段时需要包含read_only=True或者queryset参数:

包含read_only=True参数时,该字段将不能用作反序列化使用
包含queryset参数时,将被用作反序列化时参数校验使用查询


4. 反序列化的使用
1. 验证
在获取反序列化的数据前,必须调用is_valid()方法进行验证,验证成功返回True,否则返回False。

验证失败,可以通过序列化器对象的errors属性获取错误信息,返回字典,包含了字段和字段的错误。如果是非字段错误,可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。

验证成功,可以通过序列化器对象的validated_data属性获取数据。

如我们前面定义过的BookInfoSerializer

<wiz_code_mirror>







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构造参数,进而进行验证

<wiz_code_mirror>







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响应。

<wiz_code_mirror>







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



其余方法看课件总结

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


<wiz_code_mirror>







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



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


<wiz_code_mirror>







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()方法返回一个数据对象实例了

<wiz_code_mirror>







book = serializer.save()


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


<wiz_code_mirror>







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参数获取到

<wiz_code_mirror>







serializer.save(owner=request.user)


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


<wiz_code_mirror>







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



5. 模型类serializers
ModelSerializer与常规的Serializer相同,但提供了:
基于模型类自动生成一系列字段      #  自动生成字段
基于模型类自动为Serializer生成validators,比如unique_together         # 唯一约束
包含默认的create()和update()的实现             #  默认的两种方法

1. 定义
demo

<wiz_code_mirror>







class BookInfoSerializer(serializers.ModelSerializer):
    """图书数据序列化器"""
    class Meta:   # Meta是一个内部类,它用于定义一些Django模型类的行为特性
        model = BookInfo
        fields = '__all__'


model 指明参照哪个模型类
fields 指明为模型类的哪些字段生成

2. 指定字段
1) 使用fields来明确字段,__all__表名包含所有字段,也可以写明具体哪些字段,如


<wiz_code_mirror>







class BookInfoSerializer(serializers.ModelSerializer):
    """图书数据序列化器"""
    class Meta:
        model = BookInfo
        fields = ('id', 'btitle', 'bpub_date')


2) 使用exclude可以明确排除掉哪些字段

<wiz_code_mirror>







class BookInfoSerializer(serializers.ModelSerializer):
    """图书数据序列化器"""
    class Meta:
        model = BookInfo
        exclude = ('image',)


3) 默认ModelSerializer使用主键作为关联字段,但是我们可以使用depth来简单的生成嵌套表示,depth应该是整数,表明嵌套的层级数量。如:

<wiz_code_mirror>







class HeroInfoSerializer2(serializers.ModelSerializer):
    class Meta:
        model = HeroInfo
        fields = '__all__'
        depth = 1


形成的序列化器如下:

<wiz_code_mirror>







HeroInfoSerializer():
    id = IntegerField(label='ID', read_only=True)
    hname = CharField(label='名称', max_length=20)
    hgender = ChoiceField(choices=((0, 'male'), (1, 'female')), label='性别', required=False, validators=[<django.core.valators.MinValueValidator object>, <django.core.validators.MaxValueValidator object>])
    hcomment = CharField(allow_null=True, label='描述信息', max_length=200, required=False)
    hbook = NestedSerializer(read_only=True):
        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='评论量', max_value=2147483647, min_value=-2147483648, required=False)
        image = ImageField(allow_null=True, label='图片', max_length=100, required=False)


4) 显示指明字段,如:

<wiz_code_mirror>







class HeroInfoSerializer(serializers.ModelSerializer):
    hbook = BookInfoSerializer()
    class Meta:
        model = HeroInfo
        fields = ('id', 'hname', 'hgender', 'hcomment', 'hbook')

0 个回复

您需要登录后才可以回帖 登录 | 加入黑马