DRF序列化器
2024-08-28 14:29:51
序列化器-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.字段构造方式() |
---|---|
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(maxlength=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页面时,显示的字段帮助提示信息 |
创建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,或者把客户端发送过来的数据转换字典。
最新文章
- Jqgrid 数据格式化配置
- PHP获取日期
- hide your website's wordpress info/path/way
- 《学习OpenCV》练习题第四章第八题ab
- 8VC Venture Cup 2016 - Elimination Round (C. Block Towers)
- EffectiveC#16--垃圾最小化
- 转: 向tabControl中添加一个Form(C#)
- Toolkit 一键激活Office 2010方法及Office 2010 Toolkit工具下载
- hdu4280(最大流)
- Chapter 2 Open Book——38
- vultr和digitalocean vps使用感受
- 去掉tomcat中appBase默认的ROOT
- hibernate--联合主键--XML
- PL/SQL编程重点语句输出整理
- NOIP2016解题报告
- bzoj2049 线段树 + 可撤销并查集
- springboot+cfx实现webservice功能
- Erlang中一些错误或者异常的标识
- mysql中index与Multiple-Column Indexes区别与联系
- 深入分析JavaWeb Item43 -- Struts2开发入门