1. 序列化,序列化器会把模型对象转换成字典,经过response以后变成json字符串
2. 反序列化,把客户端发送过来的数据,经过request以后变成字典,序列化器可以把字典转成模型
3. 反序列化,完成数据校验功能
Django REST framework中的Serializer使用类来定义,须继承自rest_framework.serializers.Serializer。
接下来,为了方便演示序列化器的使用,我们先创建一个新的子应用students
python manage.py startapp students
我们已有了一个数据库模型类students/students.py/Student
from django.db import models # Create your models here. class Student(models.Model): #以下模型字段默认时不能为空 null=False name = models.CharField(max_length=100,verbose_name="姓名") sex = models.BooleanField(default=1,verbose_name="性别") age = models.IntegerField(verbose_name="年龄") class_null = models.CharField(max_length=5,verbose_name="班级编号") description = models.TextField(max_length=1000,verbose_name="个性签名") class Meta: db_table="tb_student" verbose_name ="学生" verbose_name_plural = verbose_name
我们想为这个模型类提供一个序列化器students/serializers.py/StudentSerializer,可以定义如下:
from rest_framework import serializers class StudentSerializer(serializers.Serializer): # 1. 需要转换的字段声明 # 小括号里面声明主要提供给反序列化使用的 id=serializers.IntegerField(read_only=True) name = serializers.CharField(required=True, max_length=20) age = serializers.IntegerField(max_value=150, min_value=0,required=True) sex = serializers.BooleanField(default=True,write_only=True) description = serializers.CharField(required=True, allow_null=True, allow_blank=True) # 如果序列化器调用的模型中的字段声明,则需要声明Meta类
# 2. 如果序列化器集成的是ModelSerializer,则需要声明调用的模型信息
# 3. 验证代码
# 4. 编写添加和更新模型的代码
常用字段类型
**常用字段类型**: | 字段 | 字段构造方式 | | ----------------------- | ------------------------------------------------------------ | | **BooleanField** | BooleanField() | | **NullBooleanField** | NullBooleanField() | | **CharField** | CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True) | | **EmailField** | EmailField(max_length=None, min_length=None, allow_blank=False) | | **RegexField** | RegexField(regex, max_length=None, min_length=None, allow_blank=False) | | **SlugField** | SlugField(max*length=50, min_length=None, allow_blank=False) 正则字段,验证正则模式 [a-zA-Z0-9*-]+ | | **URLField** | URLField(max_length=200, min_length=None, allow_blank=False) | | **UUIDField** | UUIDField(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"` | | **IPAddressField** | IPAddressField(protocol=‘both‘, unpack_ipv4=False, **options) | | **IntegerField** | IntegerField(max_value=None, min_value=None) | | **FloatField** | FloatField(max_value=None, min_value=None) | | **DecimalField** | DecimalField(max_digits, decimal_places, coerce_to_string=None, max_value=None, min_value=None) max_digits: 最多位数 decimal_palces: 小数点位置 | | **DateTimeField** | DateTimeField(format=api_settings.DATETIME_FORMAT, input_formats=None) | | **DateField** | DateField(format=api_settings.DATE_FORMAT, input_formats=None) | | **TimeField** | TimeField(format=api_settings.TIME_FORMAT, input_formats=None) | | **DurationField** | DurationField() | | **ChoiceField** | ChoiceField(choices) choices与Django的用法相同 | | **MultipleChoiceField** | MultipleChoiceField(choices) | | **FileField** | FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL) | | **ImageField** | ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL) | | **ListField** | ListField(child=, min_length=None, max_length=None) | | **DictField** | DictField(child=) | **选项参数:**
选项参数:
参数名称 | 作用 |
---|---|
max_length | 最大长度 |
min_lenght | 最小长度 |
allow_blank | 是否允许为空 |
trim_whitespace | 是否截断空白字符 |
max_value | 最小值 |
min_value | 最大值 |
通用参数:
参数名称 | 说明 |
---|---|
read_only | 表明该字段仅用于序列化输出,默认False |
write_only | 表明该字段仅用于反序列化输入,默认False |
required | 表明该字段在反序列化时必须输入,默认True |
default | 反序列化时使用的默认值 |
allow_null | 表明该字段是否允许传入None,默认False |
validators | 该字段使用的验证器 |
error_messages | 包含错误编号与错误信息的字典 |
label | 用于HTML展示API页面时,显示的字段名称 |
help_text | 用于HTML展示API页面时,显示的字段帮助提示信息 |
定义好students/serializers.py/StudentSerializer类后,就可以创建Serializer对象了。
Serializer的构造方法为:
StudentSerializer(instance=None, data=empty, **kwarg)
说明:
1)用于序列化时,将模型类对象传入instance参数
2)用于反序列化时,将要被反序列化的数据传入data参数
3)除了instance和data参数外,在构造Serializer对象时,还可通过context参数额外添加数据,如
serializer = StudentSerializer(account, context={‘request‘: request})
通过context参数附加的数据,可以通过Serializer对象的context属性获取。
使用序列化器的时候一定要注意,序列化器声明了以后,不会自动执行,需要我们在视图中进行调用才可以。
序列化器的字段声明类似于我们前面使用过的表单系统。
开发restful api时,序列化器会帮我们把模型数据转换成字典.
drf提供的视图会帮我们把字典转换成json,或者把客户端发送过来的数据转换字典.
序列化器的使用分两个阶段:
在客户端请求时,使用序列化器可以完成对数据的反序列化。
在服务器响应时,使用序列化器可以完成对数据的序列化。
使用序列化器进行反序列化时,需要对数据进行验证后,才能获取验证成功的数据或保存成模型类对象。
在获取反序列化的数据前,必须调用is_valid()方法进行验证,验证成功返回True,否则返回False。
验证失败,可以通过序列化器对象的errors属性获取错误信息,返回字典,包含了字段和字段的错误。如果是非字段错误,可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。
验证成功,可以通过序列化器对象的validated_data属性获取数据。
在定义序列化器时,指明每个字段的序列化类型和选项参数,本身就是一种验证行为。
原文:https://www.cnblogs.com/linux985/p/10995983.html