「Django」10-前后端分离
1. WEB应用模式
在开发Web应用中,有两种应用模式:
- 前后端不分离
- 前后端分离
2. api接口
通俗的讲就是通过url返回数据。目前市面上大部分公司开发人员使用的接口服务架构主要有:restful、rpc。
rpc: 远程过程调用[远程服务调用],通过视图函数的函数名进行调用。接口多了,对应函数名和参数就多了,前端在请求api接口时,就会比较难找,容易出现重复的接口
restful: 资源状态转换。把后端所有的数据/文件都看成资源,那么接口请求数据,本质上来说就是对资源的操作了.
- 在url中声明要操作的资源是什么,然后通过http请求的method不同来说明对资源进行哪一种操作。(基于CBV更方便实现,
get -> 获取,post -> 创建,put -> 更新,delete -> 删除
)
3. RESTful API规范
API与用户的通信协议,总是使用HTTPs协议。
域名
https://api.example.com
尽量将API部署在专用域名(会存在跨域问题)https://example.org/api/
API很简单
版本
- URL,如:
https://api.example.com/v1/
- 请求头 跨域时,引发发送多次请求
- URL,如:
路径,视网络上任何东西都是资源,均使用名词表示(可复数)
https://api.example.com/v1/zoos
method
- GET :从服务器取出资源(一项或多项)
- POST :在服务器新建一个资源
- PUT :在服务器更新资源(客户端提供改变后的完整资源)
- PATCH :在服务器更新资源(客户端提供改变的属性)
- DELETE :从服务器删除资源
过滤,通过在url上传参的形式传递搜索条件
https://api.example.com/v1/zoos?limit=10
:指定返回记录的数量https://api.example.com/v1/zoos?offset=10
:指定返回记录的开始位置https://api.example.com/v1/zoos?page=2&per_page=100
:指定第几页,以及每页的记录数https://api.example.com/v1/zoos?sortby=name&order=asc
:指定返回结果按照哪个属性排序,以及排序顺序https://api.example.com/v1/zoos?animal_type_id=1
:指定筛选条件
状态码
1
2
3
4
5
6
7
8
9
10
11
12200 OK - [GET]:服务器成功返回用户请求的数据,该操作是幂等的(Idempotent)。
201 CREATED - [POST/PUT/PATCH]:用户新建或修改数据成功。
202 Accepted - [*]:表示一个请求已经进入后台排队(异步任务)
204 NO CONTENT - [DELETE]:用户删除数据成功。
400 INVALID REQUEST - [POST/PUT/PATCH]:用户发出的请求有错误,服务器没有进行新建或修改数据的操作,该操作是幂等的。
401 Unauthorized - [*]:表示用户没有权限(令牌、用户名、密码错误)。
403 Forbidden - [*] 表示用户得到授权(与401错误相对),但是访问是被禁止的。
404 NOT FOUND - [*]:用户发出的请求针对的是不存在的记录,服务器没有进行操作,该操作是幂等的。
406 Not Acceptable - [GET]:用户请求的格式不可得(比如用户请求JSON格式,但是只有XML格式)。
410 Gone -[GET]:用户请求的资源被永久删除,且不会再得到的。
422 Unprocesable entity - [POST/PUT/PATCH] 当创建一个对象时,发生一个验证错误。
500 INTERNAL SERVER ERROR - [*]:服务器发生错误,用户将无法判断发出的请求是否成功。错误处理,状态码是4xx时,应返回错误信息,error当做key。
1
2
3{
error: "Invalid API key"
}返回结果,针对不同操作,服务器向用户返回的结果应该符合以下规范。
1 | GET /collection:返回资源对象的列表(数组) |
- Hypermedia API,RESTful API最好做到Hypermedia,即返回结果中提供链接,连向其他API方法,使得用户不查文档,也知道下一步应该做什么。
4. 解析器
1 | from rest_framework.parsers import JSONParser, FormParser |
5. 序列化
api接口开发,最核心最常见的一个过程就是序列化,所谓序列化就是把数据转换格式,序列化可以分两个阶段:
序列化: 把我们识别的数据转换成指定的格式提供给别人。
例如:我们在django的ORM中获取到的数据默认是模型对象,但是模型对象数据无法直接提供给前端或别的平台使用,所以我们需要把数据进行序列化,变成字符串或者json数据,提供给别人。
反序列化:把别人提供的数据转换/还原成我们需要的格式。
例如:前端js提供过来的json数据,对于python而言就是字符串,我们需要进行反序列化换成模型类对象,这样我们才能把数据保存到数据库中。
- 接收数据[反序列化]
- 操作数据
- 响应数据[序列化]
6. Django Rest_Framework
核心思想: 缩减编写api接口的代码
Django REST framework是一个建立在Django基础之上的Web 应用开发框架,可以快速的开发REST API接口应用。
github: https://github.com/encode/django-rest-framework/tree/master
教程:https://www.cnblogs.com/wupeiqi/articles/7805382.html
特点
- 提供了定义序列化器Serializer的方法,可以快速根据 Django ORM 或者其它库自动序列化/反序列化;
- 提供了丰富的类视图、Mixin扩展类,简化视图的编写;
- 丰富的定制层级:函数视图、类视图、视图集合到自动生成 API,满足各种需要;
- 多种身份认证和权限认证方式的支持;
- 内置了限流系统;
- 直观的 API web 界面;
- 可扩展性,插件丰富
环境配置
DRF需要以下依赖:
- Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)
- Django (1.10, 1.11, 2.0)
DRF是以Django扩展应用的方式提供的,所以我们可以直接利用已有的Django环境而无需从新创建。
在虚拟环境:
1 | pip install djangorestframework |
使用
1. 添加rest_framework应用
创建django项目后:
1 | django-admin startproject drfdemo |
在settings.py的INSTALLED_APPS中添加’rest_framework’。
1 | INSTALLED_APPS = [ |
接下来就可以使用DRF提供的功能进行api接口开发了。在项目中如果使用rest_framework框架实现API接口,主要有以下三个步骤:
- 将请求的数据(如JSON格式)转换为模型类对象
- 操作数据库
- 将模型类对象转换为响应的数据(如JSON格式)
2.编写流程
2.1 创建模型操作类
1 | class Student(models.Model): |
先创建一个数据库。
1 | create database students charset=utf8; |
在django项目中创建学生子应用。
1 | python manage.py startapp students |
把students子应用添加到INSTALLED_APPS中
主引用中__init__.py
设置使用pymysql作为数据库驱动
1 | import pymysql |
settings.py配置文件中设置mysql的账号密码
1 | DATABASES = { |
终端下,执行数据迁移。
1 | python manage.py makemigrations |
2.2 创建序列化器
在students应用目录中新建serializers.py用于保存该应用的序列化器。
创建一个StudentModelSerializer用于序列化与反序列化。
1 | # 创建序列化器类,回头会在视图中被调用 |
- model 指明该序列化器处理的数据字段从模型类Student参考生成
- fields 指明该序列化器包含模型类中的哪些字段,
__all__
指明包含所有字段
2.3 编写视图
在students应用的views.py中创建视图StudentViewSet,这是一个视图集合。
1 | from rest_framework.viewsets import ModelViewSet |
- queryset 指明该视图集在查询数据时使用的查询集
- serializer_class 指明该视图在进行序列化或反序列化时使用的序列化器
建议继承:
- 增删改查 → ModelViewSet
- 增删 → CreateModelMixin, DestroyModelMixin, GenericViewSet
2.4 定义路由
在students应用的urls.py中定义路由信息。
1 | from . import views |
最后把students子应用中的路由文件加载到总路由文件中.
1 | from django.contrib import admin |
3. 序列化器-Serializer
作用:
1 | 1. 序列化,序列化器会把模型对象转换成字典,经过response以后变成json字符串 |
3.1 定义序列化器
先创建一个新的子应用sers
1 | python manage.py startapp sers |
我们已有了一个数据库模型类students/Student,现在想为这个模型类提供一个序列化器,可以定义如下:
1 | from rest_framework import serializers |
注意:serializer不是只能为数据库模型类定义,也可以为非数据库模型类的数据定义。serializer是独立于数据库之外的存在。
自定义显示:
1 | class UserInfoSerializer(serializers.Serializer): |
ModelSerializer:
1 | class UserInfoSerializer(serializers.ModelSerializers): |
序列化深度:
1 | class UserInfoSerializer(serializers.ModelSerializers): |
请求数据校验 && 生成URL:
1 | from django.conf.urls import url, include |
1 | from rest_framework.views import APIView |
常用字段类型:
字段 | 字段构造方式 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_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页面时,显示的字段帮助提示信息 |
3.2 创建Serializer对象
定义好Serializer类后,就可以创建Serializer对象了。
Serializer的构造方法为:
1 | Serializer(instance=None, data=empty, **kwarg) |
说明:
1)用于序列化时,将模型类对象传入instance参数
2)用于反序列化时,将要被反序列化的数据传入data参数
3)除了instance和data参数外,在构造Serializer对象时,还可通过context参数额外添加数据,如
1 | serializer = StudentSerializer(instance, context={'request': request}) |
通过context参数附加的数据,可以通过Serializer对象的context属性获取。
- 使用序列化器的时候一定要注意,序列化器声明了以后,不会自动执行,需要我们在视图中进行调用才可以。
- 序列化器无法直接接收数据,需要我们在视图中创建序列化器对象时把使用的数据传递过来。
- 序列化器的字段声明类似于form表单系统。
- 开发restful api时,序列化器会帮我们把模型数据转换成字典.
- drf提供的视图会帮我们把字典转换成json,或者把客户端发送过来的数据转换字典.
3.3 序列化器的使用
序列化器的使用分两个阶段:
- 在客户端请求时,使用序列化器可以完成对数据的反序列化。
- 在服务器响应时,使用序列化器可以完成对数据的序列化。
1. 序列化
先查询出一个学生对象,再构造序列化器对象,然后获取序列化数据
1 | from django.views import View |
如果要被序列化的是包含多条数据的查询集QuerySet,可以通过添加many=True参数补充说明
1 | class StudentView(View): |
2. 反序列化
2.1. 数据验证
使用序列化器进行反序列化时,需要对数据进行验证后,才能获取验证成功的数据或保存成模型类对象,即调用
is_valid()
方法,验证成功返回True,否则返回False。
验证失败,可以通过序列化器对象的errors属性获取错误信息,返回字典,包含了字段和字段的错误。如果是非字段错误,可以通过修改REST framework配置中的NON_FIELD_ERRORS_KEY来控制错误字典中的键名。
验证成功,可以通过序列化器对象的validated_data属性获取数据。
在定义序列化器时,指明每个字段的序列化类型和选项参数,本身就是一种验证行为。
新建一个子应用books。
1 | python manage.py startapp books |
在settings.py中的INSTALLED_APPS中新增books子应用。如我们定义一个图书的模型和序列化器,
Book模型,代码:
1 | from django.db import models |
执行数据迁移,代码:
1 | python manage.py makemigrations |
BookSerializer序列化器,代码:
1 | class BookSerializer(serializers.Serializer): |
通过构造序列化器对象,并将要反序列化的数据传递给data构造参数,进而进行验证
1 | from book.serializers import BookSerializer |
is_valid()方法还可以在验证失败时抛出异常serializers.ValidationError,可以通过传递raise_exception=True参数开启,REST framework接收到此异常,会向前端返回HTTP 400 Bad Request响应。
1 | # Return a 400 response if the data was invalid. |
如果觉得这些还不够,需要再补充定义验证行为,可以使用以下三种方法:
1)validate_字段名
对<field_name>
字段进行验证,如
1 | class BookSerializer(serializers.Serializer): |
测试:
1 | from book.serializers import BookSerializer |
2) validate
在序列化器中需要同时对多个字段进行比较验证时,可以定义validate方法来验证,如
1 | class BookSerializer(serializers.Serializer): |
测试
1 | from book.serializers import BookSerializer |
3) validators
在字段中添加validators选项参数,也可以补充验证行为,如
1 | def about_django(value): |
测试:
1 | from book.serializers import BookSerializer |
2.2. 保存数据
验证数据成功后,我们可以使用序列化器来完成数据反序列化的过程.这个过程可以把数据转成模型类对象.
可以通过实现create()和update()两个方法来实现。
1 | class BookSerializer(serializers.Serializer): |
如果需要在返回数据对象的时候,也将数据保存到数据库中,则可以进行如下修改
1 | class BookSerializer(serializers.Serializer): |
实现了上述两个方法后,在反序列化数据的时候,就可以通过save()方法返回一个数据对象实例了
1 | book = serializer.save() |
如果创建序列化器对象的时候,没有传递instance实例,则调用save()方法的时候,create()被调用,相反,如果传递了instance实例,则调用save()方法的时候,update()被调用。
1 | from .serializers import BookSerializer |
2.3 附加说明
1) 在对序列化器进行save()保存时,可以额外传递数据,这些数据可以在create()和update()中的validated_data参数获取到
1 | # request.user 是django中记录当前登录用户的模型对象 |
2)默认序列化器必须传递所有required的字段,否则会抛出验证异常。但是我们可以使用partial参数来允许部分字段更新
1 | # Update `comment` with partial data |
3.4 模型类序列化器
如果我们想要使用序列化器对应的是Django的模型类,DRF为我们提供了ModelSerializer模型类序列化器来帮助我们快速创建一个Serializer类。
ModelSerializer与常规的Serializer相同,但提供了:
- 基于模型类自动生成一系列字段
- 基于模型类自动为Serializer生成validators,比如unique_together
- 包含默认的create()和update()的实现
1. 定义
比如我们创建一个BookSerializer
1 | class BookSerializer(serializers.ModelSerializer): |
- model 指明参照哪个模型类
- fields 指明为模型类的哪些字段生成
我们可以在python manage.py shell中查看自动生成的BookSerializer的具体实现
1 | from booktest.serializers import BookSerializer |
2. 指定字段
- 使用fields来明确字段,
__all__
表名包含所有字段,也可以写明具体哪些字段,如
1 | class BookSerializer(serializers.ModelSerializer): |
- 使用exclude可以明确排除掉哪些字段
1 | class BookSerializer(serializers.ModelSerializer): |
- 显示指明字段,如:
1 | class BookSerializer(serializers.ModelSerializer): |
- 指明只读字段
可以通过read_only_fields指明只读字段,即仅用于序列化输出的字段
1 | class BookSerializer(serializers.ModelSerializer): |
3. 添加额外参数
我们可以使用extra_kwargs参数为ModelSerializer添加或修改原有的选项参数
1 | class BookSerializer(serializers.ModelSerializer): |