11 Serializer组件

知识点：Serializer(偏底层)、ModelSerializer(重点)、ListModelSerializer(辅助群改)

为什么要使用序列化组件？
视图中查询到的对象和queryset类型不能直接作为数据返回给前台，所以要使用序列化组件

1. 定义Serializer

路由层 urls.py

<code class="language-python">from django.urls import <a href="https://www.gaodaima.com/tag/path" title="查看更多关于path的文章" target="_blank">path</a>, re_path
from .views import users

urlpatterns = [
    path("bookinfo/", users.BookInfo.as_view()),
    re_path("bookinfo/(?P<pk>.*)/$", users.BookInfo.as_view()),
]
</code>

www#gaodaima.com来源gaodai#ma#com搞@@代~&码网搞代码

模型层：models.py

1.1 定义方法

<code class="language-python">class BookInfo(models.Model):
    PUB_CHOICES = [
        (0, "商务印书馆"),
        (1, "人民出版社"),
        (2, "人民文学出版社 "),
        (3, "作家出版社")
    ]
    pwd = models.CharField(max_length=32, verbose_name="密码")
    publisher = models.IntegerField(choices=PUB_CHOICES, default=0, verbose_name="出版社")
    btitle = models.CharField(max_length=20, verbose_name="名称")
    bpub_date = models.DateField(verbose_name="发布日期", null=True)
    created_time = models.DateTimeField(auto_now_add=True, verbose_name="创建时间", help_text="创建时间")
    bread = models.IntegerField(default=0, verbose_name="阅读量")
    bcomment = models.IntegerField(default=0, verbose_name="评论量")
    image = models.ImageField(upload_to="icon", verbose_name="图片", default="icon/default.jpg")

    class Meta:
        db_table = "BookInfo"
        verbose_name = "书籍信息"
        verbose_name_plural = verbose_name

    def __str__(self):
        return "%s" % self.btitle
</code>

为这个模型类提供一个序列化器

<code class="language-python">from rest_framework import <a href="https://www.gaodaima.com/tag/serializer" title="查看更多关于serializer的文章" target="_blank">serializer</a>s

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    id = serializers.IntegerField(label="ID", read_only=True)
    pwd = serializers.CharField(label="密码", required=True)
    publisher = serializers.IntegerField(label="出版社")
    btitle = serializers.CharField(label="名称", max_length=20)
    bpub_date = serializers.DateField(label="发布日期", required=False)
    created_time = serializers.DateTimeField(label="创建时间", required=False)
    bread = serializers.IntegerField(label="阅读量", required=False)
    bcomment = serializers.IntegerField(label="评论量", required=False)
    image = serializers.ImageField(label="图片", required=False)
    """
    自定义序列化属性
    格式：  属性名随意，值由固定的命名规范方法提供
    def get_属性名(self, 参与序列化的model对象):
        返回值就是自定义序列化属性的值
    """
    # 出版社显示名称，而不是0，1。。。
    publisher_name = serializers.SerializerMethodField()

    def get_publisher_name(self, obj):
        # choice类型的解释型值 get_字段_display() 来访问
        return obj.get_publisher_display()

    # 图片显示全路径
    image_path = serializers.SerializerMethodField()

    def get_image_path(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.image))

    # 自定义虚拟阅读量，原基础增加10
    fictitious_bread = serializers.SerializerMethodField()

    def get_fictitious_bread(self, obj):
        return obj.bread + 10
</code>

注意：serializer不是只能为数据库模型类定义，也可以为非数据库模型类的数据定义。serializer是独立于数据库之外的存在。

1.2 字段与选项

常用字段类型：

选项参数：

通用参数：

1.3 创建Serializer对象

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

Serializer的构造方法为：

<code class="language-python">Serializer(instance=None, data=empty, **kwarg)
</code>

说明：

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

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

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

<code class="language-python">serializer = AccountSerializer(account, context={"request": request})
</code>

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

1. 使用序列化器的时候一定要注意，序列化器声明了以后，不会自动执行，需要我们在视图中进行调用才可以

2. 序列化器无法直接接收数据，需要我们在视图中创建序列化器对象时把使用的数据传递过来。（data,instance传参）

   ​ 序列化是：数据对象从数据库中查出，通过instance传入序列化器中，必须通过data属性才能将序列化后的数据传给前端，不能直接传序列化对象
   ​ 反序列化是：数据是通过request.data从前端获取到数据，通过data传入序列化器中进行校验，保存到数据库中

3. 序列化器的字段声明类似于我们前面使用过的表单系统

4. 开发restful api时，序列化器会帮我们把模型数据转换成字典。

5. drf提供的视图会帮我们把字典转换成json，或者把客户端发过来的数据转换成字典

2. 序列化器的使用

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

1. 在客户端请求时，使用序列化器可以完成对数据的反序列化。
2. 在服务器响应时，使用序列化器可以完成对数据的序列化。

<code class="language-python">from .. import models
from ..serializers import BookInfoSerializer


class BookInfo(APIView):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get("pk")
        if pk:
            try:
                # 1) 查询出图书对象
                book_obj = models.BookInfo.objects.get(pk=pk)
                # 2) 构造序列化器
                book_ser = BookInfoSerializer(book_obj)
                # 3) 获取序列化数据
                return Response({
                    "status": 200,
                    "msg": 0,
                    # 在序列化的时候没有.data,那么在传给前端的时候必须要.data
                    "results": book_ser.data  # 通过data属性可以获取序列化后的数据
                })
            except:
                return Response({
                    "status": 201,
                    "msg": "书籍信息不存在",
                })
        else:
            # 1) 查询出图书对象：对象列表(queryset)不能直接作为数据返回给前台
            book_obj_list = models.BookInfo.objects.all()
            # 2) 构造序列化器   PS:将对象交给序列化处理，产生序列化对象，如果序列化的数据是由[]嵌套，一定要设置many=True
            book_ser_data = BookInfoSerializer(book_obj_list, many=True)
            # 3) 获取序列化数据
            return Response({
                "status": 200,
                "msg": 0,
                "results": book_ser_data.data  # 通过data属性可以获取序列化后的数据
            })
</code>

3. 反序列化使用

3.1 验证

• 使用序列化器进行反序列化时，需要对数据进行验证后，才能获取验证成功的数据或保存成模型类对象。
• 在获取反序列化的数据前，必须调用is_valid()方法进行验证，验证成功返回True，否则返回False。
  • 验证失败，可以通过序列化器对象的errors属性获取错误信息，返回字典，包含了字段和字段的错误。如果是非字段错误，可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。
  • 验证成功，可以通过序列化器对象的validated_data属性获取数据。
• 在定义序列化器时，指明每个字段的序列化类型和选项参数，本身就是一种验证行为。

3.2 使用事项

1. 哪些字段必须反序列化
2. 字段都有哪些安全校验
3. 哪些字段需要额外提供校验 钩子函数
4. 哪些字段间存在联合校验
5. 注：反序列化字段都是用来入库的，不会出现自定义方法属性，会出现可以设置校验规则的自定义属性,不入数据库的

<code class="language-python">class BookInfoDeSerializer(serializers.Serializer):
    """图书序列化器"""
    id = serializers.IntegerField(label="ID", read_only=True)
    pwd = serializers.CharField(label="密码", required=True)
    publisher = serializers.IntegerField(label="出版社", required=False)
    btitle = serializers.CharField(label="名称", max_length=20, validators=[about_django])
    bpub_date = serializers.DateField(label="发布日期", required=False)
    created_time = serializers.DateTimeField(label="创建时间", required=False)
    bread = serializers.IntegerField(label="阅读量", required=True)
    bcomment = serializers.IntegerField(label="评论量", required=True)
    image = serializers.ImageField(label="图片", required=False)

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

3.3 验证

3.3.1 is_valid

通过构造序列化器对象，并将要反序列化的数据传递给data构造参数，进而进行验证

<code class="language-python">class BookInfo(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": "数据有误",
            })

        book_ser = BookInfoDeSerializer(data=request_data)
        
        # 序列化对象调用is_valid()完成校验，校验失败的失败信息都会被存储在 序列化对象.errors
        # 检验是否合格 raise_exception=True必填的
        book_ser.is_valid(raise_exception=True)
        # book_result是对象<class "app01.models.Book">，群增就是列表套一个个对象
        book_obj = book_ser.save()
        return Response({
            "status": 200,
            "msg": "ok",
            "results": BookInfoSerializer(instance=book_obj).data
        })
		上面两句和下面是一样的
        # if book_ser.is_valid():
        #     # 校验通过，完成新增
        #     book_obj = book_ser.save()
        #     return Response({
        #         "status": 0,
        #         "msg": "ok",
        #         "results": BookInfoSerializer(instance=book_obj).data
        #     })
        # else:
        #     # 校验失败
        #     return Response({
        #         "status": 1,
        #         "msg": book_ser.errors,
        #     })
</code>

is_valid()方法还可以在验证失败时抛出异常serializers.ValidationError

可以通过传递raise_exception=True参数开启，REST framework接收到此异常，会向前端返回HTTP 400 Bad Request响应。

<code class="language-python"># Return a 400 response if the data was invalid.
serializer.is_valid(raise_exception=True)
</code>

如果还不够，需要在补充定义验证行为，可以使用一下三种方法

3.3.2 validate_<field_name>-局部钩子

• 对<field_name>字段进行验证

• 局部钩子：validate_要校验的字段名(self, 当前要校验字段的值)

• 校验规则：校验通过返回原值，校验失败，抛出异常

<code class="language-python">class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...
    
	# 局部钩子：validate_要校验的字段名(self, 当前要校验字段的值)
    # 校验规则：校验通过返回原值，校验失败，抛出异常
    def validate_btitle(self, value):
        if "django" not in value.lower():
            raise exceptions.ValidationError("图书不是关于Django的")
        return value
</code>

测试

<code class="language-python">http://127.0.0.1:8000/bookinfo/
{
    "btitle":"红楼梦",
    "bpub_date":"2020-10-07"
}

{
    "btitle": [
        "图书不是关于Django的"
    ]
}
</code>

3.3.2 validate-全局钩子

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

• 全局钩子：validate(self, 通过系统与局部钩子校验之后的所有数据)

<code class="language-python">class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...   
    # 全局钩子：validate(self, 通过系统与局部钩子校验之后的所有数据)
    def validate(self, attrs):  # attrs是字典格式
        pwd = attrs.get("pwd")
        re_pwd = attrs.pop("re_pwd")  # 因为re_pwd不需要存入数据库，所以在全局钩子校验中删除掉这个字段
        bread = attrs["bread"]
        bcomment = attrs["bcomment"]
        if pwd != re_pwd:
            raise exceptions.ValidationError({"pwd&re_pwd": "两次密码不一致"})
        if bread < bcomment:
            raise serializers.ValidationError("阅读量小于评论量")
        return attrs
</code>

3.3.3 validators

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

<code class="language-python">def about_django(value):
    if "django" not in value.lower():
        raise serializers.ValidationError("validators-图书不是关于Django的")

class BookInfoDeSerializer(serializers.Serializer):
    id = serializers.IntegerField(label="ID", read_only=True)
    pwd = serializers.CharField(label="密码", required=True)
    publisher = serializers.IntegerField(label="出版社", required=False)
    btitle = serializers.CharField(label="名称", max_length=20, validators=[about_django])
    bpub_date = serializers.DateField(label="发布日期", required=False)
    created_time = serializers.DateTimeField(label="创建时间", required=False)
    bread = serializers.IntegerField(label="阅读量", required=True)
    bcomment = serializers.IntegerField(label="评论量", required=True)
    image = serializers.ImageField(label="图片", required=False)
</code>

测试：

<code class="language-python">Copyfrom booktest.serializers import BookInfoSerializer
data = {"btitle": "python"}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # False   
serializer.errors
#  {"btitle": [ErrorDetail(string="图书不是关于Django的", code="invalid")]}
</code>

3.3.4 validators、validate_<field_name>、validate优先级

validators—>validate_<field_name>（局部）—–>validate（全局）

3.4 反序列化-保存数据

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

<code class="language-python">class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...
    
    # 要完成新增，必须重写create方法，validated_data是校验的数据
    def create(self, validated_data):
        # 尽量在所有校验规则完毕之后，数据可以直接入库
        return models.User.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.pwd = validated_data.get("pwd", instance.pwd)
        instance.bread = validated_data.get("bread", instance.bread)
        instance.bcomment = validated_data.get("bcomment", instance.bcomment)
        return instance
</code>

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

<code class="language-python">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
</code>

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

<code class="language-python">book = serializer.save()
</code>

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

models.py

<code class="language-python">from django.db import models

class BookInfo(models.Model):
    PUB_CHOICES = [
        (0, "商务印书馆"),
        (1, "人民出版社"),
        (2, "人民文学出版社 "),
        (3, "作家出版社")
    ]
    pwd = models.CharField(max_length=32, verbose_name="密码")
    publisher = models.IntegerField(choices=PUB_CHOICES, default=0, verbose_name="出版社")
    btitle = models.CharField(max_length=20, verbose_name="名称")
    bpub_date = models.DateField(verbose_name="发布日期", null=True)
    created_time = models.DateTimeField(auto_now_add=True, verbose_name="创建时间", help_text="创建时间")
    bread = models.IntegerField(default=0, verbose_name="阅读量")
    bcomment = models.IntegerField(default=0, verbose_name="评论量")
    image = models.ImageField(upload_to="icon", verbose_name="图片", default="icon/default.jpg")

    class Meta:
        db_table = "BookInfo"
        verbose_name = "书籍信息"
        verbose_name_plural = verbose_name

    def __str__(self):
        return "%s" % self.btitle
</code>

路由：urls

<code class="language-python">
from django.urls import path, re_path
from .views import test, users, books, v2books

urlpatterns = [
    path("bookinfo/", users.BookInfo.as_view()),
    re_path("bookinfo/(?P<pk>.*)/$", users.BookInfo.as_view()),
]

</code>

views视图

<code class="language-python">rom rest_framework.views import APIView
from rest_framework.response import Response

from .. import models
from ..serializers import UserSerializer, UserDeserializer, BookInfoSerializer, BookInfoDeSerializer


class BookInfo(APIView):
    def get(self, request, *args, **kwargs):
        pk = kwargs.get("pk")
        if pk:
            try:
                # 1) 查询出图书对象
                book_obj = models.BookInfo.objects.get(pk=pk)
                # 2) 构造序列化器
                book_ser = BookInfoSerializer(instance=book_obj)
                # 3) 获取序列化数据
                return Response({
                    "status": 200,
                    "msg": 0,
                    "results": book_ser.data  # 通过data属性可以获取序列化后的数据
                })
            except:
                return Response({
                    "status": 201,
                    "msg": "书籍信息不存在",
                })
        else:
            # 1) 查询出图书对象
            book_obj_list = models.BookInfo.objects.all()
            # 2) 构造序列化器   PS:如果要被序列化的是包含多条数据的查询集QuerySet，可以通过添加many=True参数补充说明
            book_ser_data = BookInfoSerializer(instance=book_obj_list, many=True)
            # 3) 获取序列化数据
            return Response({
                "status": 200,
                "msg": 0,
                "results": book_ser_data.data  # 通过data属性可以获取序列化后的数据
            })

    def post(self, request, *args, **kwargs):
        request_data = request.data
        if not isinstance(request_data, dict) or request_data == {}:
            return Response({
                "status": 1,
                "msg": "数据有误",
            })

        book_ser = BookInfoDeSerializer(data=request_data)
        # 序列化对象调用is_valid()完成校验，校验失败的失败信息都会被存储在 序列化对象.errors
        # 检验是否合格 raise_exception=True必填的
        book_ser.is_valid(raise_exception=True)
        # book_result是对象<class "app01.models.Book">，群增就是列表套一个个对象
        book_obj = book_ser.save()
        return Response({
            "status": 200,
            "msg": "ok",
            "results": BookInfoSerializer(instance=book_obj).data
        })

        # if book_ser.is_valid():
        #     # 校验通过，完成新增
        #     book_obj = book_ser.save()
        #     return Response({
        #         "status": 0,
        #         "msg": "ok",
        #         "results": BookInfoSerializer(instance=book_obj).data
        #     })
        # else:
        #     # 校验失败
        #     return Response({
        #         "status": 1,
        #         "msg": book_ser.errors,
        #     })
</code>

serializers.py

<code class="language-python">from rest_framework import serializers
from django.conf import settings
from rest_framework.exceptions import ValidationError
from . import models

# 序列化
class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    id = serializers.IntegerField(label="ID", read_only=True)
    pwd = serializers.CharField(label="密码", required=True)
    publisher = serializers.IntegerField(label="出版社", required=False)
    btitle = serializers.CharField(label="名称", max_length=20)
    bpub_date = serializers.DateField(label="发布日期", required=False)
    created_time = serializers.DateTimeField(label="创建时间", required=False)
    bread = serializers.IntegerField(label="阅读量", required=False)
    bcomment = serializers.IntegerField(label="评论量", required=False)
    image = serializers.ImageField(label="图片", required=False)
    """
    自定义序列化属性
    格式：  属性名随意，值由固定的命名规范方法提供
    def get_属性名(self, 参与序列化的model对象):
        返回值就是自定义序列化属性的值
    """
    # 出版社显示名称，而不是0，1。。。
    publisher_name = serializers.SerializerMethodField()

    def get_publisher_name(self, obj):
        # choice类型的解释型值 get_字段_display() 来访问
        return obj.get_publisher_display()

    # 图片显示全路径
    image_path = serializers.SerializerMethodField()

    def get_image_path(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.image))

    # 自定义虚拟阅读量，原基础增加10
    fictitious_bread = serializers.SerializerMethodField()

    def get_fictitious_bread(self, obj):
        return obj.bread + 10


def about_django(value):
    if "django" not in value.lower():
        raise serializers.ValidationError("validators-图书不是关于Django的")

# 反序列化
class BookInfoDeSerializer(serializers.Serializer):
    id = serializers.IntegerField(label="ID", read_only=True)
    pwd = serializers.CharField(label="密码", required=True)
    publisher = serializers.IntegerField(label="出版社", required=False)
    btitle = serializers.CharField(label="名称", max_length=20, validators=[about_django])
    bpub_date = serializers.DateField(label="发布日期", required=False)
    created_time = serializers.DateTimeField(label="创建时间", required=False)
    bread = serializers.IntegerField(label="阅读量", required=True)
    bcomment = serializers.IntegerField(label="评论量", required=True)
    image = serializers.ImageField(label="图片", required=False)

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

    # 局部钩子：validate_要校验的字段名(self, 当前要校验字段的值)
    # 校验规则：校验通过返回原值，校验失败，抛出异常
    def validate_btitle(self, value):
        if "django" not in value.lower():
            raise exceptions.ValidationError("validate_btitle-图书不是关于Django的")
        return value

    # 全局钩子：validate(self, 通过系统与局部钩子校验之后的所有数据)
    def validate(self, attrs):  # attrs是字典格式
        pwd = attrs.get("pwd")
        re_pwd = attrs.pop("re_pwd")  # 因为re_pwd不需要存入数据库，所以在全局钩子校验中删除掉这个字段
        bread = attrs["bread"]
        bcomment = attrs["bcomment"]
        if pwd != re_pwd:
            raise exceptions.ValidationError({"pwd&re_pwd": "两次密码不一致"})
        if bread < bcomment:
            raise serializers.ValidationError("阅读量小于评论量")
        return attrs

    # 要完成新增，必须重写create方法，validated_data是校验的数据
    def create(self, validated_data):
        # 尽量在所有校验规则完毕之后，数据可以直接入库
        return models.User.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.pwd = validated_data.get("pwd", instance.pwd)
        instance.bread = validated_data.get("bread", instance.bread)
        instance.bcomment = validated_data.get("bcomment", instance.bcomment)
        return instance
</code>

3.5 附加说明

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

<code class="language-python"># request.user 是django中记录当前登录用户的模型对象
serializer.save(owner=request.user)
</code>

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

<code class="language-python"># Update `comment` with partial data
serializer = CommentSerializer(comment, data={"content": u"foo bar"}, partial=True)
</code>

喜欢 (0)赏

[搞代码]

分享 (0)