[Python知识库]DRF(三)：反序列化和模型序列化器

反序列化

1.1 数据验证

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

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

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

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

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

例如：我们之前定义过的PublishSerializer类

class PublishSerializer(serializers.Serializer):
    nid = serializers.IntegerField(required=False)
    name = serializers.CharField(max_length=32,error_messages={
        'max_length':'太长了，小伙子'
    })
    city = serializers.CharField()
    phone = serializers.CharField(max_length=32)

通过构造序列化对象，将反序列化的数据传递给data参数，然后通过校验：

from rest_framework.views import APIView
from rest_framework.response import Response
from app01 import serializer
 
 
class PublishView(APIView):

    # post请求添加一条出版社数据
    def post(self,request):
        publish_ser = serializer.PublishSerializer(data=request.data)
        if publish_ser.is_valid():
            publish_ser.save()
            return Response(publish_ser.data)
        else:
            print(publish_ser.errors)
            return Response(publish_ser.errors)

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

serializer.is_valid(raise_exception=True)

补充定义验证行为，可以使用以下两种方法：

1) validate_字段名：局部校验

对<field_name>字段进行验证，如校验电话号码：

    def validated_phone(self, data):
        if re.match(data, '^[1][3,4,5,7,8,9][0,9]{9}$'):
            return data
        else:
            raise ValidationError('电话号码格式有误')

2) validate：全局校验

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

    def validate(self, attrs):
        name = attrs.get('name')
        city = attrs.get('city')
        if name == city:
            raise ValidationError('名字不能和城市一样')
        return attrs

附加说明

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

1
2

# request.user 是django中记录当前登录用户的模型对象
serializer.save(owner=request.user)

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

1
2

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

?

模型类序列化器

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

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

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

定义

比如我们创建一个BookModelSerializer，在这里的Book表和Publish表是多对一关系，和Authors表是多对多关系。如果我们这里fields设置成'__all__',那么Book表中对应的publish和author只会显示id，如果想显示出版社和作者的详细信息，我们可以另外添加字段，这里我们先在fields里面注册publish_detail和authors

from rest_framework import serializers
from app01.models import Publish,Book,Author,User


class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = ['id','name','price','publish_detail','authors'] # 显示字段
        # exclude = ('条形码',) # 不显示
        extra_kwargs = {
            'publish':{'write_only':True,'required':True},
            'author':{'write_only':True,'required':True}
        }

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

指定字段

1) 使用fields来明确字段，__all__表名包含所有字段，也可以写明具体哪些字段，

2) 使用exclude可以明确排除掉哪些字段

3) 显示指明字段，在extra_kwargs设置publish和author只读，或者加一些对字段的其他限制。如：

        extra_kwargs = {
            'publish':{'write_only':True,'required':True},
            'author':{'write_only':True,'required':True}
        }

4) 在序列化器中添加字段

方法一：添加?publish_detail字段

通过serializers.SerializerMethodField()方法添加字段名，后面对应写一个get_+字段名的方法用于定义字段内部信息。

可以通过read_only_fields指明只读字段，即仅用于序列化输出的字段

    # 添加publish_detail字段，并设置成只读，将publish的值存入字典映射给publish_detail
    publish_detail = serializers.SerializerMethodField(read_only=True)
    def get_publish_detail(self,obj):
        return {'name':obj.publish.name,'addr':obj.publish.addr}

方法二：添加?publish_detail字段

1）在BookModelSerializer中添加authors字段，设置字段类型为ListFields

    # 添加authors字段。设置成字典。并在模型表中为authors赋值
    authors = serializers.ListField(read_only=True)

2）在models.py的Book类中使用@property装饰器和authors方法返回authors字段内部信息

    @property
    def authors(self):
        return [{author.name:{'phone':author.author_detail.phone,'age':author.author_detail.age,'email':author.author_detail.email}}for author in self.author.all()]