# 1. 序列化: 序列化器会把模型对象转换成字典,将来提供给视图经过response以后变成json字符串 # 2. 反序列化,把客户端发送过来的数据,经过视图调用request以后变成字典,序列化器可以把字典转成模型 # 3. 反序列化,完成数据校验功能和操作数据库
Django REST framework中的Serializer使用类来定义，须继承自rest_framework.serializers.Serializer。
接下来，为了方便演示序列化器的使用，我们先创建一个新的子应用sers
python manage.py startapp sers
我们已有了一个数据库模型类students/Student
from rest_framework import serializers # Serializer基础序列化器， # ModelSerializer 模型类序列化器，是基础序列化器的子类 class StudentSerializer(serializers.Serializer): """学生信息序列化器""" # 1. 字段声明 # 注意： # 1. 把需要提供给客户端的字段才写进来，或者需要客户端提供的字段才写进 # 2. =号左边的字段一定要和模型里面的字段名对应 # 3. 序列化器声明的字段并非一定要在数据库中的，也可以是模型声明的属性方法 id = serializers.IntegerField() name = serializers.CharField() age = serializers.IntegerField() sex = serializers.BooleanField() text = serializers.IntegerField() # description = serializers.CharField() # TextField是数据才有的，前端没有这种说法 # 2. 如果使用的模型类序列化器，则需要继续的模型信息 # 3. 验证数据的相关代码 # 4. 保存数据到数据库中的代码
我们想为这个模型类提供一个序列化器，可以在sers目录下新建一个serializers.py文件如下：
from rest_framework import serializers # Serializer基础序列化器， # ModelSerializer 模型类序列化器，是基础序列化器的子类 class StudentSerializer(serializers.Serializer): """学生信息序列化器""" # 1. 字段声明 # 注意： # 1. 把需要提供给客户端的字段才写进来，或者需要客户端提供的字段才写进 # 2. =号左边的字段一定要和模型里面的字段名对应 # 3. 序列化器声明的字段并非一定要在数据库中的，也可以是模型声明的属性方法 id = serializers.IntegerField() name = serializers.CharField() age = serializers.IntegerField() sex = serializers.BooleanField() text = serializers.IntegerField() # description = serializers.CharField() # TextField是数据才有的，前端没有这种说法 # 2. 如果使用的模型类序列化器，则需要继续的模型信息 # 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页面时，显示的字段帮助提示信息 |
sers目录下的views.py视图
# Create your views here. from django.views import View from django.http.response import JsonResponse from .serializers import StudentSerializer from students.models import Student class StudentsView(View): def get(self,request): # 序列化器的声明和使用 # 0. 从数据库中查询模型对象 student = Student.objects.get(pk=1) print(student) # 1. 实例化序列化器对象 # 参数: # 1） instance 模型对象, 一般来自于ORM # 2) data 字典数据, 一般来自客户端 # 3） context 字典, 可以把视图中的信息传参给序列化器 # 4) many 布尔值，如果instance是多个对象，则必须声明many=True，否则序列化器会报错 serializer = StudentSerializer(instance=student) print(serializer.data) # 转换后的字典数据 return JsonResponse(serializer.data)
sers目录下的路由
from django.urls import path,re_path from . import views urlpatterns = [ path('students/', views.StudentsView.as_view()), ]
1.2 创建Serializer对象
定义好Serializer类后，就可以创建Serializer对象了。
Serializer的构造方法为：
Serializer(instance=None, data=empty, **kwarg)
说明：
1）用于序列化时，将模型类对象传入instance参数
2）用于反序列化时，将要被反序列化的数据传入data参数
3）除了instance和data参数外，在构造Serializer对象时，还可通过context参数额外添加数据，如
# views.py中 class StudentsView(View): def get1(self,request): # 序列化器的声明和使用 # 0. 从数据库中查询模型对象 student = Student.objects.get(pk=1) # 1. 实例化序列化器对象 # 参数: # 1） instance 模型对象, 一般来自于ORM # 2) data 字典数据, 一般来自客户端 # 3） context 字典, 可以把视图中的信息传参给序列化器 # 4) many 布尔值，如果instance是多个对象，则必须声明many=True，否则序列化器会报错 num =1 serializer = StudentSerializer(instance=student,context={"num":num}) return JsonResponse(serializer.data)
通过context参数附加的数据，可以通过Serializer对象的context属性获取。
-
使用序列化器的时候一定要注意，序列化器声明了以后，不会自动执行，需要我们在视图中进行调用才可以。
-
序列化器无法直接接收数据，需要我们在视图中创建序列化器对象时把使用的数据传递过来。
-
序列化器的字段声明类似于我们前面使用过的表单系统。
-
开发restful api时，序列化器会帮我们把模型数据转换成字典.
-
drf提供的视图会帮我们把字典转换成json,或者把客户端发送过来的数据转换字典.
1.3 序列化器的使用
序列化器的使用分两个阶段：
-
在客户端请求时，使用序列化器可以完成对数据的反序列化。
-
在服务器响应时，使用序列化器可以完成对数据的序列化。
1.3.1.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': '猴赛雷'}
完整serializers代码
from rest_framework import serializers # Serializer基础序列化器， # ModelSerializer 模型类序列化器，是基础序列化器的子类 class StudentSerializer(serializers.Serializer): """学生信息序列化器""" # 1. 字段声明 # 注意： # 1. 把需要提供给客户端的字段才写进来，或者需要客户端提供的字段才写进 # 2. =号左边的字段一定要和模型里面的字段名对应 # 3. 序列化器声明的字段并非一定要在数据库中的，也可以是模型声明的属性方法 id = serializers.IntegerField() name = serializers.CharField() age = serializers.IntegerField() sex = serializers.BooleanField() text = serializers.IntegerField() # description = serializers.CharField() # TextField是数据才有的，前端没有这种说法 # 2. 如果使用的模型类序列化器，则需要继续的模型信息 # 3. 验证数据的相关代码 # 4. 保存数据到数据库中的代码
完整视图代码：
# Create your views here. from django.views import View from django.http.response import JsonResponse from .serializers import StudentSerializer from students.models import Student class StudentsView(View): def get1(self,request): # 序列化器的声明和使用 # 0. 从数据库中查询模型对象 student = Student.objects.get(pk=1) print(student) # 1. 实例化序列化器对象 # 参数: # 1） instance 模型对象, 一般来自于ORM # 2) data 字典数据, 一般来自客户端 # 3） context 字典, 可以把视图中的信息传参给序列化器 # 4) many 布尔值，如果instance是多个对象，则必须声明many=True，否则序列化器会报错 serializer = StudentSerializer(instance=student) print(serializer.data) # 转换后的字典数据 return JsonResponse(serializer.data)
# Create your views here. from django.views import View from django.http.response import JsonResponse from .serializers import StudentSerializer from students.models import Student class StudentsView(View): def get(self, request): """序列化多个数据""" # 1. 获取数据 student_list = Student.objects.all() # 2. 实例化序列化器对象 # many=True的作用，就是告诉序列化器内部，当前instance的值是一个列表，所以需要循环 serializer = StudentSerializer(instance=student_list, many=True) # 3. 返回结果 # 通过data属性获取序列化器转换数据后的结果 print(serializer.data) """打印效果 [ OrderedDict([('id', 1), ('name', '小明'), ('age', 17), ('sex', True), ('text', 100)]), OrderedDict([('id', 2), ('name', '小明'), ('age', 17), ('sex', True), ('text', 100)]), OrderedDict([('id', 3), ('name', '小明'), ('age', 17), ('sex', True), ('text', 100)]), OrderedDict([('id', 4), ('name', '小明'), ('age', 17), ('sex', True), ('text', 100)]), OrderedDict([('id', 5), ('name', '小明'), ('age', 17), ('sex', True), ('text', 100)]), .... ] OrderedDict 是python的高级数据类型，叫有序字典 from collections import OrderedDict 因为python内置的基础类型的字典是无序的，所以这种无序字典无法不保证存储时的键值对顺序和提取时候的顺序一致 有序字典和无序字典，除了声明不一样以外，对于成员的读取和操作是一样的。 for item in serializer.data: # 获取有序字典的键值对 print(item["name"]) """ # JsonResponse 只是支持返回普通的字符串和字典，对于复杂的列表数据，需要设置参数safe=False return JsonResponse(serializer.data, safe=False)