作用
1. 序列化,序列化器会把模型对象转换成字典,经过response以后变成json字符串
2. 反序列化,把客户端发送过来的数据,经过request以后变成字典,序列化器可以把字典转成模型
3. 反序列化,完成数据校验功能
7.1 定义序列化器
Django REST framework中的Serializer使用类来定义，须继承自rest_framework.serializers.Serializer。
接下来，为了方便演示序列化器的使用，我们先创建一个新的子应用students
python manage.py startapp students
我们已有了一个数据库模型类students/students.py/Student
from django.db import models# Create your models here.
class Student(models.Model):
#以下模型字段默认时不能为空 null=False
name = models.CharField(max_length=100,verbose_name="姓名")
sex = models.BooleanField(default=1,verbose_name="性别")
age = models.IntegerField(verbose_name="年龄")
class_null = models.CharField(max_length=5,verbose_name="班级编号")
description = models.TextField(max_length=1000,verbose_name="个性签名") class Meta:
db_table="tb_student"
verbose_name ="学生"
verbose_name_plural = verbose_name
我们想为这个模型类提供一个序列化器students/serializers.py/StudentSerializer，可以定义如下：
from rest_framework import serializersclass StudentSerializer(serializers.Serializer):
# 1. 需要转换的字段声明
# 小括号里面声明主要提供给反序列化使用的
id=serializers.IntegerField(read_only=True)
name = serializers.CharField(required=True, max_length=20)
age = serializers.IntegerField(max_value=150, min_value=0,required=True)
sex = serializers.BooleanField(default=True,write_only=True)
description = serializers.CharField(required=True, allow_null=True, allow_blank=True)
# 如果序列化器调用的模型中的字段声明，则需要声明Meta类
# 2. 如果序列化器集成的是ModelSerializer，则需要声明调用的模型信息
# 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(max*length=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'` - 如: `""` 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页面时，显示的字段帮助提示信息 |
7.2 创建Serializer对象
定义好students/serializers.py/StudentSerializer类后，就可以创建Serializer对象了。
Serializer的构造方法为：
StudentSerializer(instance=None, data=empty, **kwarg)
说明：
1）用于序列化时，将模型类对象传入instance参数
2）用于反序列化时，将要被反序列化的数据传入data参数
3）除了instance和data参数外，在构造Serializer对象时，还可通过context参数额外添加数据，如
serializer = StudentSerializer(account, context={'request': request})
通过context参数附加的数据，可以通过Serializer对象的context属性获取。
-
使用序列化器的时候一定要注意，序列化器声明了以后，不会自动执行，需要我们在视图中进行调用才可以。
-
序列化器无法直接接收数据，需要我们在视图中创建序列化器对象时把使用的数据传递过来。
-
序列化器的字段声明类似于我们前面使用过的表单系统。
-
开发restful api时，序列化器会帮我们把模型数据转换成字典.
-
drf提供的视图会帮我们把字典转换成json,或者把客户端发送过来的数据转换字典.
7.3 序列化器的使用
序列化器的使用分两个阶段：
-
在客户端请求时，使用序列化器可以完成对数据的反序列化。
-
在服务器响应时，使用序列化器可以完成对数据的序列化。
7.3.1 序列化
drf01最后一个栗子
7.3.2 反序列化
7.3.2.1 数据验证
使用序列化器进行反序列化时，需要对数据进行验证后，才能获取验证成功的数据或保存成模型类对象。
在获取反序列化的数据前，必须调用is_valid()方法进行验证，验证成功返回True，否则返回False。
验证失败，可以通过序列化器对象的errors属性获取错误信息，返回字典，包含了字段和字段的错误。如果是非字段错误，可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。
验证成功，可以通过序列化器对象的validated_data属性获取数据。
在定义序列化器时，指明每个字段的序列化类型和选项参数，本身就是一种验证行为。
from django.db import models# Create your models here.
class Student(models.Model):
#以下模型字段默认时不能为空 null=False
name = models.CharField(max_length=100,verbose_name="姓名")
sex = models.BooleanField(default=1,verbose_name="性别")
age = models.IntegerField(verbose_name="年龄")
class_null = models.CharField(max_length=5,verbose_name="班级编号",null=True)
description = models.TextField(max_length=1000,verbose_name="个性签名",null=True) class Meta:
db_table="tb_student"
verbose_name ="学生"
verbose_name_plural = verbose_name
students/models.py
from rest_framework import serializers
from students.models import Student##### 3) validators 在字段中添加validators选项参数，也可以补充验证行为，如
def check_age(age):
if age ==50:
raise serializers.ValidationError("年龄不能刚好是50")
return ageclass StudentSerializer(serializers.Serializer):
# 1.需要转换的字段声明
# 小括号里面声明主要提供给反序列化使用的
id=serializers.IntegerField(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)
description = serializers.CharField(required=True, allow_null=True, allow_blank=True)
# 2.如果序列化器调用的模型中的字段声明，则需要声明Meta类###### 3. 验证代码 可以使用以下三种方法：
# 序列化器中可以自定义单个字段的验证方法 def validate_<字段名>(用户提交的字段数据):
##### 1) validate_字段名 对` < field_name > `字段进行验证，如
def validate_name(self,data_name):
if(data_name=="老男孩"):
raise serializers.ValidationError("用户名不能是老男孩") # 验证完成以后务必要返回字段值
return data_name # 方法名时固定的,用于验证多个字段,参数就是实例化序列化器类时的data参数
###### 2) validate在序列化器中需要同时对多个字段进行比较验证时，可以定义validate方法来验证，如
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()两个方法来实现。
# 4.添加和更新代码
# 序列化器中会提供了两个方法: 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
students/serializers.py
# 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)
print(serializer)
'''
StudentSerializer(data={'name': '小白', 'age': '45', 'sex': 'False', 'description': None}):
id = IntegerField(read_only=True)
name = CharField(max_length=20, required=True)
age = IntegerField(max_value=150, min_value=0, required=True, validators=[<function check_age>])
sex = BooleanField(default=True, write_only=True)
description = CharField(allow_blank=True, allow_null=True, required=True)
''' # 当验证失败时,可以直接通过声明 raise_exception=True 让django直接跑出异常
#is_valid()方法还可以在验证失败时抛出异常serializers.ValidationError，可以通过传递 ** raise_exception = True ** 参数开启，REST framework接收到此异常，会向前端返回HTTP 400 Bad Request响应。
result = serializer.is_valid(raise_exception=True)
# 验证顺序
# 1. 先使用字段声明的验证选项
# 2. 使用validate_<字段>和validate()
# 3. 使用字段选项中的validators执行外部函数的验证
print( "验证结果:%s" % result )# 验证结果:True # 获取通过验证后的数据
print( serializer.validated_data ) # OrderedDict([('name', '小白'), ('age', 45), ('sex', False), ('description', None)])
# 保存数据 调用序列化器的create方法
# student = Student.objects.create(
# name=serializer.validated_data.get("name"),
# age=serializer.validated_data.get("age"),
# sex=serializer.validated_data.get("sex")
# ) # 调用序列化器中的save方法,save会自动调用create
student = serializer.save() print(student) #Student object (4)
#实现了上述两个方法后，在视图中调用序列化器进行反序列化数据的时候，就可以通过save()方法返回一个数据对象实例了 # 返回响应结果给客户端
# alt + enter，可以实现快速导包
return JsonResponse({"message": "ok"}) def put(self,request):
"""更新学生信息"""
# 接受参数
data = {
"id":3,
"name":"abc",
"age":18,
"sex":1,
}
# 获取要修改的数据
instance = Student.objects.get(pk=data.get("id"))
# 调用序列化器
serializer = StudentSerializer(instance=instance,data=data,partial=True)
# 验证
serializer.is_valid(raise_exception=True) # 转换成模型数据
# 调用序列化器中的save方法,save会自动调用update
student = serializer.save()
# 实现了上述两个方法后，在视图中调用序列化器进行反序列化数据的时候，就可以通过save()方法返回一个数据对象实例了 return JsonResponse({"message": "ok"}) def get(self,request):
# 获取所有数据
data_list = Student.objects.all()
# 使用序列化器进行序列化器
serializer = StudentSerializer(instance=data_list,many=True)
# 返回数据给客户端
return JsonResponse(serializer.data,safe=False)
students/views.py
from django.urls.conf import path
from . import views
urlpatterns = [
path( r"student/", views.StudentView.as_view() ),
]
students/urls.py
from django.contrib import admin
from django.urls import path,includeurlpatterns = [
path('admin/', admin.site.urls),
path("stu/",include("students.urls"))
]
urls.py
7.3.2.3 附加说明
1） 在对序列化器进行save()保存时，可以额外传递数据，这些数据可以在create()和update()中的validated_data参数获取到
# request.user 是django中记录当前登录用户的模型对象
serializer.save(owner=request.user)
2）默认序列化器必须传递所有required的字段，否则会抛出验证异常。但是我们可以使用partial参数来允许部分字段更新
# 更新学生的部分字段信息，当数据库允许为空，但是序列化器要求必须字段填写的时候，可以使用以下方式避开
serializer = StudentSerializer(instance=instance, data=data, partial=True)
7.3.3 模型类序列化器
如果我们想要使用序列化器对应的是Django的模型类，DRF为我们提供了ModelSerializer模型类序列化器来帮助我们快速创建一个Serializer类。
ModelSerializer与常规的Serializer相同，但提供了：
-
基于模型类自动生成一系列字段
-
基于模型类自动为Serializer生成validators，比如unique_together
-
包含默认的create()和update()的实现
7.3.3.1 定义
为了方便学习和查看效果， 新建一个子应用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__" # 表示操作模型中的所有字段
# 添加额外的验证选项
extra_kwargs = {
"sex":{"write_only":True,},
"id":{"read_only":True,}
}
-
model 指明参照哪个模型类
-
fields 指明为模型类的哪些字段生成
7.3.3.2 指定字段
1) 使用fields来明确字段，__all__表名包含所有字段，也可以写明具体哪些字段，如
class StudentModelSerializer(serializers.ModelSerializer):
"""学生数据序列化器"""
class Meta:
model = Student
fields = ['id', 'age', 'name',"description"]
2) 使用exclude可以明确排除掉哪些字段
class StudentModelSerializer(serializers.ModelSerializer):
"""学生数据序列化器"""
class Meta:
model = Student
exclude = ['sex']
3) 指明只读字段[少用]
可以通过read_only_fields指明只读字段，即仅用于序列化输出的字段
class StudentModelSerializer(serializers.ModelSerializer):
"""学生数据序列化器"""
class Meta:
model = Student
fields = ['id', 'age', 'name',"description"]
read_only_fields = ('id')
7.3.3.3 添加额外参数
我们可以使用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
from django.views import View
from students.models import Student
from .serializers import StudentModelSerializer
from django.http.response import JsonResponse
class StudentView(View):
def get(self,request):
# 获取数据
data_list = Student.objects.all()
# 调用序列化器
serializer = StudentModelSerializer(instance=data_list,many=True) # 响应数据
return JsonResponse(serializer.data, safe=False) def post(self,request):
data = {
"name": "老男孩",
"age": 18,
"sex": 1,
}
# 调用序列化器
serializer = StudentModelSerializer(data=data)
# 验证
serializer.is_valid(raise_exception=True)
# 转换成模型数据
student = serializer.save() return JsonResponse({"message": "ok"})
msers/views.py
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,}
} # 验证代码
def validate_name(self,data):
if(data=="老男孩"):
raise serializers.ValidationError("用户名不能是老男孩") # 验证完成以后务必要返回字段值
return data # 也可以重新声明一个create和update
msers/serializers.py
