Serializer序列化器的定义与使用

序列化器的作用：

对数据进行校验
对数据对象进行转换（数据模型类和dict等数据间的转换）

定义方法

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(instance=None, data=empty, **kwarg)

1）用于序列化时，将模型类对象传入instance参数

2）用于反序列化时，将要被反序列化的数据传入data参数

3 ) 同时传入instance参数和data参数，使用传入的data数据对模型类对象实例进行修改

一：序列化

1：基本使用

还是以上面的图书模型类数据为例

可在django shell中来简单的使用序列化器来测试效果(注意修改数据模型类或序列化器等文件后要重启shell)

python manager.py shell

1）先查询出一个图书对象

from booktest.models import BookInfo

book = BookInfo.objects.get(id=1)

2）构造序列化器对象

from booktest.serializers import BookInfoSerializer

serializer = BookInfoSerializer(book)

3）获取序列化数据

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

serializer.data

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

book_qs = BookInfo.objects.all()
serializer = BookInfoSerializer(book_qs, many=True)
serializer.data

测试代码：

>>> from booktest.models import BookInfo
>>> from booktest.serializers import BookInfoSerializer
>>> book = BookInfo.objects.get(id=1)
>>> serializer = BookInfoSerializer(instance=book)
>>> serializer.data
{'btitle': '射雕英雄传', 'id': 1, 'bpub_date': '1980-05-01', 'bread': 12, 'bcomment': 34}
>>>

2.关联对象嵌套序列化

如果需要序列化的数据中包含有其他关联对象，则对关联对象数据的序列化需要指明。

例如，在定义英雄数据的序列化器时，外键hbook（即所属的图书）字段如何序列化？

我们先定义HeroInfoSerialzier除外键字段外的其他部分

class HeroInfoSerializer(serializers.Serializer):
    """英雄数据序列化器"""
    GENDER_CHOICES = (
        (0, 'male'),
        (1, 'female')
    )
    id = serializers.IntegerField(label='ID', read_only=True)
    hname = serializers.CharField(label='名字', max_length=20)
    hgender = serializers.ChoiceField(choices=GENDER_CHOICES, label='性别', required=False)
    hcomment = serializers.CharField(label='描述信息', max_length=200, required=False, allow_null=True)

对于关联字段，可以采用以下几种方式：

1） PrimaryKeyRelatedField ：此字段将被序列化为关联对象的主键。

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

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

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

使用效果：

from booktest.serializers import HeroInfoSerializer
from booktest.models import HeroInfo
hero = HeroInfo.objects.get(id=6)
serializer = HeroInfoSerializer(hero)
serializer.data
# {'id': 6, 'hname': '乔峰', 'hgender': 1, 'hcomment': '降龙十八掌', 'hbook': 2}

2) StringRelatedField

此字段将被序列化为关联对象的字符串表示方式（即__str__方法的返回值）

hbook = serializers.StringRelatedField(label='图书')

3）使用关联对象的序列化器

hbook = BookInfoSerializer()

3. many参数

如果关联的对象数据不是只有一个，而是包含多个数据，如想序列化图书BookInfo数据，每个BookInfo对象关联的英雄HeroInfo对象可能有多个，此时关联字段类型的指明仍可使用上述几种方式，只是在声明关联字段时，多补充一个many=True参数即可。

此处仅拿PrimaryKeyRelatedField类型来举例，其他相同。

在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)
    heroinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)  # 新增
使用效果：

使用效果：

from booktest.serializers import BookInfoSerializer
from booktest.models import BookInfo
book = BookInfo.objects.get(id=2)
serializer = BookInfoSerializer(book)
serializer.data
# {'id': 2, 'btitle': '天龙八部', 'bpub_date': '1986-07-24', 'bread': 36, 'bcomment': 40, 'image': None, 'heroinfo_set': [6,8, 9]}

二：反序列化

1.验证

使用序列化器进行反序列化时，需要对数据进行验证后，才能获取验证成功的数据或保存成模型类对象。

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

验证的方式：
0.类型+选项：----------------------------------------及定义序列化器时，序列化器字段本身类型和选项提供的验证
1.validate_属性名称(self,value)：---------------验证指定的属性值是否合法

# 对某个属性字段进行补充验证
    def validate_btitle(self, value):
        if 'django' not in value.lower():
            raise serializers.ValidationError('图书不是关于django的')
        return value

2.validate(self,values)：---------------------------验证多个属性

# 多个字段之间的比较验证
    def validate(self, attrs):
        bread = attrs.get('bread')
        bcomment = attrs.get('bcomment')
        if all ([bread, bcomment]):
            if bread < bcomment:
                raise serializers.ValidationError('阅读量不能小于评论量')
        return attrs

3.validators=[方法]：--------------------------------针对属性进行验证（在序列化器外部定义好一个函数，加载到序列化器的字段上）


# 对某个字段的选项进行验证
def pub_date(value):
    if value < date(2010, 1, 1):
        raise serializers.ValidationError('日期必须实在2010-1-1日之后')
    return value


class BookInfoSerializer(serializers.Serializer):
    ...
    bpub_date = serializers.DateField(label='发布日期', validators=[pub_date])
    ...

2.调用

serialiazer=模型类Serializer(data=字典)
serializer.is_valid()-----------进行验证，如果成功则返回True，失败则返回False
serialiser.error-----------------错误信息，类型为字典

3.保存

1.定义序列化器，增加create()、update()方法
2.调用：serializer.save()

PS：如果是创建：序列化器类(data=***)===>serializer.save()===>调用create()
如果是修改：序列化器类(模型类对象,data=***)===>serializer.save()=====>调用update()
如果是部分修改：序列化器类(模型类对象,data=***,partial=True)===>serializer.save()====>调用update()
跳过了必填的检查