DRF框架之序列化器serializers组件详解

时间  2020-08-13
标签 drf 框架 序列 serializers 组件 详解 繁體版
原文   原文链接

序列化器-Serializer

做用：前端

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

定义序列化器

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

接下来，为了方便演示序列化器的使用，咱们先建立一个新的子应用sersgit

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

咱们想为这个模型类提供一个序列化器，能够定义以下：django

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是独立于数据库以外的存在。json

经常使用字段类型：后端

字段 字段构造方式
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=)

选项参数：api

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

通用参数：bash

参数名称 说明
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对象了。服务器

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. 序列化器的字段声明相似于咱们前面使用过的表单系统。
  4. 开发restful api时，序列化器会帮咱们把模型数据转换成字典.
  5. drf提供的视图会帮咱们把字典转换成json,或者把客户端发送过来的数据转换字典.

序列化器的使用

序列化器的使用分两个阶段：

  1. 在客户端请求时，使用序列化器能够完成对数据的反序列化。
  2. 在服务器响应时，使用序列化器能够完成对数据的序列化。

反序列化

数据验证

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

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

验证失败，能够经过序列化器对象的errors属性获取错误信息，返回字典，包含了字段和字段的错误。若是是非字段错误，能够经过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。

验证成功，能够经过序列化器对象的validated_data属性获取数据。

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

为了方便演示效果，咱们单独再次建立一个子应用unsers，。

python manage.py startapp unsers

定义序列化器，代码：

from rest_framework import serializers
class StudentSerializer(serializers.Serializer):
    # 须要转换的字段声明
    # 小括号里面声明主要提供给反序列化使用的
    name = serializers.CharField(required=True, max_length=20)
    age = serializers.IntegerField(max_value=150, min_value=0,required=True)
    sex = serializers.BooleanField(default=True)
    description = serializers.CharField(required=False,allow_null=True, allow_blank=True) #required=False,字段均可以不传递给后端，allow_null=True,容许提交过来的数据为空值(null--None)，allow_blank=True 容许提交过来的数据为空字符串
    
    # 若是序列化器调用的模型中的字段声明，则须要声明Meta类

    # 验证

    # 添加和更新代码

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

# Create your views here.
from django.http import JsonResponse
from django.views import View
from .serializers import StudentSerializer
from students.models import Student
class StudentView(View):
    def post(self,request):
        """添加一个学生"""
        # 接受参数
        post_data = request.POST
        data = {
            "name":post_data.get('name'),
            "age":post_data.get('age'),
            "sex":post_data.get('sex'),
            "description":post_data.get('description'),
        }
        # 调用序列化器进行反序列化验证和转换
        serializer = StudentSerializer(data=data)
				serializer.errors  #查看错误信息
        
        # 当验证失败时,能够直接经过声明 raise_exception=True 让django直接跑出异常,那么验证出错以后，直接就再这里报错，程序中断了就
        
        result = serializer.is_valid(raise_exception=True)
        print( "验证结果:%s" % result )

        # 获取经过验证后的数据
        print( serializer.validated_data ) # form -- clean_data
        # 保存数据
        student = Student.objects.create(
            name=serializer.validated_data.get("name"),
            age=serializer.validated_data.get("age"),
            sex=serializer.validated_data.get("sex")
        )

        print(student)
        # 返回响应结果给客户端
        # alt + enter，能够实现快速导包
        return JsonResponse({"message": "ok"})

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 StudentSerializer(serializers.Serializer):
    """学生数据序列化器"""
    ...

    # 序列化器中能够自定义单个字段的验证方法  def validate_<字段名>(用户提交的字段数据):
    def validate_name(self,data):
        if(data=="老男孩"):
            raise serializers.ValidationError("用户名不能是老男孩")

        # 验证完成之后务必要返回字段值
        return data

全局钩子

2) validate

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

class StudentSerializer(serializers.Serializer):
    """学生数据序列化器"""
    ...
		
    # 方法名时固定的,用于验证多个字段,参数就是实例化序列化器类时的data参数
    def validate(self,data):
        name = data.get("name")
        if(name == "python"):
            raise serializers.ValidationError("用户名不能是python")

        age = data.get("age")
        if(age==0):
            raise serializers.ValidationError("年龄不能是0")

        # 验证完成之后务必要返回data
        return data
3) validators

在字段中添加validators选项参数，也能够补充验证行为，如

def check_age(age):
    if age ==50:
        raise serializers.ValidationError("年龄不能恰好是50")
    return age

class StudentSerializer(serializers.Serializer):
    # 须要转换的字段声明
    # 小括号里面声明主要提供给反序列化使用的
    name = serializers.CharField(required=True, max_length=20)
    age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age])
    sex = serializers.BooleanField(default=True)
    description = serializers.CharField(required=False,allow_null=True, allow_blank=True)

反序列化——>保存数据

前面的验证数据成功后,咱们可使用序列化器来完成数据反序列化的过程.这个过程能够把数据转成模型类对象.

首先咱们能够在views中直接写上保存数据的代码

# Create your views here.
from django.http import JsonResponse
from django.views import View
from .serializers import StudentSerializer
from students.models import Student
class StudentView(View):
    def post(self,request):
        """添加一个学生"""
        # 接受参数
        post_data = request.POST
        data = {
            "name":post_data.get('name'),
            "age":post_data.get('age'),
            "sex":post_data.get('sex'),
            "description":post_data.get('description'),
        }
        serializer = StudentSerializer(data=data)
				serializer.errors  
        result = serializer.is_valid(raise_exception=True)
        print( "验证结果:%s" % result )
        print( serializer.validated_data ) 
        
        student = Student.objects.create(
            name=serializer.validated_data.get("name"),
            age=serializer.validated_data.get("age"),
            sex=serializer.validated_data.get("sex")
        )

        print(student)
        return JsonResponse({"message": "ok"})

还能够经过序列化器提供的create()和update()两个方法来实现。

from rest_framework import serializers
from students.models import Student

def check_age(age):
    if age ==50:
        raise serializers.ValidationError("年龄不能恰好是50")
    return age

class StudentSerializer(serializers.Serializer):
    # 须要转换的字段声明
    # 小括号里面声明主要提供给反序列化使用的
    name = serializers.CharField(required=True, max_length=20)
    age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age])
    sex = serializers.BooleanField(default=True)
    description = serializers.CharField(required=False,allow_null=True, allow_blank=True) #required=False,
    # 若是序列化器调用的模型中的字段声明，则须要声明Meta类

    # 验证
    # 序列化器中能够自定义单个字段的验证方法  def validate_<字段名>(用户提交的字段数据):
    def validate_name(self,data):
        if(data=="老男孩"):
            raise serializers.ValidationError("用户名不能是老男孩")

        # 验证完成之后务必要返回字段值
        return data

    # 方法名时固定的,用于验证多个字段,参数就是实例化序列化器类时的data参数
    def validate(self,data):
        name = data.get("name")
        if(name == "python"):
            raise serializers.ValidationError("用户名不能是python")

        age = data.get("age")
        if(age==0):
            raise serializers.ValidationError("年龄不能是0")

        # 验证完成之后务必要返回data
        return data

    # 添加和更新代码
    # 序列化器中会提供了两个方法: create 和 update,方法名是固定的
    def create(self, validated_data): # validated_data 参数,在序列化器调用时,会自动传递验证完成之后的数据
        student = Student.objects.create(
            name=self.validated_data.get("name"),
            age=self.validated_data.get("age"),
            sex=self.validated_data.get("sex")
        )

        return student

    def update(self,instance,validated_data): #instance表示当前更新的记录对象
        """更新学生信息"""
        instance.name=validated_data.get("name")
        instance.sex=validated_data.get("sex")
        instance.age=validated_data.get("age")
        instance.description=validated_data.get("description")
        # 调用模型的save更新保存数据
        instance.save()

        return instance

实现了上述两个方法后，在视图中调用序列化器进行反序列化数据的时候，就能够经过save()方法返回一个数据对象实例了

student = serializer.save()  #若是是添加，自动会调用create，更新就自动调用update

视图代码：

# Create your views here.
from django.http import JsonResponse
from django.views import View
from .serializers import StudentSerializer
from students.models import Student
class StudentView(View):
    def post(self,request):
        """添加一个学生"""
        
        ....


    def put(self,request):
        """更新学生信息"""
        # 接受参数
        data = {
            "id":9,
            "name":"abc",
            "age":18,
            "sex":1,
            "description":"测试",
        }
        # 获取要修改的数据
        instance = Student.objects.get(pk=data.get("id"))
        # 调用序列化器
        serializer = StudentSerializer(instance=instance,data=data)
        # 验证
        serializer.is_valid(raise_exception=True)
        # 转换成模型数据
        student = serializer.save()

        return JsonResponse({"message": "ok"})

若是建立序列化器对象的时候，没有传递instance实例，则调用save()方法的时候，create()被调用，相反，若是传递了instance实例，则调用save()方法的时候，update()被调用。

附加说明

1） 在对序列化器进行save()保存时，能够额外传递数据，这些数据能够在create()和update()中的validated_data参数获取到

# request.user 是django中记录当前登陆用户的模型对象

serializer.save(owner=user)

2）默认序列化器必须传递全部required的字段，不然会抛出验证异常。可是咱们可使用partial参数来容许部分字段更新

# 更新学生的部分字段信息，当数据库容许为空，可是序列化器要求必须字段填写的时候，可使用如下方式避开
serializer = StudentSerializer(instance=instance, data=data, partial=True)

把上面序列化器子应用sers和反序列化器子应用unsers里面的序列化器进行对比。

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()
from rest_framework import serializers
from students.models import Student

def check_age(age):
   if age ==50:
       raise serializers.ValidationError("年龄不能恰好是50")
   return age

class StudentSerializer(serializers.Serializer):
   # 须要转换的字段声明
   # 小括号里面声明主要提供给反序列化使用的
   name = serializers.CharField(required=True, max_length=20)
   age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age])
   sex = serializers.BooleanField(default=True)
   description = serializers.CharField(required=False, allow_null=True, allow_blank=True)
   # 若是序列化器调用的模型中的字段声明，则须要声明Meta类

   # 验证
   # 序列化器中能够自定义单个字段的验证方法  def validate_<字段名>(用户提交的字段数据):
   def validate_name(self,data):
       if(data=="老男孩"):
           raise serializers.ValidationError("用户名不能是老男孩")

       # 验证完成之后务必要返回字段值
       return data

   # 方法名时固定的,用于验证多个字段,参数就是实例化序列化器类时的data参数
   def validate(self,data):
       name = data.get("name")
       if(name == "python"):
           raise serializers.ValidationError("用户名不能是python")

       age = data.get("age")
       if(age==0):
           raise serializers.ValidationError("年龄不能是0")

       # 验证完成之后务必要返回data
       return data

   # 添加和更新代码
   # 序列化器中会提供了两个方法: create 和 update,方法名是固定的
   def create(self, validated_data): # validated_data 参数,在序列化器调用时,会自动传递验证完成之后的数据
       student = Student.objects.create(
           name=self.validated_data.get("name"),
           age=self.validated_data.get("age"),
           sex=self.validated_data.get("sex")
       )

       return student

   def update(self,instance,validated_data):
       """更新学生信息"""
       instance.name=validated_data.get("name")
       instance.sex=validated_data.get("sex")
       instance.age=validated_data.get("age")
       instance.description=validated_data.get("description")
       # 调用模型的save更新保存数据
       instance.save()

       return instance

能够发现，反序列化器中的代码会包含了序列化器中的大部分代码，除了ID字段的声明。

因此在开发的时候，咱们通常都是直接写在一块儿，那么有些字段只会出如今序列化器阶段，例如ID。还有些字段只会出如今反序列化阶段，例如：用户密码。

那么， 咱们须要在序列化器类中，声明那些字段是在序列化时使用，哪些字段在反序列化中使用了。

最终序列化器中的代码：

from rest_framework import serializers
from students.models import Student

def check_age(age):
    if age ==50:
        raise serializers.ValidationError("年龄不能恰好是50")
    return age

class StudentSerializer(serializers.Serializer):
    # 须要转换的字段声明
    # 小括号里面声明主要提供给反序列化使用的
    id=serializers.IntegerField(read_only=True)  #read_only=True读取数据时能读出来，反序列化校验数据的时候不须要校验。
    name = serializers.CharField(required=True, max_length=20)
    age = serializers.IntegerField(max_value=150, min_value=0,required=True,validators=[check_age])
    sex = serializers.BooleanField(default=True,write_only=True)#write_only=True读取数据时不能读出来。可是反序列化校验数据保存时，须要传给咱们的序列化器
    description = serializers.CharField(required=True, allow_null=True, allow_blank=True)
    # 若是序列化器调用的模型中的字段声明，则须要声明Meta类

    # 验证
    # 序列化器中能够自定义单个字段的验证方法  def validate_<字段名>(用户提交的字段数据):
    def validate_name(self,data):
        if(data=="老男孩"):
            raise serializers.ValidationError("用户名不能是老男孩")

        # 验证完成之后务必要返回字段值
        return data

    # 方法名时固定的,用于验证多个字段,参数就是实例化序列化器类时的data参数
    def validate(self,data):
        name = data.get("name")
        if(name == "python"):
            raise serializers.ValidationError("用户名不能是python")

        age = data.get("age")
        if(age==0):
            raise serializers.ValidationError("年龄不能是0")

        # 验证完成之后务必要返回data
        return data

    # 添加和更新代码
    # 序列化器中会提供了两个方法: create 和 update,方法名是固定的
    def create(self, validated_data): # validated_data 参数,在序列化器调用时,会自动传递验证完成之后的数据
        student = Student.objects.create(
            name=self.validated_data.get("name"),
            age=self.validated_data.get("age"),
            sex=self.validated_data.get("sex")
        )

        return student

    def update(self,instance,validated_data):
        """更新学生信息"""
        instance.name=validated_data.get("name")
        instance.sex=validated_data.get("sex")
        instance.age=validated_data.get("age")
        instance.description=validated_data.get("description")
        # 调用模型的save更新保存数据
        instance.save()

        return instance

模型类序列化器

若是咱们想要使用序列化器对应的是Django的模型类，DRF为咱们提供了ModelSerializer模型类序列化器来帮助咱们快速建立一个Serializer类。

ModelSerializer与常规的Serializer相同，但提供了：

  • 基于模型类自动生成一系列字段
  • 基于模型类自动为Serializer生成validators，好比unique_together
  • 包含默认的create()和update()的实现

定义

为了方便学习和查看效果， 新建一个子应用msers。

python manage.py startapp msers

好比咱们建立一个StudentModelSerializer

from rest_framework import serializers
from students.models import Student
class StudentModelSerializer(serializers.ModelSerializer):
    # 字段声明

    # 若是模型类序列化器,必须声明本次调用是哪一个模型,模型里面的哪些字段
    class Meta:
        model = Student
        fields = ["id","name","age","description","sex"]
        # fields = "__all__" # 表示操做模型中的全部字段
        # 添加额外的验证选项
        exclude = ['id',] # 排除字段
        extra_kwargs = {
            "sex":{"write_only":True,},
            "id":{"read_only":True,}
        }
  • model 指明参照哪一个模型类
  • fields 指明为模型类的哪些字段生成

指定字段

  1. 使用fields来明确字段，__all__表名包含全部字段，也能够写明具体哪些字段，如
class StudentModelSerializer(serializers.ModelSerializer):
    """学生数据序列化器"""
    class Meta:
        model = Student
        fields = ['id', 'age', 'name',"description"]
  1. 使用exclude能够明确排除掉哪些字段
class StudentModelSerializer(serializers.ModelSerializer):
    """学生数据序列化器"""
    class Meta:
        model = Student
        exclude = ['sex']
  1. 指明只读字段[少用,经过extra_kwargs更方便一些],

能够经过read_only_fields指明只读字段，即仅用于序列化输出的字段

class StudentModelSerializer(serializers.ModelSerializer):
    """学生数据序列化器"""
    class Meta:
        model = Student
        fields = ['id', 'age', 'name',"description"]
        read_only_fields = ('id',)
        #write_only_fields = ('sex',)

添加额外参数

咱们可使用extra_kwargs参数为ModelSerializer添加或修改原有的选项参数

from rest_framework import serializers
from students.models import Student
class StudentModelSerializer(serializers.ModelSerializer):
    # 额外字段声明,必须在fields里面也要声明上去,不然序列化器不会调用
    # password2 = serializers.CharField(write_only=True,required=True)

    # 若是模型类序列化器,必须声明本次调用是哪一个模型,模型里面的哪些字段
    class Meta:
        model = Student
        # fields = ["id","name","age","description","sex","password2"]
        fields = ["id","name","age","description","sex"]
        # fields = "__all__" # 表示操做模型中的全部字段
        # 添加额外的验证选项，好比额外的字段验证
        extra_kwargs = {
            "sex":{"write_only":True,},
            "id":{"read_only":True,}
        }

    # 验证代码

    # 也能够从新声明一个create和update

简单作个示例

class StudentViewSet(View):

    def post(self,request):

        data = request.POST
        serializers = StudentsSerializer(data=data)

        status = serializers.is_valid()
        # print(status)
        # print(serializers.validated_data)
        student = serializers.save()  #上面使用的ModelSerializer，因此不须要咱们本身写create方法了
        print(student)
        return JsonResponse({'msg':'henhao'})

上面只演示了添加操做，更新操做自行测试吧

何时继承序列化器类Serializer，何时继承模型序列化器类ModelSerializer？主要仍是看哪一个更适合你的应用场景

继承序列化器类Serializer
	字段声明
	验证
	添加/保存数据功能
继承模型序列化器类ModelSerializer
	字段声明[可选,看须要]
	Meta声明
	验证
	添加/保存数据功能[可选]

看表字段大小，看使用哪一个更加节省代码了。

相关文章
相关标签/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公众号
   欢迎关注本站公众号,获取更多信息
联系我们 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程