Django Rest_Framework（一）
目录
1. Web应用模式
在开发Web应用中，有两种应用模式：
- 前后端不分离
- 前后端分离
2. api接口
为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口，用途一目了然，减少双方之间的合作成本。
目前市面上大部分公司开发人员使用的接口服务架构主要有：restful、rpc。
rpc: 翻译成中文:远程过程调用[远程服务调用].
post请求
/home?action=get_all_student¶ms=301&sex=1
def get_all_student(params,sex):
....
接口多了,对应函数名和参数就多了,前端在请求api接口时,就会比较难找.容易出现重复的接口
restful: 翻译成中文: 资源状态转换.
把后端所有的数据/文件都看成资源.
那么接口请求数据,本质上来说就是对资源的操作了.
web项目中操作资源,无非就是增删查改.所以要求在地址栏中声明要操作的资源是什么,然后通过http请求动词来说明对资源进行哪一种操作.
POST http://www.lufei.com/api/students/ 添加学生数据
GET http://www.lufei.com/api/students/ 获取所有学生
DELETE http://www.lufei.com/api/students/
3. RESTful API规范
REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征）性状态转移。 它首次出现在2000年Roy Fielding的博士论文中。
RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。
这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。
而对于数据资源分别使用POST、DELETE、GET、UPDATE等请求动作来表达对数据的增删查改。
| 请求方法 | 请求地址 | 后端操作 |
|---|---|---|
| GET | /students | 获取所有学生 |
| POST | /students | 增加学生 |
| GET | /students/ |
获取编号为pk的学生 |
| PUT | /students/ |
修改编号为pk的学生 |
| DELETE | /students/ |
删除编号为pk的学生 |
事实上，我们可以使用任何一个框架都可以实现符合restful规范的API接口。
参考文档：http://www.runoob.com/w3cnote/restful-architecture.html
4. 序列化
api接口开发，最核心最常见的一个过程就是序列化，所谓序列化就是把数据转换格式，序列化可以分两个阶段：
序列化： 把我们识别的数据转换成指定的格式提供给别人。
例如：我们在django中获取到的数据默认是模型对象，但是模型对象数据无法直接提供给前端或别的平台使用，所以我们需要把数据进行序列化，变成字符串或者json数据，提供给别人。
反序列化：把别人提供的数据转换/还原成我们需要的格式。
例如：前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中。
5. Django Rest_Framework
核心思想: 缩减编写api接口的代 -- DRF
Django REST framework是一个建立在Django基础之上的Web 应用开发框架，可以快速的开发REST API接口应用。在REST framework中，提供了序列化器Serialzier的定义，可以帮助我们简化序列化与反序列化的过程，不仅如此，还提供丰富的类视图、扩展类、视图集来简化视图的编写工作。REST framework还提供了认证、权限、限流、过滤、分页、接口文档等功能支持。REST framework提供了一个API 的Web可视化界面来方便查看测试接口。
中文文档：https://q1mi.github.io/Django-REST-framework-documentation/#django-rest-framework
github: https://github.com/encode/django-rest-framework/tree/master
英文文档：https://www.django-rest-framework.org/
特点
- 提供了定义序列化器Serializer的方法，可以快速根据 Django ORM 或者其它库自动序列化/反序列化；
- 提供了丰富的类视图、Mixin扩展类，简化视图的编写；
- 丰富的定制层级：函数视图、类视图、视图集合到自动生成 API，满足各种需要；
- 多种身份认证和权限认证方式的支持；[jwt]
- 内置了限流系统；
- 直观的 API web 界面；
- 可扩展性，插件丰富
6. 环境安装与配置
DRF需要以下依赖：
- Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)
- Django (1.10, 1.11, 2.0)
DRF是以Django扩展应用的方式提供的，所以我们可以直接利用已有的Django环境而无需从新创建。（若没有Django环境，需要先创建环境安装Django）
6.1 安装DRF
前提是已经安装了django，建议安装在虚拟环境
# mkvirtualenv drfdemo -p python3
# pip install django
pip install djangorestframework
6.1.1 创建django项目
cd ~/Desktop
django-admin startproject drfdemo
使用pycharm打开项目，设置虚拟环境的解析器，并修改manage.py中的后缀参数。
6.2 添加rest_framework应用
在settings.py的INSTALLED_APPS中添加'rest_framework'。
INSTALLED_APPS = [
...
'rest_framework',
]
接下来就可以使用DRF提供的功能进行api接口开发了。在项目中如果使用rest_framework框架实现API接口，主要有以下三个步骤：
- 将请求的数据（如JSON格式）转换为模型类对象
- 操作数据库
- 将模型类对象转换为响应的数据（如JSON格式）
接下来，我们快速体验下四天后我们学习完成drf以后的开发代码。接下来代码不需要理解，看步骤。
6.3 体验drf完全简写代码的过程
6.3.1. 创建模型操作类
class Student(models.Model):
# 模型字段
name = models.CharField(max_length=100,verbose_name="姓名",help_text='提示文本：不能为空')
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
为了方便测试，所以我们可以先创建一个数据库。
create database students charset=utf8;
6.3.1.1 执行数据迁移
把students子应用添加到INSTALL_APPS中
初始化数据库连接
安装pymysql
pip install pymysql
主引用中__init__.py设置使用pymysql作为数据库驱动
import pymysql
pymysql.install_as_MySQLdb()
settings.py配置文件中设置mysql的账号密码
DATABASES = {
# 'default': {
# 'ENGINE': 'django.db.backends.sqlite3',
# 'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
# },
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': "students",
"HOST": "127.0.0.1",
"PORT": 3306,
"USER": "root",
"PASSWORD":"123",
}
}
终端下，执行数据迁移。
python manage.py makemigrations
python manage.py migrate
错误列表
# 执行数据迁移 python manage.py makemigrations 报错如下：
解决方案：
注释掉 python/site-packages/django/backends/mysql/base.py中的35和36行代码。
# 执行数据迁移发生以下错误：
解决方法：
backends/mysql/operations.py146行里面新增一个行代码：
6.3.2. 创建序列化器
例如，在django项目中创建学生子应用。
python manage.py startapp students
在students应用目录中新建serializers.py用于保存该应用的序列化器。
创建一个StudentModelSerializer用于序列化与反序列化。
# 创建序列化器类，回头会在试图中被调用
class StudentModelSerializer(serializers.ModelSerializer):
class Meta:
model = Student
fields = "__all__"
- model 指明该序列化器处理的数据字段从模型类Student参考生成
- fields 指明该序列化器包含模型类中的哪些字段，'all'指明包含所有字段
6.3.3. 编写视图
在students应用的views.py中创建视图StudentViewSet，这是一个视图集合。
from rest_framework.viewsets import ModelViewSet
from .models import Student
from .serializers import StudentModelSerializer
# Create your views here.
class StudentViewSet(ModelViewSet):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
- queryset 指明该视图集在查询数据时使用的查询集
- serializer_class 指明该视图在进行序列化或反序列化时使用的序列化器
6.3.4. 定义路由
在students应用的urls.py中定义路由信息。
from . import views
from rest_framework.routers import DefaultRouter
# 路由列表
urlpatterns = []
router = DefaultRouter() # 可以处理视图的路由器，自动通过视图来生成增删改查的url路径
router.register('students', views.StudentViewSet) #students是生成的url前缀，名称随便写， 向路由器中注册视图集
urlpatterns += router.urls # 将路由器中的所以路由信息追到到django的路由列表中
最后把students子应用中的路由文件加载到总路由文件中.
from django.contrib import admin
from django.urls import path,include
urlpatterns = [
path('admin/', admin.site.urls),
path("stu/",include("students.urls")),
]
6.3.5. 运行测试
运行当前程序（与运行Django一样）
python manage.py runserver
在浏览器中输入网址127.0.0.1:8000，可以看到DRF提供的API Web浏览页面：
1）点击链接127.0.0.1:8000/stu/students 可以访问获取所有数据的接口，呈现如下页面：
2）在页面底下表单部分填写学生信息，可以访问添加新学生的接口，保存学生信息：
点击POST后，返回如下页面信息：
3）在浏览器中输入网址127.0.0.1:8000/stu/students/5/，可以访问获取单一学生信息的接口（id为5的学生），呈现如下页面：
4）在页面底部表单中填写学生信息，可以访问修改学生的接口：
.png)
点击PUT，返回如下页面信息：
5）点击DELETE按钮，可以访问删除学生的接口：
返回，如下页面：
7. 序列化器-Serializer
作用：
1. 序列化,序列化器会把模型对象转换成字典,经过response以后变成json字符串
2. 反序列化,把客户端发送过来的数据,经过request以后变成字典,序列化器可以把字典转成模型
3. 反序列化,完成数据校验功能
7.1 定义序列化器
Django REST framework中的Serializer使用类来定义，须继承自rest_framework.serializers.Serializer。
接下来，为了方便演示序列化器的使用，我们先创建一个新的子应用sers
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
我们想为这个模型类提供一个序列化器，可以定义如下：
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是独立于数据库之外的存在。
常用字段类型：
| 字段 | 字段构造方式 |
|---|---|
| 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_length | 最小长度 |
| 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对象
定义好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属性获取。
- 使用序列化器的时候一定要注意，序列化器声明了以后，不会自动执行，需要我们在视图中进行调用才可以。
- 序列化器无法直接接收数据，需要我们在视图中创建序列化器对象时把使用的数据传递过来。
- 序列化器的字段声明类似于我们前面使用过的表单系统。
- 开发restful api时，序列化器会帮我们把模型数据转换成字典.
- drf提供的视图会帮我们把字典转换成json,或者把客户端发送过来的数据转换字典.
7.3 序列化器的使用
序列化器的使用分两个阶段：
- 在客户端请求时，使用序列化器可以完成对数据的反序列化。
- 在服务器响应时，使用序列化器可以完成对数据的序列化。
7.3.1 序列化
7.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': '猴赛雷'}
完整视图代码：
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)
4）如果要被序列化的是包含多条数据的查询集QuerySet，可以通过添加many=True参数补充说明
"""使用序列化器序列化转换多个模型数据"""
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,json_dumps_params={'ensure_ascii':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', '猴赛雷')])]
在ser应用中创建Urls.py
from django.urls import path
from . import views
urlpatterns = [
path(r'students/',views.StudentView.as_view()),
]
别忘了在总路由中include一下
from django.contrib import admin
from django.urls import path,include,re_path
urlpatterns = [
path('admin/', admin.site.urls),
path('stu/',include('students.urls')),
path('ser/',include('sers.urls')),
]
8. 序列化器-Serializer
作用：
1. 序列化,序列化器会把模型对象转换成字典,经过response以后变成json字符串
2. 反序列化,把客户端发送过来的数据,经过request以后变成字典,序列化器可以把字典转成模型
3. 反序列化,完成数据校验功能
8.1 定义序列化器
Django REST framework中的Serializer使用类来定义，须继承自rest_framework.serializers.Serializer。
接下来，为了方便演示序列化器的使用，我们先创建一个新的子应用sers
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
我们想为这个模型类提供一个序列化器，可以定义如下：
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是独立于数据库之外的存在。
常用字段类型：
| 字段 | 字段构造方式 |
|---|---|
| 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_length | 最小长度 |
| 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页面时，显示的字段帮助提示信息 |
8.2 创建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属性获取。
- 使用序列化器的时候一定要注意，序列化器声明了以后，不会自动执行，需要我们在视图中进行调用才可以。
- 序列化器无法直接接收数据，需要我们在视图中创建序列化器对象时把使用的数据传递过来。
- 序列化器的字段声明类似于我们前面使用过的表单系统。
- 开发restful api时，序列化器会帮我们把模型数据转换成字典.
- drf提供的视图会帮我们把字典转换成json,或者把客户端发送过来的数据转换字典.
8.3 序列化器的使用
序列化器的使用分两个阶段：
- 在客户端请求时，使用序列化器可以完成对数据的反序列化。
- 在服务器响应时，使用序列化器可以完成对数据的序列化。
8.3.2 反序列化
8.3.2.1 数据验证
使用序列化器进行反序列化时，需要对数据进行验证后，才能获取验证成功的数据或保存成模型类对象。
在获取反序列化的数据前，必须调用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)
8.3.2.2 反序列化-保存数据
前面的验证数据成功后,我们可以使用序列化器来完成数据反序列化的过程.这个过程可以把数据转成模型类对象.
首先我们可以在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()被调用。
8.3.2.3 附加说明
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
8.3.3 模型类序列化器
如果我们想要使用序列化器对应的是Django的模型类，DRF为我们提供了ModelSerializer模型类序列化器来帮助我们快速创建一个Serializer类。
ModelSerializer与常规的Serializer相同，但提供了：
- 基于模型类自动生成一系列字段
- 基于模型类自动为Serializer生成validators，比如unique_together
- 包含默认的create()和update()的实现
8.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__" # 表示操作模型中的所有字段
# 添加额外的验证选项
exclude = ['id',] # 排除字段
extra_kwargs = {
"sex":{"write_only":True,},
"id":{"read_only":True,}
}
- model 指明参照哪个模型类
- fields 指明为模型类的哪些字段生成
8.3.3.2 指定字段
- 使用fields来明确字段，
__all__表名包含所有字段，也可以写明具体哪些字段，如
class StudentModelSerializer(serializers.ModelSerializer):
"""学生数据序列化器"""
class Meta:
model = Student
fields = ['id', 'age', 'name',"description"]
- 使用exclude可以明确排除掉哪些字段
class StudentModelSerializer(serializers.ModelSerializer):
"""学生数据序列化器"""
class Meta:
model = Student
exclude = ['sex']
- 指明只读字段[少用,通过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',)
8.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
简单做个示例
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声明
验证
添加/保存数据功能[可选]
看表字段大小，看使用哪个更加节省代码了。
