开发框架和序列化
Web应用模式
在开发Web应用中，有两种应用模式：
1. 前后端不分离
2. 前后端分离
为了在团队内部形成共识、防止个人习惯差异引起的混乱，我们需要找到一种大家都觉得很好的接口实现规范，而且这种规范能够让后端写的接口，用途一目了然，减少双方之间的合作成本。
目前市面上大部分公司开发人员使用的接口服务架构主要有：restful、rpc。
rpc: 翻译成中文:远程过程调用[远程服务调用]. http://www.lufei.com/api post请求 action=get_all_student¶ms=301&sex=1
接口多了,对应函数名和参数就多了,前端在请求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/<pk> 删除1个学生 GET http://www.lufei.com/api/students/<pk> 获取一个学生
REST全称是Representational State Transfer，中文意思是表述（编者注：通常译为表征）性状态转移。 它首次出现在2000年Roy Fielding的博士论文中。
RESTful是一种定义Web API接口的设计风格，尤其适用于前后端分离的应用模式中。
这种风格的理念认为后端开发任务就是提供数据的，对外提供的是数据资源的访问接口，所以在定义接口时，客户端访问的URL路径就表示这种要操作的数据资源。
而对于数据资源分别使用POST、DELETE、GET、UPDATE等请求动作来表达对数据的增删查改。
| 请求方法 | 请求地址 | 后端操作 |
|---|---|---|
| GET | /students | 获取所有学生 |
| POST | /students | 增加学生 |
| GET | /students/<pk> | 获取编号为pk的学生 |
| PUT | /students/<pk> | 修改编号为pk的学生 |
| DELETE | /students/<pk> | 删除编号为pk的学生 |
参考文档：http://www.runoob.com/w3cnote/restful-architecture.html
api接口开发，最核心最常见的一个过程就是序列化，所谓序列化就是把数据转换格式，序列化可以分两个阶段：
序列化： 把我们识别的数据转换成指定的格式提供给别人。
例如：我们在django中获取到的数据默认是模型对象，但是模型对象数据无法直接提供给前端或别的平台使用，所以我们需要把数据进行序列化，变成字符串或者json数据，提供给别人。
反序列化：把别人提供的数据转换/还原成我们需要的格式。
例如：前端js提供过来的json数据，对于python而言就是字符串，我们需要进行反序列化换成模型类对象，这样我们才能把数据保存到数据库中。
接收数据[反序列化]
操作数据
响应数据[序列化]
核心思想: 缩减编写api接口的代码
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
- 提供了定义序列化器Serializer的方法，可以快速根据 Django ORM 或者其它库自动序列化/反序列化； - 提供了丰富的类视图、Mixin扩展类，简化视图的编写； - 丰富的定制层级：函数视图、类视图、视图集合到自动生成 API，满足各种需要； - 多种身份认证和权限认证方式的支持；[jwt] - 内置了限流系统； - 直观的 API web 界面； - 可扩展性，插件丰富
前提是已经安装了django，建议安装在虚拟环境
# mkvirtualenv drfdemo -p python3 # pip install django pip install djangorestframework pip install pymysql
linux 复制 shift+insert
cd ~/Desktop
django-admin startproject drfdemo
使用pycharm打开项目，设置虚拟环境的解析器，并修改manage.py中的后缀参数。
运行项目
加入runserver
INSTALLED_APPS = [ ... 'rest_framework', ]
接下来就可以使用DRF提供的功能进行api接口开发了。在项目中如果使用rest_framework框架实现API接口，主要有以下三个步骤：
-
-
操作数据库
-
将模型类对象转换为响应的数据（如JSON格式）
接下来，我们快速体验下四天后我们学习完成drf以后的开发代码。接下来代码不需要理解，看步骤。
class Student(models.Model): # 模型字段 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
为了方便测试，所以我们可以先创建一个数据库。
create database students charset=utf8;
例如，在django项目中创建学生子应用。
python manage.py startapp students
把students子应用添加到INSTALLED_APPS中
初始化数据库连接
安装pymysql
pip install 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 报错如下：
解决方案：
注释掉 backends/mysql/base.py中的35和36行代码。
# 执行数据迁移发生以下错误：
解决方法：
backends/mysql/operations.py146行里面新增一个行代码：
在students应用目录中新建serializers.py用于保存该应用的序列化器。
创建一个StudentModelSerializer用于序列化与反序列化。
# 创建序列化器类，回头会在试图中被调用 from rest_framework import serializers from .models import Student class StudentModelSerializer(serializers.ModelSerializer): class Meta: model = Student fields = "__all__"
-
-
fields 指明该序列化器包含模型类中的哪些字段，'all'指明包含所有字段
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
-
-
serializer_class 指明该视图在进行序列化或反序列化时使用的序列化器
from . import views from rest_framework.routers import DefaultRouter # 路由列表 urlpatterns = [] router = DefaultRouter() # 可以处理视图的路由器 router.register('students', views.StudentViewSet) # 向路由器中注册视图集 urlpatterns += router.urls # 将路由器中的所以路由信息追到到django的路由列表中
from django.contrib import admin from django.urls import path,include urlpatterns = [ path('admin/', admin.site.urls), path("stu/",include("students.urls")), ]
python manage.py runserver
在浏览器中输入网址127.0.0.1:8000，可以看到DRF提供的API Web浏览页面：
点击POST后，返回如下页面信息：
点击PUT，返回如下页面信息：
作用：
1. 序列化,序列化器会把模型对象转换成字典,经过response以后变成json字符串 2. 反序列化,把客户端发送过来的数据,经过request以后变成字典,序列化器可以把字典转成模型 3. 反序列化,完成数据校验功能
Django REST framework中的Serializer使用类来定义，须继承自rest_framework.serializers.Serializer。
python manage.py startapp ser
我们已有了一个数据库模型类students/Student
models
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
创建序列化器
定义如下：
在ser应用下创建一个serializers.py
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. 编写添加和更新模型的代码
| 字段 | 字段构造方式 serializers.字段构造方式() |
|---|---|
| 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页面时，显示的字段帮助提示信息 |
from rest_framework import serializers class BookSerializer(serializers.Serializer): #序列化器 Serializer
定义好Serializer类后，就可以创建Serializer对象了。
Serializer(instance=None, data=empty, **kwarg)
说明：
2）用于反序列化时，将要被反序列化的数据传入data参数
3）除了instance和data参数外，在构造Serializer对象时，还可通过context参数额外添加数据，如
serializer = StudentSerializer(instance, context={'request': request})
通过context参数附加的数据，可以通过Serializer对象的context属性获取。
-
-
序列化器无法直接接收数据，需要我们在视图中创建序列化器对象时把使用的数据传递过来。
-
序列化器的字段声明类似于我们前面使用过的表单系统。
-
开发restful api时，序列化器会帮我们把模型数据转换成字典.
-
drf提供的视图会帮我们把字典转换成json,或者把客户端发送过来的数据转换字典.
1） 先查询出一个学生对象
from students.models import Student student = Student.objects.get(id=3)
2） 构造序列化器对象
from .serializers import StudentSerializer serializer = StudentSerializer(instance=student)
通过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 StudentRetrieveView(View): """使用序列化器序列化转换单个模型数据""" def get(self,request,pk): # 获取数据 student = Student.objects.get(pk=pk) # 数据转换[序列化过程] serializer = StudentSerializer(instance=student) print(serializer.data) # 响应数据 return JsonResponse(serializer.data)
class StudentView(View): """使用序列化器序列化转换多个模型数据""" 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', '猴赛雷')])]
序列化总结：
models
from django.db import models # Create your models here. class Student(models.Model): # 模型字段 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
项目下的url
from django.contrib import admin from django.urls import path,include urlpatterns = [ path('admin/', admin.site.urls), path('ser/', include('ser.urls')), ]
项目下settings的
INSTALLED_APPS = [ 'rest_framework', 'ser', ]
ser下url
from django.urls import re_path,path # re_path正则 from . import views urlpatterns = [ path("students/", views.StudentView.as_view() ), re_path("students/(?P<pk>\d+)/", views.StudentRetrieveView.as_view() ), ]
ser下serializers.py，手动创建
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. 编写添加和更新模型的代码
ser下views
from django.shortcuts import render # Create your views here. from django.views import View from students.models import Student from .serializers import StudentSerializer from django.http import JsonResponse class StudentView(View): """调用序列化器进行序列化操作""" def get(self,request): """提供所有学生信息""" student_list = Student.objects.all() print(student_list) # 列表，列表里面的每一个成员都是一个模型对象 # 使用序列化器进行数据转换列表的每一个成员为字典 # 1. 实例化序列化器类 # StudentSerializer(instance, data, context={视图中要发送给序列化器中使用的字典数据}) # 参数instance ，模型对象，这个参数一般用于把模型转成字典，进行序列化 # 参数data，客户端提交的字典数据，这个参数一般用于把字典转成模型对象，进行校验数据和反序列化 # 参数context，有时候，路由或者视图中有些数据需要传递序列化器内部的方法中调用，则可以context以字典的格式传递进行 # 额外参数： many=True, 表示instance是一个模型列表，此时序列化器在转换数据的时候可以进行循环 serializer = StudentSerializer(student_list, many=True) print(111,serializer.data ) # 获取转换后的数据 # 关闭json数据的安全检测， safe=False return JsonResponse(serializer.data,safe=False) class StudentRetrieveView(View): def get(self,request,pk): """获取一个学生信息""" student = Student.objects.get(pk=pk) print(student) serializer = StudentSerializer(student) print(serializer.data) return JsonResponse(serializer.data)
在获取反序列化的数据前，必须调用is_valid()方法进行验证，验证成功返回True，否则返回False。
验证失败，可以通过序列化器对象的errors属性获取错误信息，返回字典，包含了字段和字段的错误。如果是非字段错误，可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。
验证成功，可以通过序列化器对象的validated_data属性获取数据。
在定义序列化器时，指明每个字段的序列化类型和选项参数，本身就是一种验证行为。
为了方便学习，我们新建一个子应用books。
python manage.py startapp books
在settings.py中的INSTALLED_APPS中新增books子应用
INSTALLED_APPS = [ # ... 'ser', 'unser', ]
Book模型，代码：
models
from django.db import models class Book(models.Model): """图书模型""" title = models.CharField(verbose_name='名称', max_length=20) pub_date = models.DateField(verbose_name='发布日期') read = models.IntegerField(verbose_name='阅读量',default=0) comment = models.IntegerField(verbose_name='评论量', null=True, blank=True) class Meta: db_table = "tb_book" verbose_name="图书" verbose_name_plural=verbose_name def __str__(self): return self.title
执行数据迁移，代码：
python manage.py makemigrations
python manage.py migrate
BookSerializer序列化器，代码：
三种验证方式
1. 外部函数设置为验证函数
函数
字段内加 validators=[check_title]
2. 字段 = serializers.字段类型(验证选项)
error_messages={"min_value":"xxxx"}
3. 自定义方法设置校验方法
单字段
def validate_字段(self, data)
raise serializers.ValidationError（）
多字段
· def validate(self, data):
字段 = data.get('字段')
字段 = data.get('字段')
raise serializers.ValidationError（）
from rest_framework import serializers # 外部函数设置为验证函数 def check_title(data): if data == "django入门": raise serializers.ValidationError("这本书，我定了，你不能叫") class BookSerializer(serializers.Serializer): # 字段声明 # 字段 = serializers.字段类型(验证选项) title = serializers.CharField(required=True, max_length=20,validators=[check_title]) pub_date = serializers.DateField(required=True) read = serializers.IntegerField(default=0,min_value=0, error_messages={"min_value":"对不起，当前字段必须大于或等于0"}) comment = serializers.IntegerField(allow_null=True) # 自定义方法设置校验方法 # validate_字段(字段值) 用于验证指定字段 # validate(客户端提交的所有数据) 用于验证多个字段[联合验证] def validate_title(self, data): if("oldboy" in data): # 跑出错误 raise serializers.ValidationError("对不起，图书名不能包含oldboy！") # 必须在校验完成以后，返回结果 return data def validate(self, data): read = data.get("read") comment = data.get("comment") if(comment>read): raise serializers.ValidationError("对不起，阅读量不能小于评论量，喷子！") return data
通过构造序列化器对象，并将要反序列化的数据传递给data构造参数，进而进行验证
from book.serializers import BookSerializer data = {'pub_date': 123} serializer = BookSerializer(data=data) serializer.is_valid() # 返回False serializer.errors # {'title': [ErrorDetail(string='This field is required.', code='required')], 'pub_date': [ErrorDetail(string='Date has wrong format. Use one of these formats instead: YYYY[-MM[-DD]].', code='invalid')]} serializer.validated_data # {} data = {'title': 'python'} serializer = BookSerializer(data=data) serializer.is_valid() # True 验证结果返回值 serializer.errors # {} 错误信息 serializer.validated_data # OrderedDict([('btitle', 'python')])
# Return a 400 response if the data was invalid. serializer.is_valid(raise_exception=True)
如果觉得这些还不够，需要再补充定义验证行为，可以使用以下三种方法：
1) validate_字段名
对<field_name>
class BookSerializer(serializers.Serializer): """图书数据序列化器""" ... def validate_title(self, value): if 'django' not in value.lower(): raise serializers.ValidationError("图书不是关于Django的") return value
测试
from book.serializers import BookSerializer data = {'title': 'python'} serializer = BookSerializer(data=data) serializer.is_valid() # False serializer.errors # {'title': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}
在序列化器中需要同时对多个字段进行比较验证时，可以定义validate方法来验证，如
class BookSerializer(serializers.Serializer): """图书序列化器""" ... def validate(self, attrs): read = attrs['read'] comment = attrs['comment'] if read < comment: raise serializers.ValidationError('阅读量小于评论量，不可以通过') return attrs
测试
from book.serializers import BookSerializer data = {'title': 'about django', 'read': 10, 'comment': 20} s = BookSerializer(data=data) s.is_valid() # False s.errors # {'non_field_errors': [ErrorDetail(string='阅读量小于评论量', code='invalid')]}
在字段中添加validators选项参数，也可以补充验证行为，如
def about_django(value): if 'django' not in value.lower(): raise serializers.ValidationError("图书不是关于Django的") class BookSerializer(serializers.Serializer): """图书序列化器""" id = serializers.IntegerField(label='ID', read_only=True) title = serializers.CharField(label='名称', max_length=20, validators=[about_django]) pub_date = serializers.DateField(label='发布日期', required=False) read = serializers.IntegerField(label='阅读量', required=False) comment = serializers.IntegerField(label='评论量', required=False)
测试：
from book.serializers import BookSerializer data = {'title': 'python'} serializer = BookSerializer(data=data) serializer.is_valid() # False serializer.errors # {'title': [ErrorDetail(string='图书不是关于Django的', code='invalid')]}
反序列化总结:
setting下的url
from django.contrib import admin from django.urls import path,include urlpatterns = [ path('admin/', admin.site.urls), path('unser/', include('unser.urls')), ]
unser下url
from django.urls import re_path,path from . import views urlpatterns = [ path("books/", views.BookView.as_view()), ]
models
from django.db import models class Book(models.Model): """图书模型""" title = models.CharField(verbose_name='名称', max_length=20) pub_date = models.DateField(verbose_name='发布日期') read = models.IntegerField(verbose_name='阅读量',default=0) comment = models.IntegerField(verbose_name='评论量', null=True, blank=True) class Meta: db_table = "tb_book" verbose_name="图书" verbose_name_plural=verbose_name def __str__(self): return self.title
serializers
from rest_framework import serializers # 外部函数设置为验证函数 def check_title(data): if data == "django入门": raise serializers.ValidationError("这本书，我定了，你不能叫") class BookSerializer(serializers.Serializer): # 字段声明 # 字段 = serializers.字段类型(验证选项) title = serializers.CharField(required=True, max_length=20,validators=[check_title]) pub_date = serializers.DateField(required=True) read = serializers.IntegerField(default=0,min_value=0, error_messages={"min_value":"对不起，当前字段必须大于或等于0"}) comment = serializers.IntegerField(allow_null=True) # 自定义方法设置校验方法 # validate_字段(字段值) 用于验证指定字段 # validate(客户端提交的所有数据) 用于验证多个字段[联合验证] def validate_title(self, data): if("oldboy" in data): # 跑出错误 raise serializers.ValidationError("对不起，图书名不能包含oldboy！") # 必须在校验完成以后，返回结果 return data def validate(self, data): read = data.get("read") comment = data.get("comment") if(comment>read): raise serializers.ValidationError("对不起，阅读量不能小于评论量，喷子！") return data
views
from django.views import View from django.http import JsonResponse from .serializers import BookSerializer class BookView(View): """使用序列化器完成反序列化和验证数据功能""" def get(self, request): """添加一个图书信息""" # data_bytes = request.body # import json # data_dict = json.loads(data_bytes) # print(data_dict) # {'title': 'python入门'} data_dict = { "title": "django入门", "pub_date": "2009-10-10", # "read": -10000, # 模拟失败的情况 "read": 10000, "comment": 300 } # 使用序列化器进行反序列化校验 serializer = BookSerializer(data=data_dict) ret = serializer.is_valid(raise_exception=True) # raise_exception=True 主动停止程序执行，并抛出错误 print(ret) # 获取校验后的错误信息 print(serializer.errors) """打印效果: {'read': [ErrorDetail(string='对不起，当前字段必须大于或等于0', code='min_value')]} """ # 获取校验后的数据 print(serializer.validated_data) """打印效果： from collections import OrderedDict OrderedDict([ ('title', 'python入门'), ('pub_date', datetime.date(2009, 10, 10)), ('read', 10000), ('comment', 300) ]) """ return JsonResponse({"message": "ok"})
前面的验证数据成功后,我们可以使用序列化器来完成数据反序列化的过程.这个过程可以把数据转成模型类对象.
class BookSerializer(serializers.Serializer):
"""图书数据序列化器"""
...
def create(self, validated_data): """添加数据""" instance = Book.objects.create(**validated_data) return instance def update(self, instance, validated_data): """修改数据""" instance.title = validated_data.get("title") instance.pub_date = validated_data.get("pub_date") instance.read = validated_data.get("read") instance.comment = validated_data.get("comment") # 下面的save是调用了ORM中提供给模型保存数据的save，不是序列化器中的save instance.save() return instance
views
from django.views import View from django.http import JsonResponse from .serializers import BookSerializer class BookView(View): """使用序列化器完成反序列化和验证数据功能""" # 新增 def get2(self,request): """使用序列化器在反序列化时添加数据""" data_dict = { "title":"路飞项目实战1990", "pub_date":"2009-10-10", "read": 10000, "comment": 300 } serializer = BookSerializer(data=data_dict) serializer.is_valid(raise_exception=True) # 调用序列化器内部保存数据的方法[自动调用create或者update] # 在源码save方法207行中，系统通过判断初始化序列化器时是否传递了instance参数作为判断依据， # 传递了instance，则save方法中调用update # 没有传递instance，则save方法中调用create serializer.save() return JsonResponse({"message":"ok"}) # 编辑 def get(self,request): """使用图序列化器在反序列化时修改数据""" data_dict = { "title":"路飞项目实战2019", "pub_date":"2019-10-10", "read": 10000, "comment": 300 } pk = 2 # 编辑 book = Book.objects.get(pk=pk) serializer = BookSerializer(instance=book, data=data_dict) serializer.is_valid(raise_exception=True) serializer.save() return JsonResponse(serializer.data)
方法返回一个数据对象实例了
book = serializer.save()
如果创建序列化器对象的时候，没有传递instance实例，则调用save()方法的时候，create()被调用，相反，如果传递了instance实例，则调用save()方法的时候，update()被调用。
from .serializers import BookSerializer data = {'title': 'python入门指南'} serializer = BookSerializer(data=data) serializer.is_valid() # True serializer.save() # <BookInfo: python入门指南> from .models import Book book = Book.objects.get(id=2) data = {'title': 'django入门指南'} serializer = BookSerializer(book, data=data) serializer.is_valid() # True serializer.save() # <BookInfo: django入门指南> book.title # 'django入门指南'
1） 在对序列化器进行save()保存时，可以额外传递数据，这些数据可以在create()和update()中的validated_data参数获取到
# request.user 是django中记录当前登录用户的模型对象 serializer.save(自定义字段名=request.user,自定义字段名2=xxx)
2）默认序列化器必须传递所有required的字段，否则会抛出验证异常。但是我们可以使用partial参数来允许部分字段更新
# Update `comment` with partial data serializer = CommentSerializer(comment, data={'content': u'foo bar'}, partial=True)
如果我们想要使用序列化器对应的是Django的模型类，DRF为我们提供了ModelSerializer模型类序列化器来帮助我们快速创建一个Serializer类。
-
基于模型类自动生成一系列字段声明
-
基于模型类自动为Serializer生成validators，比如unique_together
-
包含默认的create()和update()的实现
创建模型序列化器
from rest_framework import serializers class BookModelSerializer(serializers.ModelSerializer): # ModelSerializer 模型序列化器
class BookModelSerializer(serializers.ModelSerializer): """图书数据序列化器""" # 元类 class Meta: model = Book # 生命当前使用的模型类 fields = '__all__' # 复制所有的字段声明 fields = ['id','title']# 选择字段 exclude = ['read'] # 排除字段
-
-
fields 指明为模型类的哪些字段生成
>>> from booktest.serializers import BookSerializer >>> serializer = BookSerializer() >>> serializer BookSerializer(): id = IntegerField(label='ID', read_only=True) title = CharField(label='名称', max_length=20) pub_date = DateField(allow_null=True, label='发布日期', required=False) read = IntegerField(label='阅读量', max_value=2147483647, min_value=-2147483648, required=False) comment = IntegerField(label='评论量', max_value=2147483647, min_value=-2147483648, required=False)
class BookSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = Book fields = "__all__"
class BookSerializer(serializers.ModelSerializer): """图书数据序列化器""" class Meta: model = Book exclude = ('pub_date',)
3) 显示指明字段，如：
class BookSerializer(serializers.ModelSerializer): class Meta: model = Book fields = ('id', 'title', 'comment', 'read')
4) 指明只读字段
class BookSerializer(serializers.ModelSerializer): """图书序列化器""" class Meta: model = Book fields = ('id', 'title', 'pub_date'， 'read', 'comment') read_only_fields = ('id', 'read', 'comment')
class BookSerializer(serializers.ModelSerializer): """图书序列化器""" class Meta: model = Book fields = ('id', 'title', 'pub_date', 'read', 'comment') extra_kwargs = { 'read': {'min_value': 0, 'required': True}, 'comment': {'min_value': 0, 'required': True}, } # BookSerializer(): # id = IntegerField(label='ID', read_only=True) # title = CharField(label='名称', max_length=20) # pub_date = DateField(allow_null=True, label='发布日期', required=False) # read = IntegerField(label='阅读量', max_value=2147483647, min_value=0, required=True) # comment = IntegerField(label='评论量', max_value=2147483647, min_value=0, required=True)
模型序列化
serializers
"""使用模型类序列化器""" from rest_framework import serializers from .models import Book class BookModelSerializer(serializers.ModelSerializer): """字段声明""" """元类""" class Meta: model = Book # 声明当前使用的模型类 fields = "__all__" # 复制所有的字段声明过来
view
"""使用模型类序列化器""" from .serializers import BookModelSerializer from .models import Book class BookView2(View): def get1(self,request): """使用模型类序列化器进行序列化""" """提供所有的图书信息""" book_list = Book.objects.all() serializer = BookModelSerializer(instance=book_list, many=True) return JsonResponse(serializer.data,safe=False)
模型反序列化
serializers
"""使用模型类序列化器""" from rest_framework import serializers from .models import Book class BookModelSerializer(serializers.ModelSerializer): """字段声明""" """元类""" class Meta: model = Book # 声明当前使用的模型类 fields = "__all__" # 复制所有的字段声明过来 # fields = ["id","title","read","pub_date"] # 额外的字段声明 extra_kwargs = { "title":{ "error_messages":{"max_length":"对不起，当前字段不能超过20个字符"} } } # 自定义方法设置校验方法 def validate_title(self, data): if("oldboy" in data): # 跑出错误 raise serializers.ValidationError("对不起，图书名不能包含oldboy！") # 必须在校验完成以后，返回结果 return data def validate(self, data): read = data.get("read") comment = data.get("comment") if(comment>read): raise serializers.ValidationError("对不起，阅读量不能小于评论量，喷子！") return data
views
"""使用模型类序列化器""" from .serializers import BookModelSerializer from .models import Book class BookView2(View): def get(self,request): data_dict = { "title":"django入门3333", "pub_date":"2009-10-10", # "read": -10000, # 模拟失败的情况 "read": 100, "comment": 30 } serializer = BookModelSerializer(data=data_dict) serializer.is_valid(raise_exception=True) print(serializer.errors) serializer.save() return JsonResponse(serializer.validated_data, safe=False)
