DRF序列化器

显示全部楼层 · 2019-11-8 09:56:34

序列化器-Serializer

作用：

1. 序列化,序列化器会把模子对象转换成字典,颠末response以后变成json字符串2. 反序列化,把客户端发送过来的数据,颠末request以后变成字典,序列化器可以把字典转成模子3. 反序列化,完成数据校验功能

复制代码

界说序列化器

Django REST framework中的Serializer使用类来界说，须继承自rest_framework.serializers.Serializer。
起首创建一个子应用sers

python manage.py startapp sers

复制代码

使用上一篇博客中创建的数据库模子类students/Student，代码如下：

from django.db import models# Create your models here.class Student(models.Model): # 模子字段 name = models.CharField(max_length=100,verbose_name="姓名",help_text="提示文本:账号不能为空！") sex = models.BooleanField(default=True,verbose_name="性别") age = models.IntegerField(verbose_name="年事") class_null = models.CharField(max_length=5,verbose_name="班级编号") description = models.TextField(verbose_name="个性签名") class Meta: db_table="tb_student" verbose_name = "门生" verbose_name_plural = verbose_name

复制代码

假如要为这个模子类提供一个序列化器，还须要创建一个serializers.py文件，然后举行如下界说：

from rest_framework import serializers# 声明序列化器，全部的序列化器都要直接大概间接继承于 Serializer# 此中，ModelSerializer是Serializer的子类，ModelSerializer在Serializer的根本上举行了代码简化class StudentSerializer(serializers.Serializer): """门生信息序列化器""" # 1. 须要举行数据转换的字段 id = serializers.IntegerField() name = serializers.CharField() age = serializers.IntegerField() sex = serializers.BooleanField() description = serializers.CharField() # 2. 假如序列化器集成的是ModelSerializer，则须要声明调用的模子信息 # 3. 验证代码 # 4. 编写添加和更新模子的代码

复制代码

【注意】serializer不是只能为数据库模子类界说，也可以为非数据库模子类的数据界说。可以说serializer是独立于数据库之外的存在。
常用字段范例

字段

字段字段构造方式 serializers.字段构造方式()BooleanFieldBooleanField()NullBooleanFieldNullBooleanField()CharFieldCharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)EmailFieldEmailField(max_length=None, min_length=None, allow_blank=False)RegexFieldRegexField(regex, max_length=None, min_length=None, allow_blank=False)SlugFieldSlugField(max*length=50, min_length=None, allow_blank=False) 正则字段，验证正则模式 [a-zA-Z0-9*-]+URLFieldURLField(max_length=200, min_length=None, allow_blank=False)UUIDFieldUUIDField(format='hex_verbose') format:
1) 'hex_verbose' 如"5ce0e9a5-5ffa-654b-cee0-1238041fb31a"
2) 'hex' 如 "5ce0e9a55ffa654bcee01238041fb31a"
3) 'int' - 如: "123456789012312313134124512351145145114"
4) 'urn' 如: "urn:uuid:5ce0e9a5-5ffa-654b-cee0-1238041fb31a"IPAddressFieldIPAddressField(protocol='both', unpack_ipv4=False, **options)IntegerFieldIntegerField(max_value=None, min_value=None)FloatFieldFloatField(max_value=None, min_value=None)DecimalFieldDecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None)
max_digits: 最多位数
decimal_palces: 小数点位置DateTimeFieldDateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None)DateFieldDateField(format=api_settings.DATE_FORMAT, input_formats=None)TimeFieldTimeField(format=api_settings.TIME_FORMAT, input_formats=None)DurationFieldDurationField()ChoiceFieldChoiceField(choices) choices与Django的用法相同MultipleChoiceFieldMultipleChoiceField(choices)FileFieldFileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)ImageFieldImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)ListFieldListField(child=, min_length=None, max_length=None)DictFieldDictField(child=)参数

参数名称作用max_length最大长度min_lenght最小长度allow_blank是否答应为空trim_whitespace是否截断空缺字符max_value最大数值min_value最小数值通用参数

参数名称阐明read_only表明该字段仅用于序列化输出，默认Falsewrite_only表明该字段仅用于反序列化输入，默认Falserequired表明该字段在反序列化时必须输入，默认Truedefault反序列化时使用的默认值allow_null表明该字段是否答应传入None，默认Falsevalidators该字段使用的验证器error_messages包罗错误编号与错误信息的字典label用于HTML展示API页面时，表现的字段名称help_text用于HTML展示API页面时，表现的字段资助提示信息创建Serializer对象

界说好Serializer类后，就可以创建Serializer对象了。对象可以创建在该应用的views.py中：
Serializer的构造方法为：

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

复制代码

阐明：
1）用于序列化时，将模子类对象传入instance参数
2）用于反序列化时，将要被反序列化的数据传入data参数
3）除了instance和data参数外，在构造Serializer对象时，还可通过context参数额外添加数据，如

serializer = StudentSerializer(instance, context={'request': request}) # 参数instance ，模子对象，这个参数一样平常用于把模子转成字典，举行序列化 # 参数data，客户端提交的字典数据，这个参数一样平常用于把字典转成模子对象，举行校验数据和反序列化 # 参数context，偶尔候，路由大概视图中有些数据须要转达序列化器内部的方法中调用，则可以context以字典的格式转达举行 # 额外参数： many=True, 表现instance是一个模子列表，此时序列化器在转换数据的时间可以举行循环

复制代码

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

使用序列化器的时间肯定要注意，序列化器声明白以后，不会自动实行，须要我们在视图中举行调用才可以；
序列化器无法直接汲取数据，须要我们在视图中创建序列化器对象时把使用的数据转达过来；
序列化器的字段声明类似于我们前面使用过的表单体系；
开发restful api时，序列化器会帮我们把模子数据转换成字典；
drf提供的视图会帮我们把字典转换成json,大概把客户端发送过来的数据转换字典。

DRF序列化器

推广达人

突出贡献

优秀版主

荣誉管理

论坛元老