【Django学习】（十三）Mixins_各种具体通用类&APIView_ViewSet_GenericViewSet_ModelViewSet类视图继承的父类区别

已于 2023-07-18 22:29:15 修改
阅读量614 收藏 2
点赞数 2
分类专栏： django 文章标签： django 学习 python
于 2023-07-14 18:30:00 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_43569834/article/details/131663135
版权
文章介绍了如何在DjangoREST框架中使用mixins来减少代码重复，包括自定义mixins和使用rest_framework提供的mixins。通过继承GenericAPIView和其他mixins，可以方便地实现列表、详情、创建、更新和删除操作，并讨论了APIView、ViewSet和GenericViewSet的区别。
摘要由CSDN通过智能技术生成

上一章我们已经学习了如何使用genericapiview实现过滤、排序、分页功能；

这次学习的是如何使用Mixins的各种具体通用类简化代码量

一、自己定义mixins通用类

1、在视图类里，感觉有很多代码都是重复的，是不是可以把公用逻辑提取出来单独封装呢？

答案是可以的！

我们在utils目录下单独创建一个文件mixins.py提取公共部分

#!/usr/bin/python3
# -*- coding: utf-8 -*-
from rest_framework import status
from rest_framework.response import Response


class ListModelMixin:
    def list(self, request, *args, **kwargs):
        qs = self.get_queryset()
        qs = self.filter_queryset(qs)
        page_queryset = self.paginate_queryset(qs)
        if page_queryset is not None:
            serializer_obj = self.get_serializer(instance=page_queryset, many=True)
            return self.get_paginated_response(serializer_obj.data)
        serializer_obj = self.get_serializer(instance=page_queryset, many=True)
        return Response(serializer_obj.data, status=status.HTTP_200_OK)


class CreateModelMixin:
    def create(self, request, *args, **kwargs):
        serializer_obj = self.get_serializer(data=request.data)
        serializer_obj.is_valid(raise_exception=True)
        serializer_obj.save()
        return Response(serializer_obj.data, status=status.HTTP_201_CREATED)


class RetrieveModelMixin:
    def retrieve(self, request, *args, **kwargs):
        pro = self.get_object()
        serializer_obj = self.serializer_class(instance=pro)
        return Response(serializer_obj.data, status=status.HTTP_200_OK)


class UpdateModelMixin:
    def update(self, request, *args, **kwargs):
        # 查出对应id的数据
        query_data = self.get_object()
        serializer_obj = self.serializer_class(instance=query_data, data=request.data)
        serializer_obj.is_valid()
        # 保存更新的数据
        serializer_obj.save()
        return Response(serializer_obj.data, status=status.HTTP_201_CREATED)


class DestroyModelMixin:
    def destroy(self, request, *args, **kwargs):
        ret = {
            "msg": "删除成功！"
        }
        # 根据id查出对应数据
        query_data = self.get_object()
        # 删除指定数据
        query_data.delete()
        # 一般删除数据的输出为None
        return Response(ret, status=status.HTTP_204_NO_CONTENT)

 2、然后在视图文件中导入

from utils import mixins
class ProjectsDetailViews(mixins.RetrieveModelMixin,
                          mixins.UpdateModelMixin,
                          mixins.DestroyModelMixin,
                          GenericAPIView):
    queryset = ProjectsModel.objects.all()
    serializer_class = ProjectModelSerializer

    def get(self, request, *args, **kwargs):
        return self.retrieve(request, *args, **kwargs)

    # 更新数据
    def put(self, request, *args, **kwargs):
        return self.update(request, *args, **kwargs)

    # 删除数据
    def delete(self, request, *args, **kwargs):
        return self.destroy(request, *args, **kwargs)


# class ProjectsViews(APIView):
class ProjectsViews(mixins.ListModelMixin,
                    mixins.CreateModelMixin,
                    GenericAPIView):
    # 指定当前类视图需要使用的查询集
    queryset = ProjectsModel.objects.all()
    # 指定当前类视图需要使用的序列化器类
    serializer_class = ProjectModelSerializer
    # lookup_field = 'Id'
    # 声明需要使用的引擎类
    filter_backends = [filters.SearchFilter,
                       filters.OrderingFilter
                       ]
    # 定义需要过滤的字段
    search_fields = ['name', 'id']

    # 定义需要排序的字段
    ordering_fields = ['id', 'name']
    # 声明需要使用的分页引擎
    pagination_class = PageNumberPagination

    # 查询全部数据
    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

    # 创建数据
    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)

 如图所示，视图类中继承的父类中的顺序要注意：

  • GenericAPIView只能放在最后位置，因为mixins.py公共逻辑文件中很多方法都是需要继承GenericAPIView的，这里面涉及到mro算法
    • 比如获取列表方法中的get_queryset，我们并没有在misins文件中导入对应的包，当在当前文件中找不到这个方法时，就会依次去其他父类中查找，最后在GenericAPIView这个父类中找到
    • 如果GenericAPIView放在最前面，那么可能会导致有些方法找不到

二、使用rest_framework中的mixins通用类

首先我们可以进入到GenericAPIView视图类里去看下，发现里面已经定义好了很多通用接口类

 再去看具体的接口请求类里面看，发现继承的是GenericAPIView和rest_framework中mixins.py里的ListModelMixin等一些类（如下图例子）

class ListAPIView(mixins.ListModelMixin,
                  GenericAPIView):
    """
    Concrete view for listing a queryset.
    """
    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

 GenericAPIView中的ListAPIView中，返回的是rest_framework中mixins.py里的ListModelMixin的list方法

class ListModelMixin:
    """
    List a queryset.
    """
    def list(self, request, *args, **kwargs):
        queryset = self.filter_queryset(self.get_queryset())

        page = self.paginate_queryset(queryset)
        if page is not None:
            serializer = self.get_serializer(page, many=True)
            return self.get_paginated_response(serializer.data)

        serializer = self.get_serializer(queryset, many=True)
        return Response(serializer.data)

drf框架已经内部定义了一些已经封装好的通用类，而且可以看出代码逻辑和我们自己写的大体上差不多，所以我们可以放心的使用drf框架内的这些封装类以及方法

 导入rest_framework中的mixins包：

# from utils import mixins
from rest_framework import mixins

因为 我们之前定义的通用类名/方法名与drf内置的通用类名/方法名一致，所以视图集内的其他代码可以不用变动

三、使用rest_framework的generics.py文件中的通用类

  • 因为通用类中也继承了GenericAPIView，所以视图类里可以不用再继承了，可以删除
  • 因为通用类CreateAPIView和ListAPIView分别继承了rest_framework中的mixins.CreateModelMixin和mixins.ListModelMixin，分别调用了create方法和list方法，所以在视图类里可以不用再自己写各种接口方法了（下面代码块注释掉的部分）

 

class ProjectsViews(generics.CreateAPIView,
                    generics.ListAPIView,
                    ):
    # 指定当前类视图需要使用的查询集
    queryset = ProjectsModel.objects.all()
    # 指定当前类视图需要使用的序列化器类
    serializer_class = ProjectModelSerializer
    # lookup_field = 'Id'
    # 声明需要使用的引擎类
    filter_backends = [filters.SearchFilter,
                       filters.OrderingFilter
                       ]
    # 定义需要过滤的字段
    search_fields = ['name', 'id']

    # 定义需要排序的字段
    ordering_fields = ['id', 'name']
    # 声明需要使用的分页引擎
    pagination_class = PageNumberPagination

    # 查询全部数据
    # def get(self, request, *args, **kwargs):
    #     return self.list(request, *args, **kwargs)
    #
    # # 创建数据
    # def post(self, request, *args, **kwargs):
    #     return self.create(request, *args, **kwargs)

上面的继承类也可以直接继承generics里的ListCreateAPIView类

class ProjectsViews(generics.ListCreateAPIView):

四、类视图继承的父类区别

1、继承APIView

  1. 如果两个类视图合并，会出现两个get方法会冲突的问题
  2. 如果使用Mixin中提供的拓展方法（action动作），当前DRF是无法识别这些action
  3. class ProjectViewSet(APIView):

2、继承ViewSet视图集

  1. 两个类视图可以合并，尤其是有2个get方法的类视图
  2. 支持这些action，并在定义url路由时，可以在as_view({"请求方法名": "action名称"})
    1. 例如as_view({'get':'retrieve','put':'update','delete':'destroy','patch':'partial_update'})
    2. as_view({'get':'list','post':'create',})
  3. 继承ViewSetMixin()（ViewSetMixin提供的能力，改写as_view()，以便它接受' actions '关键字来执行将HTTP方法绑定到资源上的操作。）,views.APIView
    1. 需要自定义action
    2. 并且不支持分页、过滤、排序功能
  4. class ProjectViewSet(viewsets.ViewSet):

 

class ProjectsViewSet(viewsets.ViewSet):
    # 指定当前类视图需要使用的查询集
    queryset = ProjectsModel.objects.all()
    # 指定当前类视图需要使用的序列化器类
    serializer_class = ProjectModelSerializer
    # lookup_field = 'Id'
    # 声明需要使用的引擎类
    filter_backends = [filters.SearchFilter,
                       filters.OrderingFilter
                       ]
    # 定义需要过滤的字段
    search_fields = ['name', 'id']

    # 定义需要排序的字段
    ordering_fields = ['id', 'name']
    # 声明需要使用的分页引擎
    pagination_class = PageNumberPagination

    def retrieve(self, request, *args, **kwargs):
        # 需要自定义action    
        pass

    def list(self, request, *args, **kwargs):
        pass

    def put(self, request, *args, **kwargs):
        pass

    def destroy(self, request, *args, **kwargs):
        pass

    def create(self, request, *args, **kwargs):
        pass

    def partial_update(self, request, *args, **kwargs):
        pass

3、继承GenericViewSet通用视图集

  1. 两个类视图可以合并，尤其是有2个get方法的类视图

  2. 继承 ViewSetMixin, generics.GenericAPIView

    1. ViewSetMixin提供了路由识别action的能力

  3. 支持分页、过滤、排序功能（因为有继承generics.GenericAPIView）

  4. 可以先声明queryset、serializer_class

  5. 未提供action方法

  6. class ProjectViewSet(viewsets.GenericViewSet):

class ProjectsViewSet(
    mixins.RetrieveModelMixin,
    mixins.UpdateModelMixin,
    mixins.DestroyModelMixin,
    mixins.ListModelMixin,
    mixins.CreateModelMixin,
    viewsets.GenericViewSet):
    # 指定当前类视图需要使用的查询集
    queryset = ProjectsModel.objects.all()
    # 指定当前类视图需要使用的序列化器类
    serializer_class = ProjectModelSerializer
    # lookup_field = 'Id'
    # 声明需要使用的引擎类
    filter_backends = [filters.SearchFilter,
                       filters.OrderingFilter
                       ]
    # 定义需要过滤的字段
    search_fields = ['name', 'id']

    # 定义需要排序的字段
    ordering_fields = ['id', 'name']
    # 声明需要使用的分页引擎
    pagination_class = PageNumberPagination
    # 因为继承了mixins里的各种action方法，所以自定义的action就可以不用写了
    # 如果请求方法为get -> retrieve方法
    # def retrieve(self, request, *args, **kwargs):
    #     pass
    # 如果请求方法为get -> list方法
    # def list(self, request, *args, **kwargs):
    #     pass
    #
    # def update(self, request, *args, **kwargs):
    #     pass
    #
    # def destroy(self, request, *args, **kwargs):
    #     pass
    #
    # def create(self, request, *args, **kwargs):
    #     pass
    #
    # def partial_update(self, request, *args, **kwargs):
    #     pass
🔼因为继承了mixins里的各种action方法，所以自定义的action就可以不用写了（上面被注释的代码！）

上面继承了太多的 mixins，我们可以找个全部继承了这些类的子类 来继承，这就是ModelViewSet模型视图集类

 最后可以简化为：

class ProjectsViewSet(viewsets.ModelViewSet):

高老庄里的高小翠
关注
专栏目录
6.常用视图类APIView、GenericAPIView、ModelViewSet
qq_41891186的博客
04-12 571
视图类APIView、GenericAPIView、ModelViewSet
【Django学习笔记 - 18】：drf请求响应简介、基类（APIView、GenericAPIView）、mixin扩展类与三级视图、视图集与路由
Oh_Python的博客
07-12 683
from rest_framework.response import ResponseResponse(data, status=None, template_name=None, headers=None, content_type=None)注意：Data：为响应准备的序列化处理后的数据； Status：状态码，默认为200； Template_name：模板名称，如果使用HTMLRenderer时需要指明； Headers：用于存放响应头信息的字典； Content_type：响应数据的Conten
django rest_framework中的APIView,ModelViewSet,认证，权限，频率，版本
weixin_30456039的博客
09-20 296
models.py from django.db import models class UserInfo(models.Model): name=models.CharField(max_length=32) pwd=models.CharField(max_length=32) type_choices=((1,"普通用户"),(2,"VIP"),(3...
Django一分钟：封装混入(Mixin)，编写解耦且强大的视图类
最新发布
2201_75632987的博客
09-13 380
Django中无处不在的混入(Mixin)是什么，学习组合式编程思想。
GenericViewSet配合扩展类的使用
非布司他
02-29 512
GenericViewSet配合扩展类的使用 urls.py from django.conf.urls import url, include from rest_framework_extensions.routers import ExtendedSimpleRouter from .views import CompetitionViewSet router = ExtendedSi...
Django 类视图学习笔记（五） 在类视图中使用混合器，Django的Mixins详解（一）
ckk727的博客
02-27 996
前言 Django的类视图提供了许多功能，但有时你可能仅仅只希望用到其中一两个功能。例如，你可能仅仅只想实现一个渲染模板并生成响应的视图，但是又不想使用TemplateView，使用函数视图的话，又会出现重复的代码逻辑。出于这个原因，Django还提供了许多功能独立的混合器，即mixins，例如，仅仅实现渲染模板的功能可以使用 TemplateResponseMixin。通过继承不同的mixin...
0001.关于django中的Mixin以及原理解析
tyltr的博客
05-23 3517
废话不讲，只唠干货！一、引子：在类视图中实现login_required 功能        在函数视图和类视图中实现login_required功能都臭了了大街了，细节不再描述。仅仅用类视图作为切入点。    1.定义LoginRequiredMixin实现校验的动作：class LoginRequiredMixin(object): """ 定义LoginRequiredMix...
[Django]类视图继承关系及实现功能
weixin_42577503的博客
11-27 475
【代码】[Django]类视图继承关系及实现功能。
Django的DRF（二）：APIView(一级视图)、GenericAPIView(二级视图)、三级视图、ViewSets(视图集)、Router(路由)
YFater的博客
09-24 3196
文章目录一.模型类序列化器ModelSerializer1.序列化与反序列化（1）序列化（2）反序列化2.field 一.模型类序列化器ModelSerializer 1.序列化与反序列化 serializers.py: # 定义书籍模型类序列化器 from rest_framework import serializers from Book.models import BookInfo class BookModelSerializer(serializers.ModelSerializer):
Django REST Framework教程(3): 基于类的视图APIView, GenericAPIView和视图集
大江狗
09-14 2249
在前面的教程中我们介绍了什么是符合RESTful规范的API接口，并以博客为例使用了基于函数的视图(FBV)编写了对文章进行增删查改的API。在本篇文章中，我们将使用基于类的视图(Cla...
Django的rest_framework的视图之基于ModelViewSet视图源码解析
05-31
ModelViewSet视图是Django框架的rest_framework模块中的一个视图类，它继承了GenericAPIView和Mixins，提供了对资源的CRUD操作。ModelViewSet视图类中提供了一系列的方法，如list、create、retrieve、update、...
django框架详解
03-27
django框架详细............................................................................................................
Django里rest_framework的视图组件ModelViewSet进行优化视图
xiao-啸
07-25 1366
使用视图组件进行接口优化 使用视图组件的generics进行接口逻辑优化 导入ModelViewSet from rest_framework.viewsets import ModelViewSet 定义序列化类 class BookSerializer(serializers.ModelSerializer): class Meta: model = 指定模型...
Django Rest framework基础使用之View：APIView, mixins, generic, viewsets
aimiandai4698的博客
09-27 650
先看一张图，对DRF的各个APIView，Mixin，Viewset等有个基本印象： 具体使用方法： 1、APIView： 　　DRF 的API视图 有两种实现方式： 　　一种是基于函数的：@api_view 　　一种是基于类的：APIView，APIView是Restframework提供的所有视图的基类，继承自Django的View父类 　　1）@api_view ...
【Django】---Django-restframework
fenfyue的博客
03-21 258
Django的CBVdfr基于CBV比纯粹的CBV功能更加强大，继承于django.views中的View在路由的最后一定要添加/否则会重定向到get请求中。源码都是基于以下的所以先看as_views()源码，调用的本质还是返回一个view一旦用户访问book,比如用get请求访问/book/get请求访问=>view() =>return self.dispatch() =>return get()APIview是DRF的核心，相较于View添加了什么呢？
Django REST 框架详解 05 | 视图家族 Mixins
Baimoc
05-19 930
文章目录零、视图家族一、GenericAPIView：视图家族的基类二、Mixins：视图工具集1.群查查看源码代码实现测试接口2.单查查看源码代码实现测试接口3.单增查看源码代码实现测试接口4.单改查看源码代码实现测试接口 零、视图家族 Django REST framework 为了方便视图类的操作，构建了包括以下几种视图类和工具集： views：API视图 generics：工具视图 mixins：视图工具集 viewsets：视图集 一、GenericAPIView：视图家族的基
猿创征文 | DjangoRESTframework(七)-五个扩展类的使用（Create、ListModel，Retrieve，Update，Destroy）
adminwg的博客
09-09 691
DjangoRESTframework(七)-五个扩展类的使用（CreateModelMixin、ListModelModelMixin，RetrieveModelMixin，UpdateModelMixin，DestroyModelMixin）
viewsets.ModelViewSet代码示例
我就叫贝塔
01-21 638
# 密码课程包分类 class CategoryUserPassViewSet(viewsets.ModelViewSet): # """ # 这一viewset提供了`list`, `create`, `retrieve`, `update` 和 `destroy` # """ queryset = Cls_User_Passwd.objects.all() serializer_class = CategoryUserPassSerializer filt
Django REST framework(九)-视图集ViewSet、GenericViewSet、ModelViewSet、ReadOnlyModelViewSet
adminwg的博客
09-11 1426
Django REST framework(九)-视图集ViewSet、GenericViewSet、ModelViewSet、ReadOnlyModelViewSet
Django发送邮件：send_mail与send_mass_mail详解
"这篇教程详细介绍了Django框架中send_mail功能的使用，旨在帮助学习者掌握如何在Django项目中发送电子邮件。通过示例代码，文章讲解了send_mail和send_mass_mail两个核心函数的用法，以及在settings.py中进行邮件...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

高老庄里的高小翠

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值