Serializer组件

一、定义序列化器

Django Rest Framework中的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)

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

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)

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

二、serializer中常用字段类型

字段	字段构造方式
BooleanField	BooleanField()
NullBoolleanField	NullBoolleanField()
CharField	CharField(max_length=None,min_length=None,allow_black=False,trim_whitespace=True)
EmailField	EmailField(max_length=None,min_length=None),allow_black=False)
RegexField	RegexField(regex,max_length=None,min_length=None,allow_black=False)
SlugField	SlugField(max_length=50,min_length=None,allow_black=False)正则字段，验证正则模式[a-zA-Z0-9*-]+
URLField	URLField(max_length=200,min_length=None,allow_black=False)
UUIDField	UUIDField(format='hex_verbose')format:1)'hex_verbose'如"5ce0e9a5-5ffa-654b-cce0-1238041fb31a"2)'hex'如"5ce0e9a55ffa654bcee01238041fb31a" 3)'int'如"12345678901231231313134124512351145145114"
IPAddressField	IPAddressField(portocol='both',unpack_ipv4=False,**options)
IntegerField	IntegerField(max_length=None,min_length=None)
FloatField	FloatField(max_length=None,min_length=None)
DecimalField	DecimalField(max_digits,decimal_places,coerce_to_string=None,max_value=None,min_value=None)max_digits:最多位数ecimal_places:小数点位置
DateTimeField	DateTimeField(format=api_settings.DATETIME_FORMAT,input_formats=None)
TimeField	TimeField(format=api_settings.TIME_FORMAT,input_formats=None)
DurationField	DurationField()
ChoiceField	ChoiceField(choices)用法与Django相同
MultipleChoiceField	MultipleChoiceField(choices)
FileField	FileField(max_length=None,allow_empty_file=False,use_url=UPL_OADED_FILES_USE_URL)
ImageField	ImageField(max_length=None,allow_empty_file=False,use_url=UPL_OADED_FILES_USE_URL)
Listfield	Listfield(child=,min_length=None,max_length=None)
DictField	DictField(child=,)
DateField	DateField(format=api_settings.DATE_FORMAT,input_formats=None)

选项参数：

参数名称	作用
max_length	最大长度
min_length	最小长度
allow_blank	是否允许为空
trim_whitespace	是否截断空白字符
max_value	最大值
min_value	最小值

通用参数：

参数名称	说明
read_only	表明该字段仅用于序列化输出，默认False
write_only	表明该字段仅用于反序列化输出，默认False
required	表明该字段在反序列化时必须输入，默认False
default	反序列化时使用的默认值
allow_null	表明该字段是否允许传入None,默认False
validators	该字段使用的验证器
error_messages	包含错误编号与错误信息的字典
label	用于html展示API页面时，显示的字段名称
help_text	用于html展示API页面时，显示的字段帮助提示信息

三、创建Serializer对象

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

Serializer的构造方法为：

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

说明：

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

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

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

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

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

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

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

3.序列化器的字段声明类似于我们使用过的form\modelform

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

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

四、序列化器的使用

序列化器的使用的两个阶段：
- 在客户端请求时，使用序列化器可以完成对数据的反序列化
- 在服务器响应时，使用序列化器可以完成对数据的序列化

序列化的基本使用

先查询出一个图书对象

from booktest.models import BookInfo

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

构造序列化器对象

from booktest.serializers import BookInfoSerializer

serializer = BookInfoSerializer(book)

获取序列化数据

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

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

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

book_qs = BookInfo.objects.all()
serializer = BookInfoSerializer(book_qs, many=True)
serializer.data
# [OrderedDict([('id', 2), ('btitle', '天龙八部'), ('bpub_date', '1986-07-24'), ('bread', 36), ('bcomment', 40), ('image', N]), OrderedDict([('id', 3), ('btitle', '笑傲江湖'), ('bpub_date', '1995-12-24'), ('bread', 20), ('bcomment', 80), ('image'ne)]), OrderedDict([('id', 4), ('btitle', '雪山飞狐'), ('bpub_date', '1987-11-11'), ('bread', 58), ('bcomment', 24), ('ima None)]), OrderedDict([('id', 5), ('btitle', '西游记'), ('bpub_date', '1988-01-01'), ('bread', 10), ('bcomment', 10), ('im', 'booktest/xiyouji.png')])]

反序列化(数据校验)的基本使用

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

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

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

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

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

如我们之前定义的BookInfoSerializer:

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)

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

from booktest.serializers import BookInfoSerializer
data = {'bpub_date': 123}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # 返回False
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')]}
serializer.validated_data  # {}

data = {'btitle': 'python'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # True
serializer.errors  # {}
serializer.validated_data  #  OrderedDict([('btitle', 'python')])

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

# Return a 400 response if the data was invalid.
serializer.is_valid(raise_exception=True)

若上述还满足不了需求，需要再补充定义验证行为，可以使用以下三种方法：

1）validate_字段名

对<field_name>字段进行验证，如：

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

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

测试代码：

from booktest.serializers import BookInfoSerializer
data = {'btitle': 'python'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # False   
serializer.errors
#  {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}

2)validate

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

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

    def validate(self, attrs):
        bread = attrs['bread']
        bcomment = attrs['bcomment']
        if bread < bcomment:
            raise serializers.ValidationError('阅读量小于评论量')
        return attrs

测试代码：

from booktest.serializers import BookInfoSerializer
data = {'btitle': 'about django', 'bread': 10, 'bcomment': 20}
s = BookInfoSerializer(data=data)
s.is_valid()  # False
s.errors
#  {'non_field_errors': [ErrorDetail(string='阅读量小于评论量', code='invalid')]}

3)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)
    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)

测试代码：

from booktest.serializers import BookInfoSerializer
data = {'btitle': 'python'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # False   
serializer.errors
#  {'btitle': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}

反序列化--数据保存

前面的验证数据成功后，我们可以使用序列化器来完成数据反序列化的过程，这个过程可以把数据转成模型类对象，可以通过create()和update()两个方法来实现

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

    def create(self, validated_data):
        """新建"""
        return BookInfo(**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)
        return instance

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

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

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

book = serializer.save()

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

from db.serializers import BookInfoSerializer
data = {'btitle': '封神演义'}
serializer = BookInfoSerializer(data=data)
serializer.is_valid()  # True
serializer.save()  # <BookInfo: 封神演义>

from db.models import BookInfo
book = BookInfo.objects.get(id=2)
data = {'btitle': '倚天剑'}
serializer = BookInfoSerializer(book, data=data)
serializer.is_valid()  # True
serializer.save()  # <BookInfo: 倚天剑>
book.btitle  # '倚天剑'

五、补充

在序列化器进行save()保存时，可以额外传递数据，这些数据可以在create()和update()中的validated_data参数获取到
```
# request.user 是django中记录当前登录用户的模型对象
serializer.save(owner=request.user)
```
默认序列化器必须传递所有required的字段，否则会抛出异常错误，但是我们可以使用partial参数来允许部分字段更新
```
# Update `comment` with partial data
serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True)
```

posted @ 2020-06-20 21:24 末兰岩阅读(144) 评论(0) 编辑收藏举报

会员力量，点亮园子希望

刷新页面返回顶部

攻城狮之旅

To build a better world by code......

Serializer组件

一、定义序列化器

二、serializer中常用字段类型

三、创建Serializer对象

四、序列化器的使用

若上述还满足不了需求，需要再补充定义验证行为，可以使用以下三种方法：

五、补充

公告