序列化器-Serializer
-
作用:
- 1.序列化,序列化器会把模型对象转换成字典,经过response以后变成json字符串
- 2.反序列化,把客户端发送过来的数据,经过request以后变成字典,序列化器可以把字典转成模型
- 3.反序列化,完成数据校验功能
定义序列化器
Django REST framework中的Serializer使用类来定义,须继承自rest_framework.serializers.Serializer
。
接下来,为了方便演示序列化器的使用,我们先创建一个新的子应用ser
我们为这个模型类提供一个序列化器serializers.py
,可以定义如下:
from rest_framework import serializers
# 所有的自定义序列化器必须直接或间接继承于 serializers.Serializer
class StudentSerializer(serializers.Serializer):
# 声明序列化器
# 1. 字段声明[ 要转换的字段,当然,如果写了第二部分代码,有时候也可以不用写字段声明 ]
id = serializers.IntegerField()
name = serializers.CharField()
sex = serializers.BooleanField()
age = serializers.IntegerField()
class_null = serializers.CharField()
description = serializers.CharField()
# 2. 可选[ 如果序列化器继承的是ModelSerializer,则需要声明对应的模型和字段, ModelSerializer是Serializer的子类 ]
# 3. 可选[ 用于对客户端提交的数据进行验证 ]
# 4. 可选[ 用于把通过验证的数据进行数据库操作,保存到数据库 ]
注意: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页面时,显示的字段帮助提示信息 |
创建Serializer对象
定义好Serializer类后,就可以创建Serializer对象了。
Serializer的构造方法为:
Serializer(instance=None, data=empty, **kwarg)
说明:
1)用于序列化时,将模型类对象传入instance参数
2)用于反序列化时,将要被反序列化的数据传入data参数
3)除了instance和data参数外,在构造Serializer对象时,还可通过context参数额外添加数据
如 : serializer = StudentSerializer(student, context={'request': request})
通过context参数附加的数据,可以通过Serializer对象的context属性获取。
声明:
使用序列化器的时候一定要注意,序列化器声明了以后,不会自动执行,需要我们在视图中进行调用才可以。
序列化器无法直接接收数据,需要我们在视图中创建序列化器对象时把使用的数据传递过来。
序列化器的字段声明类似于我们前面使用过的表单系统。
开发restful api时,序列化器会帮我们把模型数据转换成字典.
drf提供的视图会帮我们把字典转换成json,或者把客户端发送过来的数据转换字典.
序列化器的使用
-
序列化器的使用分两个阶段(来反去序):
- 在客户端 请求时,使用序列化器可以完成对数据的 反序列化。
- 在服务器 响应时,使用序列化器可以完成对数据的 序列化。
序列化
- 总路由中的
urls.py
:
from django.contrib import admin
from django.urls import path, include
urlpatterns = [
path('admin/', admin.site.urls),
path('drf/', include("students.urls")),
path('ser/', include("ser.urls")),
]
- ser应用下的
ser/urls.py
文件:
from django.urls import path, re_path
from . import views
urlpatterns = [
re_path(r"^student/(?P<pk>\d+)/$", views.Student1View.as_view()),
]
- ser应用下的
ser/views.py
文件:
from django.http import JsonResponse
from django.views import View
from students.models import Student
from .serializers import StudentSerializer
class Student1View(View):
"""使用序列化器进行数据的序列化操作"""
"""序列化器转换一条数据[模型转换成字典]"""
def get(self, request, pk):
# 接收客户端传过来的参数,进行过滤查询,先查出学生对象
student = Student.objects.get(pk=pk)
# 转换数据类型
# 1.实例化序列化器类
"""
StudentSerializer(instance=模型对象或者模型列表,客户端提交的数据,额外要传递到序列化器中使用的数据)
"""
serializer = StudentSerializer(instance=student)
# 2.查看序列化器的转换结果
print(serializer.data)
return JsonResponse(serializer.data)
如果要被序列化的是包含多条数据的查询集QuerySet
,可以通过添加many=True
参数补充说明。代码如下:
- ser应用下的
ser/urls.py
文件:
from django.urls import path, re_path
from . import views
urlpatterns = [
path("students/", views.Student2View.as_view()),
re_path(r"^student/(?P<pk>\d+)/$", views.Student1View.as_view()),
]
- ser应用下的
ser/views.py
文件:
class Student2View(View):
"""序列化器转换多条数据[模型转换成字典]"""
def get(self, request):
student_list = Student.objects.all()
# 序列化器转换多个数据
# many=True 表示本次序列化器转换如果有多个模型对象列参数,则必须声明 Many=True
serializer = StudentSerializer(instance=student_list, many=True)
print(serializer.data) # OrderedDict类型
return JsonResponse(serializer.data, safe=False) # 非Dict类型 需更改safe
反序列化-数据校验
使用序列化器进行反序列化时,需要对数据进行验证后,才能获取验证成功的数据或保存成模型类对象。
-
调用is_valid()方法进行验证,验证成功返回True,否则返回False。
-
- 验证失败,可以通过序列化器对象的errors属性获取错误信息,返回字典,包含了字段和字段的错误。is_valid()方法还可以在验证失败时抛出异常
serializers.ValidationError
,可以通过传递raise_exception=True
参数开启。
- 验证失败,可以通过序列化器对象的errors属性获取错误信息,返回字典,包含了字段和字段的错误。is_valid()方法还可以在验证失败时抛出异常
-
- 验证成功,可以通过序列化器对象的
validated_data
属性获取数据。
- 验证成功,可以通过序列化器对象的
在drf中,对于客户端提供的数据,往往需要验证数据的有效性,这部分代码是写在序列化器中的。
在序列化器中,已经提供三个地方给我们针对客户端提交的数据进行验证。
- 内置选项,字段声明的小圆括号中,以选项存在作为验证提交
- 自定义方法,在序列化器中作为对象方法来提供验证[ 这部分验证的方法,必须以
validate_<字段>
或者validate
作为方法名 - 自定义函数,在序列化器外部,提前声明一个验证代码,然后在字段声明的小圆括号中,通过
validators=[验证函数1,验证函数2...]
在定义序列化器时,指明每个字段的序列化类型和选项参数,本身就是一种验证行为。
- ser应用下的
serializers.py
文件:
def check_user(data):
if data == "oldboy":
raise serializers.ValidationError("用户名不能为oldboy!")
return data
class Student3Serializer(serializers.Serializer):
# 声明序列化器
# 1. 字段声明[ 要转换的字段,当然,如果写了第二部分代码,有时候也可以不用写字段声明 ]
name = serializers.CharField(max_length=10, min_length=4, validators=[check_user])
sex = serializers.BooleanField(required=True)
age = serializers.IntegerField(max_value=150, min_value=0)
# 2. 可选[ 如果序列化器继承的是ModelSerializer,则需要声明对应的模型和字段, ModelSerializer是Serializer的子类 ]
# 3. 可选[ 用于对客户端提交的数据进行验证 ]
"""验证单个字段值的合法性"""
def validate_name(self, data):
if data == "root":
raise serializers.ValidationError("用户名不能为root!")
return data
def validate_age(self, data):
if data < 18:
raise serializers.ValidationError("年龄不能小于18")
return data
"""验证多个字段值的合法性"""
def validate(self, attrs):
name = attrs.get('name')
age = attrs.get('age')
if name == "alex" and age == 22:
raise serializers.ValidationError("alex在22时的故事。。。")
return attrs
- ser应用下的
urls.py
文件:
urlpatterns = [
path("students/", views.Student2View.as_view()),
re_path(r"^student/(?P<pk>\d+)/$", views.Student1View.as_view()),
# 对数据提交时,进行校验
path('student3/', views.Student3View.as_view()),
]
- ser应用下的
views.py
文件:
class Student3View(View):
def post(self, request):
data = request.body.decode()
# 反序列化用户提交的数据
data_dict = json.loads(data)
print(data_dict)
# 调用序列化器进行实例化
serializer = Student3Serializer(data=data_dict)
# is_valid在执行的时候,会自动先后调用 字段的内置选项,自定义验证方法,自定义验证函数
# 调用序列化器中写好的验证代码
# raise_exception=True 抛出验证错误信息,并阻止代码继续往后运行
# 验证结果
print(serializer.is_valid(raise_exception=True))
# 获取验证后的错误信息
print(serializer.errors)
# 获取验证后的客户端提交的数据
print(serializer.validated_data)
# return HttpResponse(serializer.validated_data)
return JsonResponse(serializer.validated_data)
验证失败(raise_exception=False
):
raise_exception=True
时,直接抛异常:
验证成功:
反序列化-保存数据
前面的验证数据成功后,我们可以使用序列化器来完成数据反序列化的过程.这个过程可以把数据转成模型类对象.
可以通过在序列化器中实现create()
和update()
两个方法来实现。
复制代码
- ser应用下的
serializers.py
文件:
class Student3Serializer(serializers.Serializer):
# 声明序列化器
# 1. 字段声明[ 要转换的字段,当然,如果写了第二部分代码,有时候也可以不用写字段声明 ]
name = serializers.CharField(max_length=10, min_length=4, validators=[check_user])
sex = serializers.BooleanField(required=True)
age = serializers.IntegerField(max_value=150, min_value=0)
# 2. 可选[ 如果序列化器继承的是ModelSerializer,则需要声明对应的模型和字段, ModelSerializer是Serializer的子类 ]
# 3. 可选[ 用于对客户端提交的数据进行验证 ]
"""验证单个字段值的合法性"""
def validate_name(self, data):
if data == "root":
raise serializers.ValidationError("用户名不能为root!")
return data
def validate_age(self, data):
if data < 18:
raise serializers.ValidationError("年龄不能小于18")
return data
"""验证多个字段值的合法性"""
def validate(self, attrs):
name = attrs.get('name')
age = attrs.get('age')
if name == "alex" and age == 22:
raise serializers.ValidationError("alex在22时的故事。。。")
return attrs
# 4. 可选[ 用于把通过验证的数据进行数据库操作,保存到数据库 ]
def create(self, validated_data):
"""接受客户端提交的新增数据"""
name = validated_data.get('name')
age = validated_data.get('age')
sex = validated_data.get('sex')
instance = Student.objects.create(name=name, age=age, sex=sex)
# instance = Student.objects.create(**validated_data)
print(instance)
return instance
def update(self, instance, validated_data):
"""用于在反序列化中对于验证完成的数据进行保存更新"""
name = validated_data.get('name')
age = validated_data.get('age')
sex = validated_data.get('sex')
instance.name = name
instance.age = age
instance.sex = sex
instance.save()
return instance
实现了上述两个方法后,在反序列化数据的时候,就可以通过save()
方法返回一个数据对象实例了
- ser应用下
serializers.py
文件:
class Student3View(View):
def post(self, request):
data = request.body.decode()
# 反序列化用户提交的数据
data_dict = json.loads(data)
print(data_dict)
# 调用序列化器进行实例化
serializer = Student3Serializer(data=data_dict)
# is_valid在执行的时候,会自动先后调用 字段的内置选项,自定义验证方法,自定义验证函数
# 调用序列化器中写好的验证代码
# raise_exception=True 抛出验证错误信息,并阻止代码继续往后运行
# 验证结果
print(serializer.is_valid(raise_exception=True))
# 获取验证后的错误信息
print(serializer.errors)
# 获取验证后的客户端提交的数据
print(serializer.validated_data)
# save 表示让序列化器开始执行反序列化代码。create和update的代码
serializer.save()
# return HttpResponse(serializer.validated_data)
return JsonResponse(serializer.validated_data)
如果创建序列化器对象的时候,没有传递instance
实例,则调用save()
方法的时候,create()
被调用;
相反,如果传递了instance
实例,则调用save()
方法的时候,update()
被调用。
- ser应用下
serializers.py
文件:
class Student4View(View):
def put(self, request, pk):
data = request.body.decode()
import json
data_dict = json.loads(data)
student_obj = Student.objects.get(pk=pk)
# 有instance参数,调用save方法,就会调用update方法。
serializer = Student3Serializer(instance=student_obj, data=data_dict)
serializer.is_valid(raise_exception=True)
serializer.save() # 触发序列器中的update方法
return JsonResponse(serializer.validated_data)
- ser应用下的
urls.py
文件:
urlpatterns = [
path("students/", views.Student2View.as_view()),
re_path(r"^student/(?P<pk>\d+)/$", views.Student1View.as_view()),
# 对数据提交时,进行校验
path('student3/', views.Student3View.as_view()),
# 反序列化阶段
re_path(r'^student4/(?P<pk>\d+)/$', views.Student4View.as_view()),
]
序列化与反序列化合并使用
开发中往往一个资源的序列化和反序列化阶段都是写在一个序列化器中的
所以我们可以把上面的两个阶段合并起来,以后我们再次写序列化器,则直接按照以下风格编写即可。
- ser应用下
serializers.py
文件:
class Student5Serializer(serializers.Serializer):
id = serializers.IntegerField(read_only=True)
name = serializers.CharField(max_length=10, min_length=4, validators=[check_user])
sex = serializers.BooleanField(required=True)
age = serializers.IntegerField(max_value=150, min_value=0)
class_null = serializers.CharField(read_only=True)
description = serializers.CharField(read_only=True)
# 2. 可选[ 如果序列化器继承的是ModelSerializer,则需要声明对应的模型和字段, ModelSerializer是Serializer的子类 ]
# 3. 可选[ 用于对客户端提交的数据进行验证 ]
"""验证单个字段值的合法性"""
def validate_name(self, data):
if data == "root":
raise serializers.ValidationError("用户名不能为root!")
return data
def validate_age(self, data):
if data < 18:
raise serializers.ValidationError("年龄不能小于18")
return data
"""验证多个字段值的合法性"""
def validate(self, attrs):
name = attrs.get('name')
age = attrs.get('age')
if name == "alex" and age == 22:
raise serializers.ValidationError("alex在22时的故事。。。")
return attrs
# 4. 可选[ 用于把通过验证的数据进行数据库操作,保存到数据库 ]
def create(self, validated_data):
"""接受客户端提交的新增数据"""
name = validated_data.get('name')
age = validated_data.get('age')
sex = validated_data.get('sex')
instance = Student.objects.create(name=name, age=age, sex=sex)
# instance = Student.objects.create(**validated_data)
print(instance)
return instance
def update(self, instance, validated_data):
"""用于在反序列化中对于验证完成的数据进行保存更新"""
name = validated_data.get('name')
age = validated_data.get('age')
sex = validated_data.get('sex')
instance.name = name
instance.age = age
instance.sex = sex
instance.save()
return instance
- 在ser应用下
urls.py
文件:
urlpatterns = [
path("students/", views.Student2View.as_view()),
re_path(r"^student/(?P<pk>\d+)/$", views.Student1View.as_view()),
# 对数据提交时,进行校验
path('student3/', views.Student3View.as_view()),
# 反序列化阶段
re_path(r'^student4/(?P<pk>\d+)/$', views.Student4View.as_view()),
# 一个序列化器同时实现序列化和反序列化
path('student5/', views.Student5View.as_view()),
]
- 在ser应用下
views.py
文件:
class Student5View(View):
def get(self, request):
# 获取所有数据
student_list = Student.objects.all()
serializer = Student5Serializer(instance=student_list, many=True)
return JsonResponse(serializer.data, safe=False)
def post(self, request):
data = request.body.decode()
data_dict = json.loads(data)
serializer = Student5Serializer(data=data_dict)
serializer.is_valid(raise_exception=True)
instance = serializer.save()
return JsonResponse(serializer.data)
- 补全
PUT
:
class Student5View(View):
def get(self, request,pk):
# 获取所有数据
student_list = Student.objects.all()
serializer = Student5Serializer(instance=student_list, many=True)
return JsonResponse(serializer.data, safe=False)
def post(self, request,pk):
data = request.body.decode()
data_dict = json.loads(data)
serializer = Student5Serializer(data=data_dict)
serializer.is_valid(raise_exception=True)
instance = serializer.save()
return JsonResponse(serializer.data)
def put(self, request, pk):
data = request.body.decode()
import json
data_dict = json.loads(data)
student_obj = Student.objects.get(pk=pk)
# 有instance参数,调用save方法,就会调用update方法。
serializer = Student5Serializer(instance=student_obj, data=data_dict)
serializer.is_valid(raise_exception=True)
serializer.save() # 触发序列器中的update方法
return JsonResponse(serializer.validated_data)
更改url
# path('student5/', views.Student5View.as_view())
re_path(r'^student5/(?P<pk>\d+)*/*$', views.Student5View.as_view()),
模型类序列化器
如果我们想要使用序列化器对应的是Django的模型类,DRF为我们提供了ModelSerializer模型类序列化器来帮助我们快速创建一个Serializer类。
我们可以使用ModelSerializer
来完成模型类序列化器的声明
-
这种基于ModelSerializer声明序列化器的方式有三个优势:
-
- 可以直接通过声明当前序列化器中指定的模型中把字段声明引用过来
-
- ModelSerializer是继承了Serializer的所有功能和方法,同时还编写update和create
-
- 模型中同一个字段中关于验证的选项,也会被引用到序列化器中一并作为选项参与验证
- 在ser应用下
serializers.py
文件定义模型类序列化器:
class StudentModelSerializer(serializers.ModelSerializer):
# age = serializers.IntegerField(max_value=150, min_value=0)
class Meta:
model = Student
# fields = "__all__" # 表示引用所有字段
fields = ["id", "name", "age", "class_null", "is_18"] # is_18 为自定制字段,需要在models里自定义方法。
# exclude = ["age"] # 使用exclude可以明确排除掉哪些字段, 注意不能和fields同时使用。
# 传递额外的参数,为ModelSerializer添加或修改原有的选项参数
extra_kwargs = {
"name": {"max_length": 10, "min_length": 4, "validators": [check_user]},
"age": {"max_value": 150, "min_value": 0},
}
# 对单个字段进行的校验
def validate_name(self, data):
if data == "root":
raise serializers.ValidationError("用户名不能为root!")
return data
# 对多个字段进行的校验
def validate(self, attrs):
name = attrs.get('name')
age = attrs.get('age')
if name == "alex" and age == 22:
raise serializers.ValidationError("alex在22时的故事。。。")
return attrs
- 在ser应用下
urls.py
文件:
urlpatterns = [
path("students/", views.Student2View.as_view()),
re_path(r"^student/(?P<pk>\d+)/$", views.Student1View.as_view()),
# 对数据提交时,进行校验
path('student3/', views.Student3View.as_view()),
# 反序列化阶段
re_path(r'^student4/(?P<pk>\d+)/$', views.Student4View.as_view()),
# 一个序列化器同时实现序列化和反序列化
path('student5/', views.Student5View.as_view()),
# 使用模型类序列化器
path('student6/', views.Student6View.as_view()),
]
- 在ser应用下
views.py
文件:
class Student6View(View):
def get(self, request):
# 获取所有数据
student_list = Student.objects.all()
serializer = StudentModelSerializer(instance=student_list, many=True)
return JsonResponse(serializer.data, safe=False)
def post(self, request):
data = request.body.decode()
data_dict = json.loads(data)
serializer = StudentModelSerializer(data=data_dict)
serializer.is_valid(raise_exception=True)
serializer.save()
return JsonResponse(serializer.data)
补全PUT
同理views.Student5View()