django views_sets

django views_sets前言ViewSet只是一种基于类的视图,它不提供任何方法处理程序(如.get()或.post()),而是提供诸如.list()和.create()之类的操作。ViewSet的方法处理程序

大家好,又见面了,我是你们的朋友全栈君。如果您正在找激活码,请点击查看最新教程,关注关注公众号 “全栈程序员社区” 获取激活教程,可能之前旧版本教程已经失效.最新Idea2022.1教程亲测有效,一键激活。

Jetbrains全系列IDE使用 1年只要46元 售后保障 童叟无欺

前言

ViewSet 只是一种基于类的视图,它不提供任何方法处理程序(如 .get().post()),而是提供诸如.list().create() 之类的操作。
ViewSet 的方法处理程序仅使用 .as_view() 方法绑定到完成视图的相应操作。
通常不是在urlconf中的视图集中显示注册视图,而是要使用路由类注册视图集,该类会自动为你确定 urlconf
 

源码分析

我们首先看一下viewsets.py文件的源码结构,如下图
django views_sets
我们可以看到有5个类

  • ViewSetMixin
  • ViewSet:继承自ViewSetMixinAPIView
  • GenericViewSet:继承自ViewSetMixinGenericAPIView
  • ReadOnlyModelViewSet:继承自RetrieveModelMixinListModelMixinGenericViewSet
  • 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继承了ViewSetMixinAPIView,增删改查需要我们自己定义
 

GenericViewSet

class GenericViewSet(ViewSetMixin, generics.GenericAPIView):
    """
    GenericViewSet 类默认不提供任何操作,但包含通用视图行为的基本集,例如`get_object` 和`get_queryset` 方法。
    """
    pass

GenericViewSet类相比ViewSet,包含了一些视图行为的通用方法
 

视图集特点

  1. 视图集都是优先继承ViewSetMixin类,再继承一个视图类(GenericAPIView或APIView)
  2. ViewSetMixin提供了重写的as_view()方法,继承视图集的视图类,配置路由时调用as_view()必须传入 请求-函数名 映射关系字典
    eg: path('v1/books/<int:pk>/', views.BookGenericViewSet.as_view({"get": "my_get_obj"}))
     

GenericAPIView与APIView 作为两大继承视图的区别

  1. GenericViewSetViewSet都继承了ViewSetMixinas_view都可以配置 请求-函数 映射
  2. GenericViewSet继承的是GenericAPIView视图类,用来完成标准的model类操作接口
  3. 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

版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请联系我们举报,一经查实,本站将立刻删除。

发布者:全栈程序员-站长,转载请注明出处:https://javaforall.net/166126.html原文链接:https://javaforall.net

(0)
上一篇 2022年8月7日 上午9:00
下一篇 2022年8月7日 上午9:16


相关推荐

  • Tengine 2.3.0 发布,阿里巴巴开源的轻量级 Web 服务器「建议收藏」

    Tengine 2.3.0 发布,阿里巴巴开源的轻量级 Web 服务器「建议收藏」Tengine 2.3.0 发布,阿里巴巴开源的轻量级 Web 服务器

    2022年4月21日
    55
  • Canny算法解析,opencv源码实现及实例[通俗易懂]

    Canny算法解析,opencv源码实现及实例[通俗易懂]参考:http://baike.baidu.com/link?url=tkyXCTmiihKboar3IQ7yo-ECZK95tq2Bn02H1aKwGdt00xrbfD6Lezzjk5ArZF0lCnx8rOQiq4d7o24bUDN75_1392ZOUPYgdt3PZsmLrFShttp://blog.csdn.net/xiaowei_cqu/article/details/783

    2022年5月30日
    42
  • 服务器托管双线技术方案怎么写_自己搭建内网穿透服务器全端口

    服务器托管双线技术方案怎么写_自己搭建内网穿透服务器全端口多线路接入技术就是在互联网数据中心(IDC)通过特殊的技术手段把不同的网络接入商(ISP)服务接入到一台服务器上或服务器集群,使服务器所提供的网络服务访问用户能尽可能以同一个ISP或互访速度较快的ISP连接来进行访问,从而解决或者减轻跨ISP用户访问网站的缓慢延迟(南北网络瓶颈)问题。多线路接入是一个技术概念可以有多种具体实现方式,由于大多用户都是网通与电信,为了见简单起见,我们只讨…

    2025年8月11日
    4
  • log4j&&slf4j配置详解

    log4j&&slf4j配置详解log4j amp amp slf4j 详解第一步 加入 log4j 1 2 8 jar 到 lib 下 第二步 在 CLASSPATH 下建立 log4j properties 内容如下 1log4j rootCategory INFO stdout R23log4j appender stdout org apache log4j ConsoleAppen

    2026年3月18日
    3
  • windows下使用labelImg标注图像

    windows下使用labelImg标注图像工作中遇到一个更好用的标注软件,速度快,操作方便,分享一下:https://blog.csdn.net/python_pycharm/article/details/102685591用于深度网络训练的数据集做标注的方法和工具有好多,像Labelme、labelImg、yolo_mark、Vatic、Sloth等等,此处暂时只介绍其中的一种标注工具:labelImg。等到后期…

    2022年6月20日
    51
  • LAN、WAN、WLAN、WiFi之间的区别

    LAN、WAN、WLAN、WiFi之间的区别感觉这几个概念让人傻傻分不清,下面以最常见的路由器来解释这几个概念。LAN1LAN,全称LocalAreaNetwork,中文名叫做局域网。顾名思义,LAN是指在某一区域内由多台计算机互联

    2022年7月4日
    31

发表回复

您的邮箱地址不会被公开。 必填项已用 * 标注

关注全栈程序员社区公众号