Django(58)viewsets视图集详解
前言
ViewSet
只是一种基于类的视图,它不提供任何方法处理程序(如 .get()
或.post()
),而是提供诸如.list()
和 .create()
之类的操作。
ViewSet
的方法处理程序仅使用 .as_view()
方法绑定到完成视图的相应操作。
通常不是在urlconf
中的视图集中显示注册视图,而是要使用路由类注册视图集,该类会自动为你确定 urlconf
。
源码分析
我们首先看一下viewsets.py
文件的源码结构,如下图
我们可以看到有5个类
- ViewSetMixin
- ViewSet:继承自
ViewSetMixin
和APIView
- GenericViewSet:继承自
ViewSetMixin
和GenericAPIView
- ReadOnlyModelViewSet:继承自
RetrieveModelMixin
、ListModelMixin
、GenericViewSet
- ModelViewSet:继承自5大
mixins
工具类和GenericViewSet
ViewSetMixin
通过上述代码结构分析,我们了解到只要知道ViewSetMixin
是干嘛的,其他的类都继承于它。从源码中我们知道,ViewSetMixin
重写了as_view()
方法,源码如下:
def as_view(cls, actions=None, **initkwargs):
"""
由于基于类的视图围绕实例化视图创建闭包的方式,我们需要完全重新实现`.as_view`,并稍微修改创建和返回的视图函数。
对于某些路由配置,initkwargs 的名称和描述可能会被明确覆盖,例如,额外操作的名称。
"""
# 名称和描述 initkwargs 可能会被显式覆盖
cls.name = None
cls.description = None
# 后缀 initkwarg 保留用于显示视图集类型。如果提供了名称,则此 initkwarg 应该无效。
cls.suffix = None
cls.detail = None
# 设置 basename 允许视图反转其操作 url。该值由路由器通过 initkwargs 提供。
cls.basename = None
# actions必须不能为空,否则报错
if not actions:
raise TypeError("The `actions` argument must be provided when "
"calling `.as_view()` on a ViewSet. For example "
"`.as_view({'get': 'list'})`")
# 清理关键字参数
for key in initkwargs:
if key in cls.http_method_names:
raise TypeError("You tried to pass in the %s method name as a "
"keyword argument to %s(). Don't do that."
% (key, cls.__name__))
if not hasattr(cls, key):
raise TypeError("%s() received an invalid keyword %r" % (
cls.__name__, key))
# name和suffix是互斥的
if 'name' in initkwargs and 'suffix' in initkwargs:
raise TypeError("%s() received both `name` and `suffix`, which are "
"mutually exclusive arguments." % (cls.__name__))
def view(request, *args, **kwargs):
self = cls(**initkwargs)
if 'get' in actions and 'head' not in actions:
actions['head'] = actions['get']
self.action_map = actions
# 将方法绑定到actions, 这是与标准视图不同的一点
for method, action in actions.items():
handler = getattr(self, action)
setattr(self, method, handler)
self.request = request
self.args = args
self.kwargs = kwargs
return self.dispatch(request, *args, **kwargs)
update_wrapper(view, cls, updated=())
update_wrapper(view, cls.dispatch, assigned=())
view.cls = cls
view.initkwargs = initkwargs
view.actions = actions
return csrf_exempt(view)
从上述源码中了解到,ViewSetMixin
重写了as_view
方法,as_view
是将请求的方法绑定到了actions
ViewSet
class ViewSet(ViewSetMixin, views.APIView):
"""
默认情况下,基本 ViewSet 类不提供任何操作。
"""
pass
ViewSet
继承了ViewSetMixin
和APIView
,增删改查需要我们自己定义
GenericViewSet
class GenericViewSet(ViewSetMixin, generics.GenericAPIView):
"""
GenericViewSet 类默认不提供任何操作,但包含通用视图行为的基本集,例如`get_object` 和`get_queryset` 方法。
"""
pass
GenericViewSet
类相比ViewSet
,包含了一些视图行为的通用方法
视图集特点
- 视图集都是优先继承
ViewSetMixin
类,再继承一个视图类(GenericAPIView或APIView)
ViewSetMixin
提供了重写的as_view()
方法,继承视图集的视图类,配置路由时调用as_view()
必须传入 请求-函数名 映射关系字典
eg: path('v1/books/<int:pk>/', views.BookGenericViewSet.as_view({"get": "my_get_obj"}))
GenericAPIView与APIView 作为两大继承视图的区别
GenericViewSet
和ViewSet
都继承了ViewSetMixin
,as_view
都可以配置 请求-函数 映射GenericViewSet
继承的是GenericAPIView
视图类,用来完成标准的model
类操作接口ViewSet
继承的是APIView
视图类,用来完成不需要model
类参与,或是非标准的model
类操作接口
post
请求在标准的model
类操作下就是新增接口,登陆的post
不满足
post
请求验证码接口,不需要model
类的参与
案例:登陆的post
请求,并不是完成数据的新增,只是用post
提交数据,得到的结果也不是登陆的用户信息,而是登陆的认证信息
ReadOnlyModelViewSet
class ReadOnlyModelViewSet(mixins.RetrieveModelMixin,
mixins.ListModelMixin,
GenericViewSet):
"""
提供默认`list()` 和`retrieve()` 操作的视图集。
"""
pass
ModelViewSet
class ModelViewSet(mixins.CreateModelMixin,
mixins.RetrieveModelMixin,
mixins.UpdateModelMixin,
mixins.DestroyModelMixin,
mixins.ListModelMixin,
GenericViewSet):
"""
一个提供默认 `create()`、`retrieve()`、`update()`、`partial_update()`、`destroy()` 和 `list()` 操作的视图集。
"""
pass
实战案例
视图函数如下
class StudentViewSets(viewsets.ModelViewSet):
queryset = Student.objects.all()
serializer_class = StudentModelSerializer
def my_get(self, request, *args, **kwargs):
response = self.retrieve(request, *args, **kwargs)
return APIResponse(results=response.data)
def my_list(self, request, *args, **kwargs):
response = self.list(request, *args, **kwargs)
return APIResponse(results=response.data)
我们继承自ModelViewSet
,自带5个mixins
工具,我们定义了2个查询方法,然后在urls
中配置
urlpatterns = [
path('v2/student/<int:pk>/', views.StudentViewSets.as_view({"get": "my_get"})),
path('v2/student/', views.StudentViewSets.as_view({"get": "my_list"})),
]
在as_view
中添加了get
请求方式的方法,有pk
调用my_get
代表单查,没有pk
调用my_list
代表群查,这样写的原因就是我们的StudentViewSets
继承了ViewSetMixin
。
Django(58)viewsets视图集详解的更多相关文章
- ThinkPHP视图查询详解
ThinkPHP视图查询详解 参考http://www.jb51.net/article/51674.htm 这篇文章主要介绍了ThinkPHP视图查询,需要的朋友可以参考下 ThinkP ...
- 【转载】D3DXMatrixLookAtLH视图变换函数详解
原文:D3DXMatrixLookAtLH视图变换函数详解 /*D3DXMatrixLookAtLH函数返回的是世界->视图变换矩阵. 视图坐标系和局部坐标系是一样的,都是世界坐标系转换为指定的 ...
- Django 框架篇(四) : 视图(view)详解 以及 路由系统(url)
|--Django的View(视图) |-- CBV和FBV: |-- 给视图增加装饰器: |-- request对象: |-- response对象: |-- Django的路由系统(url): | ...
- Django rest framework (视图类详解)
官网:https://www.django-rest-framework.org/api-guide/viewsets/ 在django rest framework 视图中一共有N个类 第一类:AP ...
- Django之form表单详解
构建一个表单 假设你想在你的网站上创建一个简单的表单,以获得用户的名字.你需要类似这样的模板: <form action="/your-name/" method=" ...
- 068.Python框架Django之DRF视图集使用
一 视图集与路由的使用 使用视图集ViewSet,可以将一系列逻辑相关的动作放到一个类中: list() 提供一组数据 retrieve() 提供单个数据 create() 创建数据 update() ...
- Django路由配置之正则表达式详解
正则表达式详解 urls.py from django.conf.urls import url from . import views urlpatterns = [ url(r'^articles ...
- - > 并查集详解(第二节)
以下是并查集思路详解: 一:概念 并查集处理的是“集合"之间的关系.当给出两个元素的一个无序数对(a,b)时,需要快速“合并”a和b分别所在的集合,这期间需要反复“查找”某元素所在的集合.“ ...
- Django之路由层和视图层详解
路由层 首先我们来看一下,路由层都有哪些东西,其实你看django很人性化,将所有的介绍都放在了简介里面,不信,你看
随机推荐
- adbi学习:so hook实现机制
本篇我们来看看adbi的实现原理,其实里面的知识点前面差不多都有涉及了,没多少新知识.adbi利用hijack程序将libexample.so注入到指定的进程中,并且在进程中加载libexample. ...
- 【翻译】WPF中的数据绑定表达式
有很多文章讨论绑定的概念,并讲解如何使用StaticResources和DynamicResources绑定属性.这些概念使用WPF提供的数据绑定表达式.在本文中,让我们研究WPF提供的不同类型的数据 ...
- Thinking in UML 笔记(一) -- 面向对象
一.UML 中最重要的就是面向对象. 面向对象的认识论可以构建更为复杂的系统来解释复杂的世界. 1. 面向过程,一切都是相互紧密地联系在一起,互相作用,互相影响. 2.面向对象, 世界是分割开的,只有 ...
- ROS之初见Hello World
前言 最近在玩ROS,笔记中断了一段时间. ROS即Robot Operating System,机器人操作系统,是一个开源框架,主力语言是C++和python,提供了硬件抽象.设备驱动.库函数.可视 ...
- 炸天的3D引擎OpenCASCADE的用法及案例(https://blog.csdn.net/xipengbozai/article/details/117044032?spm=1001.2014.3001.5502)
What CASCADE?Open CASCADE(简称OCC)平台是由法国Matra Datavision公司开发的CAD/CAE/CAM软件平台,可以说是世界上最重要的几何造型基础软件平台之一.开 ...
- Docker Swarm(九)资源限制
资源限制 docker run 針對限制容器資源有許多設置選項,但Swarm中的 docker service 是另一回事,目前只有cpu和memory的選項可以操作. 如果 docker 找不到足夠 ...
- tail -n 10 /etc/passwd
# tail -n 10 /etc/passwdrpc:x:32:32:Rpcbind Daemon:/var/lib/rpcbind:/sbin/nologinchrony:x:992:987::/ ...
- 基于LNMP架构搭建wordpress个人博客
搭建过程 注意防火墙和selinux的影响可以先关闭. 一.安装nginx # 1.更改nginx源安装nginx [root@web01 ~]# vi /etc/yum.repos.d/nginx. ...
- vim 编辑器高级用法
vim编辑器介绍 如果没有安装vim使用下面方式安装 yum -y install vim vi与vim的不同 两者最大的不同:vim可以高亮显示,vi不可以. vim三种工作模式 普通模式 # 光标 ...
- Linux服务之批量部署篇
批量部署步骤: 1.检查环境 getenforce #检查内核防火墙是否关闭 systemctl status firewalld #检查firewalld是否 ...