drf序列化器-Serializer

Python之drf序列化器-Serializer

一、序列化器-Serializer的作用

• 序列化，序列化器会将模型类对象转化为字典，经过Response变成json字符串
• 反序列化，把客户发送过来的数据，经过request以后变成字典，序列化器可以将字典转成模型
• 反序列化，校验客户发送数据的合法性

二、定义序列化器

• Django REST framework中的Serializer使用类来定义，须继承自rest_framework.serializers.Serializer。

需要先在数据库中建立一个模型类（建表）

from django.db import models

# Create your models here.
class Student(models.Model):
    name = models.CharField(max_length=32)
    age = models.IntegerField()

在应用下新建serializer.py文件（名字可以随意取,一般使用serializer），在文件中导入刚才建立的表并导入serializers。如下

from rest_framework import serializers
from .models import Student
# 定义序列化器
class StudentSerializer(serializers.Serializer):
    # 在下面写入想要序列化的字段名称
    name = serializers.CharField()
    age = serializers.IntegterField()

上述一写一个序列化类就已经完成了，下一步在view.py视图函数中填入相应的代码即可。如下

from django.shortcuts import render

# Create your views here.
import models
from rest_framework.views import APIView
from rest_framework.response import Response
from .serializers import StudentSerializes

class Student(APIView)；
	def get(self,request):
        back_dic = {
   'code':200,'msg':'成功'，'result':''}
        queryset_obj = models.Student.objects.all()
        res = StudentSerializers(instance=query_obj,many=True)
        if not res.is_valid():
            back_dic['code'] = 1001
            back_dic['msg'] = '失败'
            return Response(back_dic)
        back_dic['result'] = res.data
        return Response(back_dic)
    

此时使用postman调用接口时便可以获取到数据库内所存储的数据并数据是以json格式发送到前端

这个数据从字典或者Queryset对象转为json的操作，便是序列化类StudentSerializes做的

# Serializer的构造方法为：
Serializer(instance=None, data=empty, **kwarg)
"""
1）用于序列化时，将模型类对象传入instance参数
2）用于反序列化时，将要被反序列化的数据传入data参数
3）除了instance和data参数外，在构造Serializer对象时，还可通过context参数额外添加数据
"""
serializer = AccountSerializer(account, context={
   'request': request})
"""
1、使用序列化器的时候一定要注意，序列化器声明了以后，不会自动执行，需要我们在视图中进行调用才可以。
2、序列化器无法直接接收数据，需要我们在视图中创建序列化器对象时把使用的数据传递过来。
3、序列化器的字段声明类似于我们前面使用过的表单系统。
4、开发restful api时，序列化器会帮我们把模型数据转换成字典.
5、drf提供的视图会帮我们把字典转换成json,或者把客户端发送过来的数据转换字典.
"""

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

三、序列化器常用字段及其参数

常用字段：

字段	字段构造方式
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页面时，显示的字段帮助提示信息·1·

四、序列化器高级用法

1、source用法

from rest_framework import serializers
from .models import Student
# 定义序列化器
class StudentSerializer(serializers.Serializer):
    # 在下面写入想要序列化的字段名称
    name = serializers.CharField()
    age = serializers.IntegterField()

在上面的序列化name字段中，如果你不想让前端看到你表中实际的字段可以使用source方法，

soucre方法是当前名称映射到本表中的某个字段，这样当前名称在前端就能获取到表中映射字段的值，如下

name1