Django工程-Serializer序列化器与反序列化器详解（八）

Django工程-Serializer序列化器详解

一、序列化器使用

1. 定义方法

Django REST framework中的Serializer使用类来定义，须继承自rest_framework.serializers.Serializer。

例如，我们已有了一个数据库模型类BookInfo

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)
    userinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)  # 新增

    def validate_btitle(self, value):
        """此函数会针对btitle的内容进行验证"""
        if 'django' not in value.lower():
            raise serializers.ValidationError('图书不是关于Django的2')

        return value

    def validate(self, attrs):
        """
        attrs: 就是创建序列化器对象时，传入data数据
        """
        # 获取bread和bcomment
        bread = attrs['bread']
        bcomment = attrs['bcomment']

        if bread < bcomment:
            raise serializers.ValidationError('图书阅读量小于评论量')

        return attrs

user类

class UsersSerializer(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)
    # hbook = serializers.PrimaryKeyRelatedField(label='图书', read_only=True)
    hbook = serializers.StringRelatedField(label='图书')

2.序列化使用

1 基本使用

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

from booktest.models import BookInfo

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

2） 构造序列化器对象

from booktest.serializers import BookInfoSerializer

serializer = BookInfoSerializer(book)

3）获取序列化数据

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

serializer.data

4）如果要被序列化的是包含多条数据的查询集QuerySet，可以通过添加many=True参数补充说明
创建test.py文件，运行以下代码

from django.test import TestCase

# Create your tests here.
# 设置Django运行所依赖的环境变量
import os
if not os.environ.get('DJANGO_SETTINGS_MODULE'):
    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "helloDjango.settings")

# 让Django进行一次初始化
import django
django.setup()

from books.serializers import BookInfoSerializer, UsersInfoSerializer
from books.models import BookInfo, UsersInfo

if __name__ == '__main__':
    book_qs = BookInfo.objects.all()
    serializer = BookInfoSerializer(book_qs, many=True)
    print(serializer.data)

2 关联对象嵌套序列化

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

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

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

class UsersSerializer(serializers.Serializer):
    """用户序列化器"""
    GENDER_CHOICES = (
        (0, 'male'),
        (1, 'female')
    )
    id = serializers.IntegerField(label='ID', read_only=True)
    hname = serializers.CharField(label='名字', max_length=20, write_only=True) # 序列化数据时会忽略该字段
    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参数时，将被用作反序列化时参数校验使用
  2）使用关联对象的序列化器

hbook = BookInfoSerializer()

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

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

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

userinfo_set = serializers.PrimaryKeyRelatedField(read_only=True, many=True)  # 新增

二、反序列化使用

1. 验证

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

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

from django.test import TestCase

# Create your tests here.
# 设置Django运行所依赖的环境变量
import os
if not os.environ.get('DJANGO_SETTINGS_MODULE'):
    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "helloDjango.settings")

# 让Django进行一次初始化
import django
django.setup()

from books.serializers import BookInfoSerializer, UsersInfoSerializer
from books.models import BookInfo, UsersInfo

if __name__ == '__main__':
    data = {'bpub_date': 123}
    serializer = BookInfoSerializer(data=data)
    serializer.is_valid()  # 返回False
    print(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')]}
    print(serializer.validated_data)  # {}

补充定义认证：

如果觉得这些还不够，需要再补充定义验证行为，可以使用以下三种方法：

1）validators

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

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

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    id = serializers.IntegerField(label='ID', read_only=True)
    # 添加自定义认证的函数`validators=[about_django]`
    btitle = serializers.CharField(label='名称', max_length=20, validators=[about_django])
    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)

2）validate_

对字段进行验证，如

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...
    
	# validate_字段名
    def validate_btitle(self, value):
        if 'django' not in value.lower():
            raise serializers.ValidationError("图书不是关于Django的")
        return value

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

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...
	
	# 传入data,取data的属性进行业务逻辑判断
    def validate(self, attrs):
        bread = attrs['bread']
        bcomment = attrs['bcomment']
        if bread < bcomment:
            raise serializers.ValidationError('阅读量小于评论量')
        return attrs

2. 保存

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

class BookInfoSerializer(serializers.Serializer):
    """图书数据序列化器"""
    ...

    def create(self, validated_data):
        """
        validated_data: 校验之后的数据，dict类型
        """
        # print('create方法被调用')

        # 添加一本图书
        book = BookInfo.objects.create(**validated_data)

        # 返回图书对象
        return book

    def update(self, instance, validated_data):
        """
        instance: 创建序列化器对象时，传入实例对象
        validated_data: 校验之后的数据，dict类型
        """
        # print('update方法被调用')
        # 获取参数
        btitle = validated_data.get('btitle', instance.btitle)
        bpub_date = validated_data.get('bpub_date', instance.bpub_date)

        # 更新图书的btitle和bpub_date
        instance.btitle = btitle
        instance.bpub_date = bpub_date
        instance.save()

        # 返回更新对象
        return instance

3.额外传递参数

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

serializer.save(user=request.name)

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

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

三. 进阶使用-模型类序列化器ModelSerializer

下面是简单的demo
1.models表

from django.db import models


class Book(models.Model):
    title=models.CharField(max_length=32)
    price=models.IntegerField()
    pub_date=models.DateField()
    publish=models.ForeignKey("Publish")
    authors=models.ManyToManyField("Author")


    def __str__(self):
        return "app02 %s" % self.title

    class Meta:
        app_label='app02'


class Publish(models.Model):
    name=models.CharField(max_length=32)
    email=models.EmailField()


    def __str__(self):
        return "app02 %s" % self.name

    class Meta:
        app_label = 'app02'

class Author(models.Model):
    name=models.CharField(max_length=32)
    age=models.IntegerField()
    def __str__(self):
        return "app02 %s" %self.name

    class Meta:
        app_label = 'app02'

序列化器serializers.py

class AuthorSer(serializers.ModelSerializer):
    class Meta:
        model=models.Author
        fields='__all__'


class Publishser(serializers.ModelSerializer):
    class Meta:
        model=models.Publish
        fields='__all__'


class BookModelSerializers(serializers.ModelSerializer):    
	# 多对一
    publish = Publishser()
    # 多对多
    authors = serializers.SerializerMethodField()

    # 钩子函数序列化,必须是以get_开头的
    def get_authors(self, obj):
        author = obj.authors.all()
        auth = AuthorSerializers(author, many=True)
        return auth.data
        
    class Meta:
        model=models.Book
        fields='__all__'

以上是Django DRF框架序列化和反序列化的简单例子说明，希望可以帮助到你，Django工程相关系列使用可参考笔者其他的博客，希望可以帮助到你！tks!