4.序列化器-Serializer

序列化器-Serializer

作用：

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

1. 定义序列化器

models.py

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
class StudentSerializer(serializers.Serializer):
    """学生信息序列化器"""
    # 1. 需要进行数据转换的字段
    id = serializers.IntegerField()
    name = serializers.CharField()
    age = serializers.IntegerField()
    sex = serializers.BooleanField()
    description = serializers.CharField()
    
    # 2.编写添加和更新模型的代码
    def create(self, validated_data):
        pass
    def update(self, instance, validated_data):
        pass
    # 3. 验证代码(反序列化时使用)

    

注意：

1.serializer不是只能为数据库模型类定义,也可以为非数据库模型类的数据定义.

2.创建Serializer对象

Serializer的构造方法为：

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

说明：

参数名	含义
instance	用于序列化时,将模型类对象传入
data	用于反序列化时,将要被反序列化的数据传入
context	额外添加数据serializer = AccountSerializer(account, context={'request': request})通过context参数附加的数据,可以通过Serializer对象的context属性获取。
many	当instance参数为模型列表则many的值必须是True

1. 序列化器需要在视图中手动调用
2. 使用序列化器时需要把数据传递过来
3. 序列化器的字段声明类表单系统。

3.序列化器的使用

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

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

3.1 序列化

1） 先查询出一个学生对象

from students.models import Student
student = Student.objects.get(id=3)

2） 构造序列化器对象

from .serializers import StudentSerializer
serializer = StudentSerializer(instance=student)

3）获取序列化数据

通过data属性可以获取序列化后的数据

serializer.data
# {'id': 4, 'name': '小张', 'age': 18, 'sex': True, 'description': '猴赛雷'}

4)完整视图代码：

urls.py

from . import views
urlpatterns = [
    re_path("student/(?P<pk>[0-9]{4})", views.StudentView.as_view())
]

views.py

from django.views import View
from students.models import Student
from .serializers import StudentSerializer
from django.http.response import JsonResponse
class StudentView(View):
    """使用序列化器序列化转换单个模型数据"""
    def get(self,request,pk):
        # 获取数据
        student = Student.objects.get(pk=pk)
        # 数据转换[序列化过程]
        serializer = StudentSerializer(instance=student)
        print(serializer.data)
        # 响应数据
        return JsonResponse(serializer.data)

5）如果要被序列化的是包含多条数据的查询集QuerySet，可以通过添加many=True参数补充说明

urls.py

from . import views
urlpatterns = [
    path("student/", views.StudentView.as_view())
]

view.py

    """使用序列化器序列化转换多个模型数据"""
    def get(self,request):
        # 获取数据
        student_list = Student.objects.all()

        # 转换数据[序列化过程]
        # 如果转换多个模型对象数据，则需要加上many=True
        serializer = StudentSerializer(instance=student_list,many=True)
        print( serializer.data ) # 序列化器转换后的数据

        # 响应数据给客户端
        # 返回的json数据，如果是列表，则需要声明safe=False
        return JsonResponse(serializer.data,safe=False)
    
    
    # 访问结果：
    # [OrderedDict([('id', 1), ('name', 'xiaoming'), ('age', 20), ('sex', True), ('description', '测试')]), OrderedDict([('id', 2), ('name', 'xiaohui'), ('age', 22), ('sex', True), ('description', '后面来的测试')]), OrderedDict([('id', 4), ('name', '小张'), ('age', 18), ('sex', True), ('description', '猴赛雷')])]

3.2 反序列化

3.2.1 数据验证

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

mysite/urls.py

path("drf/", include("students.urls")),

students/urls

from django.urls import path
from . import views

urlpatterns = [
    path("student/", views.StudentView.as_view())
]

students/serializers.py

#反序列验证方法三:
def check_sex_value(data):
    # 字段验证函数
    if data not in [1, 0]:
        raise serializers.ValidationError("sex value only have 1 and 0")


class StudentSerializer(serializers.Serializer):
    id = serializers.IntegerField(label="ID", read_only=True)
    name = serializers.CharField(label="名称", max_length=20, required=True)
    #反序列验证方法三
    sex = serializers.IntegerField(label="性别", required=False, allow_null=True, validators=[check_sex_value])
    age = serializers.IntegerField(label="年龄", required=True)
    class_num = serializers.CharField(label="班级编号", required=False)
    description = serializers.CharField(required=False, allow_null=True, allow_blank=True)
	
    #反序列验证方法一:
    def validate_name(self, attr):
        print(f"attr:{attr}")
        if attr == "老鹰":
            raise serializers.ValidationError("对不起你太凶了")
        return attr
	#反序列验证方法二:
    def validate(self, attrs):
        print(attrs)
        if attrs.get("age") > 60 and attrs.get("sex") == 1:
            raise serializers.ValidationError("对不起男人的年龄不能超过60")
        return attrs

students/views.py

class StudentView(View):
    def get(self, request):
        student = Student.objects.all()
        #通过构造序列化器对象,并将要反序列化的数据传递给data构造参数,进而进行验证
        serializer = StudentSerializer(instance=student, many=True)
        print(serializer.data)
        return JsonResponse(serializer.data, safe=False)

    def post(self, request):
        print(request.body)
        data = json.loads(request.body)
        serializer = StudentSerializer(data=data)
        #raise_exception=True验证失败时抛出异常serializers.ValidationError
        #会向前端返回HTTP 400 Bad Request响应
        result=serializer.is_valid(raise_exception=True)
        print(f"成功:{result}")
        print(f"成功数据:{serializer.validated_data()}")
        print(f"失败:{serializer.errors}")
        return HttpResponse("ok")

1	2
反序列验证方法一	validate_字段名,对<field_name>字段进行验证
反序列验证方法一	validate,同时对多个字段进行比较验证时
反序列验证方法三	validators在字段中添加validators选项参数,补充验证行为

3.2.2 数据保存和更新

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

可以通过实现create()和update()两个方法来实现。

students/serializer.py

class StudentSerializer(serializers.Serializer):
    id = serializers.IntegerField(label="ID", read_only=True)
    name = serializers.CharField(label="名称", max_length=20, required=True)
    sex = serializers.IntegerField(label="性别", required=False, allow_null=True, validators=[check_sex_value])
    age = serializers.IntegerField(label="年龄", required=True)
    class_num = serializers.CharField(label="班级编号", required=False)
    description = serializers.CharField(required=False, allow_null=True, allow_blank=True)

    @staticmethod
    def validate_name(attr):
        if attr == "老鹰":
            raise serializers.ValidationError("对不起你太凶了")
        return attr

    def validate(self, attrs):
        if attrs.get("age") > 60 and attrs.get("sex") == 1:
            raise serializers.ValidationError("对不起男人的年龄不能超过60")
        return attrs

    def create(self, validated_data):
        return Student.objects.create(**validated_data)

    def update(self, instance, validated_data):
        instance.name = validated_data.get("name", instance.name)
        instance.sex = validated_data.get("sex", instance.sex)
        instance.age = validated_data.get("age", instance.age)
        instance.class_num = validated_data.get("class_num", instance.class_num)
        instance.description = validated_data.get("description", instance.description)
        instance.save()
        return instance

students/views.py

class StudentView(View):
    def get(self, request):
        student = Student.objects.all()
        serializer = StudentSerializer(instance=student, many=True)
        print(serializer.data)
        return JsonResponse(serializer.data, safe=False)

    def post(self, request):
        print(request.body)
        data = json.loads(request.body)
        serializer = StudentSerializer(data=data)
        print(f"成功:{serializer.is_valid(raise_exception=True)}")
        print(f"失败:{serializer.errors}")
        serializer.save()
        return HttpResponse("生成新数据成功")

    def put(self, request):
        print(request.body)
        data = json.loads(request.body)
        put_id = data.get("id")
        student = Student.objects.get(pk=put_id)
        # 使用partial参数来允许部分字段更新,即使存在required字段没有提交也不会抛出异常
        serializer = StudentSerializer(instance=student, data=data, partial=True)
        serializer.is_valid(raise_exception=True)
        # save中传递的关键字参数在create,和update方法中也可以获取
        data=serializer.save()#save()方法可以返回一个数据对象实例
        return HttpResponse("更新完成")

实现了上述两个方法后，在反序列化数据的时候，就可以通过save()方法返回一个数据对象实例了

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

3.3 模型类序列化器

如果想为Django的模型类提供序列化器可以使用ModelSerializer模型类快速创建一个Serializer类

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

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

class StudentModel2Serializer(serializers.ModelSerializer):
    class Meta:
        model = Student
        fields = ("id", "name", "sex", "age", "class_num")
        exclude = ("description",)
        read_only_fields = ('id',)
        extra_kwargs = {
            "id": { "required": True},
            "name": {"required": True},
            "age": {"max_value": 60, "required": True}
        }

class Student2ViewSet(View):
    def get(self):
        student = Student.objects.all()
        serializer = StudentModel2Serializer(instance=student, many=True)
        print(serializer.data)
        return JsonResponse(serializer.data, safe=False)

    def post(self, request):
        print(request.body)
        data = json.loads(request.body)
        serializer = StudentModel2Serializer(data=data)
        serializer.is_valid(raise_exception=True)
        serializer.save()
        return HttpResponse(serializer.data)

字段说明

字段名	含义
model	指明需要声明调用的模型类
fields	指明为模型类的哪些字段生成__all__表名包含所有字段，也可以写明具体哪些字段
exclude	明确排除掉哪些字段
read_only_fields	指明只读字段，即仅用于序列化输出
extra_kwarg	为ModelSerializer添加或修改原有的选项参数

3.4 序列化器参考

1.常用字段类型：

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

2.选项参数

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

3.通用参数

参数名称	说明
read_only	表明该字段仅用于序列化输出,默认False
write_only	表明该字段仅用于反序列化输入,默认False
required	表明该字段在反序列化时必须输入,默认True
default	反序列化时使用的默认值
allow_null	表明该字段是否允许传入None,默认False
validators	该字段使用的验证器
error_messages	包含错误编号与错误信息的字典
label	用于HTML展示API页面时，显示的字段名称
help_text	用于HTML展示API页面时，显示的字段帮助提示信息