drf 序列化类总结

serializer 序列化器

序列化：前端到后端，前端发送的数据比如说 json 数据，后端转换成 python 数据类型，才能进行进一步操作；

反序列化：后端到前端，后端要传给前端的 python 数据要转换成 json 数据，在进行传送，这样前端才能对数据进行识别和操作

前端和后端数据的互相传输都可能出现问题，所有对每个数据都有进行验证，如果向 Flask 中那样自己写验证，会显得很麻烦，所以 Django 中就会有了序列化器，将数据转换和校验一并完成。

定义 serializer

定义方法

DRF 中的 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)

• 1
• 2
• 3
• 4
• 5
• 6

我们想为这个模型类提供一个序列化器，可以定义如下：

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)

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8

在这里感觉序列化器好麻烦，一样的字段要写两遍，很浪费。

不过在项目中就可以体会到序列化器的好处。

字段与选项

常用字段类型：

选项参数：**

通用参数：

创建 serializer 对象

定义好Serializer类后，就可以创建Serializer对象了。

Serializer的构造方法为：

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

• 1

说明：

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

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

• 除了 instance 和 data 参数外，在构造 Serializer 对象时，还可通过 context 参数额外添加数据，如

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

  • 1

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

序列化使用

在 django shell 中来学习序列化器的使用。

python manage.py shell

• 1

基本使用

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

from booktest.models import BookInfo

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

• 1
• 2
• 3

2） 构造序列化器对象

from booktest.serializers import BookInfoSerializer

serializer = BookInfoSerializer(book)

• 1
• 2
• 3

3）获取序列化数据

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

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

• 1
• 2

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

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

• 1
• 2
• 3

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

PrimaryKeyRelatedField

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

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

• 1
• 2
• 3

指明字段时需要包含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}

• 1
• 2
• 3
• 4
• 5
• 6

StringRelatedField

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

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

• 1

HyperlinkedRelatedField

此字段将被序列化为获取关联对象数据的接口链接

hbook = serializers.HyperlinkedRelatedField(label='图书', read_only=True, view_name='books-detail')

• 1

必须指明view_name参数，以便DRF根据视图名称寻找路由，进而拼接成完整URL。

SlugRelatedField

此字段将被序列化为关联对象的指定字段数据

hbook = serializers.SlugRelatedField(label='图书', read_only=True, slug_field='bpub_date')

• 1

slug_field指明使用关联对象的哪个字段

使用关联对象的序列化器

这个后面使用比较多

hbook = BookInfoSerializer()

• 1

重写to_representation方法

序列化器的每个字段实际都是由该字段类型的to_representation方法决定格式的，可以通过重写该方法来决定格式。

注意，to_representations方法不仅局限在控制关联对象格式上，适用于各个序列化器字段类型。

自定义一个新的关联字段：

class BookRelateField(serializers.RelatedField):
    """自定义用于处理图书的字段"""
    def to_representation(self, value):
        return 'Book: %d %s' % (value.id, value.btitle)

• 1
• 2
• 3
• 4

指明hbook为BookRelateField类型

hbook = BookRelateField(read_only=True)

• 1

many 参数

如果关联的对象数据不是只有一个，而是包含多个数据，此时关联字段类型的指明仍可使用上述 几种方式，只是在声明关联字段时，多补充一个 many=True 参数即可

反序列化使用

验证

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

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

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

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

在定义序列号器时，指明每个字段的序列化类型和选项参数，本身就是一种验证行为。

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

自定义验证行为，可以使用一下三个方法

验证单个字段 validate_<field_name>

可以对指定的 <field_name> 字段进行单独验证

验证多个字段 validate

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

在字段中补充验证行为 validators

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

btitle = serializers.CharField(label='名称', max_length=20, validators=[about_django])

• 1

REST framework提供的validators:

• UniqueValidator 单字段唯一
• UniqueTogetherValidation 联合唯一

保存

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

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

book = serializer.save()

• 1

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

两点说明

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

   serializer.save(owner=request.user)
   

   • 1

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

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

   • 1
   • 2

模型类序列化器 ModelSerializer

如果我们想要使用序列化器对应的是 Django 的模型类，DRF 为我们提供了 ModelSerializer 模型类序列化器来帮助我们快速创建一个 Serailizer 类。

ModelSerializer 与常规的 Serializer 相同，但提供了：

• 基于 模型类自动生成一系列字段
• 基于模型类自动为 Serializer 生成 validators
• 包含默认的 create() 和 update() 的实现

定义

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

指定字段

• 使用 fields 来明确字段，__all__ 表名包含所有字段，也可以写明具体哪些字段
• 使用 exclude 可以明确排除掉哪些字段
• 默认 ModelSerializer 使用主键作为关联字段，但是我们可以使用 depth 来简单的生成嵌套表示，depth 应该是整数，表名嵌套的层级数量
  • depth 的作用：会自己去通过主键找下一级的关联字段，可以指定向下找的层级
• 可以通过 read_only_fields 指明只读字段，即仅用于序列化输出的字段

添加额外参数

我们可以使用 extra_kwargs 参数为 ModelSerializer 添加或修改原有的选项参数

 extra_kwargs = {
            'bread': {'min_value': 0, 'required': True}},
            'bcomment': {'max_value': 0, 'required': True}},
        }