本篇介绍DRF在视图层面为我们做的事情。
概述
DRF除了在数据序列化部分简写代码以外,还在视图中提供了简写操作。所以在django原有的django.views.View类基础上,drf封装了多个子类出来提供给我们使用。
Django REST framwork 提供的视图的主要作用:
- 控制序列化器的执行(检验、保存、转换数据)
- 控制数据库查询的执行
- 调用请求类和响应类(这两个类也是由DRF帮我们再次扩展了一些功能类)
始于请求与响应
Request
变化:REST framework 传入视图的request
对象不再是Django默认的HttpRequest
对象,而是REST framework提供的扩展了HttpRequest
类的Request
类的对象:
request对象
(HttpRequest
类) —>request对象
(Request类
)
原因:REST framework 提供了Parser解析器类,在接收到request请求后会自动根据Content-Type
指明的请求数据类型(如JSON、表单等)将请求数据进行parse解析,解析为类字典(QueryDict
)对象保存到Request对象中。
Request对象的数据是自动根据前端发送数据的格式进行解析之后的结果。
无论前端发送的哪种格式的数据,我们都可以以统一的方式读取数据。
常用属性
request.data
request.data
返回解析之后的请求体数据。类似于Django中标准的request.POST
和 request.FILES
属性,但提供如下特性:
- 包含了解析之后的文件和非文件数据
- 包含了对POST、PUT、PATCH请求方式解析后的数据
- 利用了REST framework的parsers解析器,不仅支持表单类型数据,也支持JSON数据
request.query_params
request.query_params
与Django标准的request.GET
相同,表示的是URL上携带的参数。只是更换了更正确的名称而已。
Response
变化:REST framework提供了一个响应类Response
,使用该类构造响应对象时,响应的具体数据内容会被转换(render渲染器对象)成符合前端需求的类型。
REST framework提供了Render
渲染器,用来根据请求头中的Accept
(接收数据类型声明)来自动转换响应数据到对应格式。如果前端请求中未进行Accept声明,则会采用默认方式处理响应数据,我们可以通过配置来修改默认响应格式。
原因:找到DRF的settings文件,我们发现按照下列字典中的设置,这也是根据
restframework/settings.py
1 | REST_FRAMEWORK = { |
构造方式
1 | Response(data, status=None, template_name=None, headers=None, content_type=None) |
data
数据不要是render处理之后的数据,只需传递python的内建类型数据即可,REST framework会使用renderer
渲染器处理data
。
data
不能是复杂结构的数据,如Django的模型类对象,对于这样的数据我们可以使用Serializer
序列化器序列化处理后(转为了Python字典类型)再传递给data
参数。
参数说明:
data
: 为响应准备的序列化处理后的数据;status
: 状态码,默认200;template_name
: 模板名称,如果使用HTMLRenderer
时需指明;headers
: 用于存放响应头信息的字典;content_type
: 响应数据的Content-Type,通常此参数无需传递,REST framework会根据前端所需类型数据来设置该参数。
常用属性
response.data
传给response对象的序列化后,但尚未render处理的数据
response.status_code
状态码的数字
response.content
经过render处理后的响应数据
状态码
为了方便设置状态码,REST framewrok在rest_framework.status
模块中提供了常用状态码常量。
信息告知 - 1xx
1 | HTTP_100_CONTINUE |
成功 - 2xx
1 | HTTP_200_OK |
重定向 - 3xx
1 | HTTP_300_MULTIPLE_CHOICES |
客户端错误 - 4xx
1 | HTTP_400_BAD_REQUEST |
服务器错误 - 5xx
1 | HTTP_500_INTERNAL_SERVER_ERROR |
视图
REST framework 提供了众多的通用视图基类与扩展类,以简化视图的编写。
2个视图基类
APIView
1 | rest_framework.views.APIView |
APIView
是REST framework提供的所有视图的基类,继承自Django的View
父类。
APIView
与View
的不同之处在于:
- 传入到视图方法中的是REST framework的
Request
对象,而不是Django的HttpRequeset
对象; - 视图方法可以返回REST framework的
Response
对象,视图会为响应数据设置(render)符合前端要求的格式; - 任何
APIException
异常都会被捕获到,并且处理成合适的响应信息; - 在进行dispatch()分发前,会对请求进行身份认证、权限检查、流量控制。
支持定义的属性
- authentication_classes 列表或元祖,身份认证类
- permissoin_classes 列表或元祖,权限检查类
- throttle_classes 列表或元祖,流量控制类
在APIView
中仍以常规的类视图定义方法来实现get() 、post() 或者其他请求方式的方法。
增删查改
GenericAPIView
(通用视图类)
1 | rest_framework.generics.GenericAPIView |
使用ViewSet通常并不方便,因为list、retrieve、create、update、destory等方法都需要自己编写,而这些方法与前面讲过的Mixin扩展类提供的方法同名,所以我们可以通过继承Mixin扩展类来复用这些方法而无需自己编写。但是Mixin扩展类依赖与GenericAPIView
,所以还需要继承GenericAPIView
。
GenericViewSet就帮助我们完成了这样的继承工作,继承自GenericAPIView
与ViewSetMixin
,在实现了调用as_view()时传入字典(如{'get':'list'}
)的映射处理工作的同时,还提供了GenericAPIView
提供的基础方法,可以直接搭配Mixin扩展类使用。
举例:
1 | from rest_framework.viewsets import GenericViewSet |
url的定义
1 | urlpatterns = [ |
ModelViewSet
继承自GenericViewSet
,同时包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。
ReadOnlyModelViewSet
继承自GenericViewSet
,同时包括了ListModelMixin、RetrieveModelMixin。
视图集中定义附加action动作
在视图集中,除了上述默认的方法动作外,还可以添加自定义动作。
举例:
1 | from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet |
url的定义
1 | urlpatterns = [ |
action属性
在视图集中,我们可以通过action对象属性来获取当前请求视图集时的action动作是哪个。
例如:
1 | from rest_framework.viewsets import ModelViewSet |
完整代码如下:
views.py
1 | from django.views import View |
urls.py
1 | from django.urls import path, re_path |