雪泥鴻爪

dog2's blog

Django REST Framework 学习笔记（七）：序列化模块 serialziers 之 Serialzier类

Posted on In Disqus:
Symbols count in article: 6.9k Reading time ≈ 6 mins.
  • Title(EN): Django REST Framework Learning Notes (7): the Serialzier class in serialziers module
  • Author: dog2

基本信息

  • 源码：rest_framework.response
  • 官方文档
    • API Guide - Serializers
    • API Guide - Serializer fields
    • API Guide - Serializer relations
  • 本文demo代码Github

DRF常用序列化类主要有

  • rest_framework.serialziers.Serializer
  • rest_framework.serialziers.ModelSerializer
  • rest_framework.serialziers.ListSerializer

本篇介绍rest_framework.serialziers.Serializer

源码分析

根据基类rest_framework.serialziers.BaseSerializer构造函数

1
def __init__(self, instance=None, data=empty, **kwargs):

定义好Serialzier类后，就可以创建Serializer对象了。Serializer的构造方法为

1
Serializer(instance=None,data=empty,**kwargs)
  1. 用于序列化时，将模型类对象传入instance参数
  2. 用于反序列化时，将要被反序列化的数据传入data参数
  3. 除了instance和data参数外，在构造Serializer对象时，还可以通过context参数额外添加数据。通过context参数附加的数据，可以通过Serializer对象的context属性获取。 
    1
    serializer = AccountSerializer(account, context={'request':request})

用法

序列化器的使用分两个阶段：

  1. 在客户端请求时，使用序列化器可以完成对数据的反序列化（就是前段往后端传递数据，反序列化之后保存数据）

  2. 在服务器响应时，使用序列化器可以完成对数据的序列化（服务器取出数据，序列化之后往前段发送展示）

序列化

序列化是将数据返回给前台。DRF的序列化使用流程如下：

  1. 查询出一个用户对象
1
2
from models import user
user = User.object.get(id=2)
  1. 构造序列化器对象
1
2
from user.serializers import UserSerializer
user_obj = Userserializer(user)  #放入查询出的user对象
  1. 获取序列化对象，通过data属性可以获取序列化后的数据

上面查出来的user_ser是一个serializer对象，需要取出具体的数据传给前端，所有要用到 user_ser.data取出具体数据

1
user_ser = Userserializer(user).data
  1. 如果要被序列化的数据是包含多条数据的（也可以说被[ ]嵌套的，queryset类型数据，不管是多条还是单条）,需要添加many=True参数
1
2
user = models.User.objects.all()
user_ser =  Userserialzier(user,many=True)
  1. 自定义序列化属性
1
serializers.SerializerMethodField()

反序列化使用流程

反序列化是将前天传来的数据数据存入数据库。DRF的反序列化使用流程如下：

数据验证

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

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

  3. 验证失败，可以通过序列化对象的errors属性获取错误信息，返回字典，包含了字段和字段的错误。

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

保存数据

序列化类中必须重写create方法用于新增，重写update方法用于修改。视图中使用create和save方法。

从源码可知save方法内部调用的是序列化类中的create方法，所以新增必须要在序列化类中重写create方法。

1
2


用法示例

序列化

模型层 models.py

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
class User(models.Model):
    SEX_CHOICES = [
        [0,'男'],
        [1,'女'],
    ]

    name = models.CharField(max_length=64)
    pwd = models.CharField(max_length=32)
    phone = models.CharField(max_length=11,null=True,default=None)
    sex = models.IntegerField(choices=SEX_CHOICES,default=0)
    icon = models.ImageField(upload_to='icon',default='icon/default.jpg')

    class Meta:
        db_table='old_boy_user'
        verbose_name='用户'
        verbose_name_plural=verbose_name

    def __str__(self):
        return '%s' %self.name

配置层 settings.py

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
# 注册rest_framework
INSTALLED_APPS = [
    # ...
    'rest_framework',
]

# media资源
MEDIA_URL = '/media/'  # 后期高级序列化类与视图类，会使用该配置
MEDIA_ROOT = os.path.join(BASE_DIR, 'media')  # media资源路径

# 国际化配置
LANGUAGE_CODE = 'zh-hans'
TIME_ZONE = 'Asia/Shanghai'
USE_I18N = True
USE_L10N = True
USE_TZ = False

序列化层 api/serializers.py

  1. api应用下创建serializers.py文件
  2. 设置需要返回给前台数据样式 那些model类有对应的字段，不需要返回的就不用设置了
  3. 设置方法字段，字段名可以随意，字段值由 get_字段名 提供，来完成一些需要处理在返回的数据，类似于forms组件
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
from rest_framework import serializers, exceptions
from django.conf import settings
from . import models

class UserSerializer(serializers.Serializer):   #创建一个序列化类
    name = serializers.CharField()      
    phone = serializers.CharField()
    # 序列化提供给前台的字段个数由后台决定，可以少提供，但是提供的数据库对应的字段，名字一定要与数据库字段相同
    # sex = serializers.IntegerField()
    # icon = serializers.ImageField()

    # 自定义序列化属性
    # 属性名随意，值由固定的命名规范方法提供:
    #       get_属性名(self, 参与序列化的model对象)
    #       返回值就是自定义序列化属性的值
    gender = serializers.SerializerMethodField()
    def get_gender(self, obj):
        # choice类型的解释型值 get_字段_display() 来访问
        return obj.get_sex_display()

　　 #自定义序列化属性icon
    icon = serializers.SerializerMethodField()
    def get_icon(self, obj):
        # settings.MEDIA_URL: 自己配置的 /media/，给后面高级序列化与视图类准备的
        # obj.icon不能直接作为数据返回，因为内容虽然是字符串，但是类型是ImageFieldFile类型
        return '%s%s%s' % (r'http://127.0.0.1:8000', settings.MEDIA_URL, str(obj.icon))

视图层 views.py

  1. 从数据库中将要序列化给前台的model对象，或是多个model对象查询出来
1
user_obj = models.User.objects.get(pk=pk)

或者

1
user_obj_list = models.User.objects.all()
  1. 序列化: 对象.data 就是可以返回给前台的序列化数据
1
2
3
4
5
return Response({
    'status': 0,
    'msg': 0,
    'results': user_ser.data
})

完整代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class User(APIView):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get('pk')
        if pk:  #单查
            try:
                # 用户对象不能直接作为数据返回给前台
                user_obj = models.User.objects.get(pk=pk)
                # 序列化一下用户对象
                user_ser = serializers.UserSerializer(user_obj)
                return Response({
                    'status': 0,
                    'msg': 0,
                    'results': user_ser.data   #如果你在序列化的时候没有.data,那么在传给前端的时候必须要.data
                })
            except:
                return Response({
                    'status': 2,
                    'msg': '用户不存在',
                })
        else:  #群查
            # 用户对象列表(queryset)不能直接作为数据返回给前台
            user_obj_list = models.User.objects.all()
            # 序列化一下用户对象
            user_ser_data = serializers.UserSerializer(user_obj_list, many=True).data
            return Response({
                'status': 0,
                'msg': 0,
                'results': user_ser_data
            })

反序列化

反序列层 api/serializers.py

  1. 设置必填与选填序列化字段，设置校验规则
  2. 为需要额外校验的字段提供局部钩子函数，如果该字段不入库，且不参与全局钩子校验，可以将值取出校验 pop
  3. 为有联合关系的字段们提供全局钩子函数，如果某些字段不入库，可以将值取出校验
  4. 必须重写create方法，完成校验通过的数据入库工作，得到新增的对象

完整代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
class UserDeserializer(serializers.Serializer):
    # 1) 哪些字段必须反序列化
    # 2) 字段都有哪些安全校验
    # 3) 哪些字段需要额外提供校验  钩子函数
    # 4) 哪些字段间存在联合校验
    # 注：反序列化字段都是用来入库的，不会出现自定义方法属性，会出现可以设置校验规则的自定义属性,不入数据库的
    name = serializers.CharField(
        max_length=64,
        min_length=3,
        error_messages={
            'max_length': '太长',
            'min_length': '太短'
        }
    )
    pwd = serializers.CharField()
    phone = serializers.CharField(required=False)
    sex = serializers.IntegerField(required=False)

    # 自定义有校验规则的反序列化字段,例如确认密码字段re_pwd
    re_pwd = serializers.CharField(required=True)

    # 小结：
    # name，pwd，re_pwd为必填字段
    # phone，sex为选填字段
    # 五个字段都必须提供完成的校验规则


    # 局部钩子：validate_要校验的字段名(self, 当前要校验字段的值)
    # 校验规则：校验通过返回原值，校验失败，抛出异常
    def validate_name(self, value):
        if 'g' in value.lower():  # 名字中不能出现g
            raise exceptions.ValidationError('名字非法，是个鸡贼！')
        return value

    # 全局钩子：validate(self, 通过系统与局部钩子校验之后的所有数据)
    # 校验规则：校验通过返回原值，校验失败，抛出异常
    def validate(self, attrs):    #attrs是字典格式
        pwd = attrs.get('pwd')
        re_pwd = attrs.pop('re_pwd')     #因为re_pwd不需要入数据库，所以在全局钩子校验中删除掉这个字段
        if pwd != re_pwd:
            raise exceptions.ValidationError({'pwd&re_pwd': '两次密码不一致'})
        return attrs

    # 要完成新增，必须自己重写 create 方法，validated_data是校验的数据
    def create(self, validated_data):
        # 尽量在所有校验规则完毕之后，数据可以直接入库
        return models.User.objects.create(**validated_data)

视图层 views.py

  1. 反序列化数据必须赋值data，结果就是得到一个serializer对象
1
book_ser = serializers.UserDeserializer(data=request_data)
  1. 把数据放到自定义serializer中校验，数据校验成功返回True,失败返回False
1
book_ser.is_valid()
  1. 不通过返回 book_ser.errors 给前台，通过 book_ser.save() 得到新增的对象，再正常返回

完整代码：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
class User(APIView):
    # 只考虑单增
    def post(self, request, *args, **kwargs):
        # 请求数据
        request_data = request.data
        # 数据是否合法（增加对象需要一个字典数据）
        if not isinstance(request_data, dict) or request_data == {}:
            return Response({
                'status': 1,
                'msg': '数据有误',
            })
        # 数据类型合法，但数据内容不一定合法，需要校验数据，校验(参与反序列化)的数据需要赋值给data
        book_ser = serializers.UserDeserializer(data=request_data)

        # 序列化对象调用is_valid()完成校验，校验失败的失败信息都会被存储在 序列化对象.errors
        if book_ser.is_valid():
            # 校验通过，完成新增
            book_obj = book_ser.save()
            return Response({
                'status': 0,
                'msg': 'ok',
                'results': serializers.UserSerializer(book_obj).data
            })
        else:
            # 校验失败
            return Response({
                'status': 1,
                'msg': book_ser.errors,
            })

总结

  1. 使用序列化器的时候一定要注意，序列化器声明了以后，不会自动执行，需要我们在视图中进行调用才可以
  2. 序列化器无法直接接收数据，需要我们在视图中创建序列化器对象时把使用的数据传递过来。（data, instance传参）
    • 序列化：是数据对象从数据库中查出，通过instance传入序列化器中，必须通过data属性才能将序列化后的数据传给前端，不能直接传序列化对象
    • 反序列化：是数据是通过request.data从前端获取到数据，通过data传入序列化器中进行校验，保存到数据库中
  3. 序列化器的字段声明类似于我们前面使用过的表单系统
  4. 开发restful api时，序列化器会帮我们把模型数据转换成字典
  5. drf提供的视图会帮我们把字典转换成json，或者把客户端发过来的数据转换成字典