Django · DRM Mixin混合类，三行代码让你实现RESTful接口一键部署！

最新推荐文章于 2024-11-02 22:15:39 发布
最新推荐文章于 2024-11-02 22:15:39 发布
阅读量173 收藏
点赞数
分类专栏： Django学习 DRF学习 文章标签： django restful python
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qq_34511096/article/details/132091341
版权
本文介绍了DRFMixin如何通过插件机制封装GET、POST等操作，降低开发复杂度。通过Mixin，如AuthorListView和AuthorDetailView示例展示了如何使用ListCreateAPIView和RetrieveUpdateDestroyAPIView来简化接口开发，同时强调了其适用场景和潜在局限性。
摘要由CSDN通过智能技术生成

DRF Mixin功能引入

在了解Mixin插件前，我们必须先了解什么是Mixin，具体可见这个文章
Mixin机制介绍

Mixin机制的引入，可以大大解放我们的双手，因为DRF通过Mixin已经帮我们把GET/POST/PUT…各种请求完全封装完成！

1. DRF - Mixin做了什么

Mixin其实就是一个插件功能，并且脱离于所有的子类数据，比如我们想给鸭子加一个游泳，给狗加一个游泳功能，那就创建一个SwimMixin，只要让雷继承于这个SwimMixin，就能实现游泳功能，DRF中也是类似的。

需求分析：

这是我们之前使用GenericAPIView实现的接口，尽管已经非常简洁

但是，里面的get方法我们还是要自己去get_serializer，POST还是要自己去save等等，还是比较麻烦

class BookListView(GenericAPIView):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

    def get(self, request):
        """
        	GET里面的ORM操作还是有些繁琐，需要自己去获取
        """
        # self.get_serializer ---> 返回的就是 serializer_class实例化对象
        serializer = self.get_serializer(instance=self.get_queryset(), many=True)
        return Response(serializer.data)

    def post(self, request):
        """
        	POST也要写一大堆东西才能save
        """
        serializer = self.get_serializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        else:
            return Response(serializer.errors, status=status.HTTP_201_CREATED)

DRF中的Mixin直接为我们提供了 增删查改的各种方法，下面是一个使用Mixin的案例

2. 使用Mixin实现AuthorListView

from rest_framework.mixins import CreateModelMixin, UpdateModelMixin, ListModelMixin, RetrieveModelMixin,DestroyModelMixin
class AuthorListView(CreateModelMixin, ListModelMixin, GenericAPIView):
    """
    	因为ListView需要使用两种方式:
    		1.get请求获取全部数据
			2.post创建数据    	
		所以,直接继承CreateModelMixin(创建数据插件),ListModelMixin(列表模型插件)
    """
    queryset = Author.objects.all()
    serializer_class = AuthorSerializer

    def get(self, requset):
        """
        	使用了Mixin，我们直接返回一个self.list就可以
        """
        return self.list(requset)

    def post(self, request):
        # 直接返回self.create就是实现了我们的创建数据
        return self.create(request)

2.1 Mixin源码解析，为什么直接返回list/create就行

POST -> CreateModelMixin源码

class CreateModelMixin:
    """
    Create a model instance. 
    翻译: 创建一个模型示例
    """
    def create(self, request, *args, **kwargs):
    	"""
    		其实可以看到，这里的实现，和我们之前自己去create是类似的
    		所以其实就是帮我们直接把创建的方法封装起来了
    	"""
        serializer = self.get_serializer(data=request.data)
        serializer.is_valid(raise_exception=True)
        self.perform_create(serializer)
        headers = self.get_success_headers(serializer.data)
        # 最后返回的就是一个Response
        return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)

GET -> ListModelMixin源码

class ListModelMixin:
	"""
		ListModelMixin和我们之前自己写的GET也是非常类似
	"""
    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)

2.2 Mixin有哪些？

DRF中的Mixins都存放在rest_framework.mixins库中

from rest_framework.mixins import CreateModelMixin, UpdateModelMixin, ListModelMixin, RetrieveModelMixin,DestroyModelMixin

  1. CreateModelMixin 创建数据的Mixin(一般对应POST请求)

    —> 返回 self.create(request) 即可

  2. ListModelMixin 获取多个数据的Mixin(对应GET请求无主键id的情况)

    —> 返回 self.list(request) 即可

  3. UpdateModelMixin更新数据的Mixin(对于PUT/PATCH请求)

    —> 返回 self.update(request) 即可

  4. RetrieveModelMixin 获取单个数据的Mixin(对应GET请求有主键id的情况)

    ----> 返回 self.retrieve(request) 即可

  5. DestroyModelMixin 删除数据的Mixin(对应DELETE请求)

    ----> 返回 self.destroy(request) 即可

2.3 Mixin案例

以下是基于Mixin实现的完整案例：

AuthorListView是对应POST和GET无主键id的请求

AuthorDetailView对应其他请求和GET有id请求

class AuthorListView(CreateModelMixin, ListModelMixin, GenericAPIView):
    queryset = Author.objects.all()
    serializer_class = AuthorSerializer

    def get(self, requset):
        return self.list(requset)

    def post(self, request):
        return self.create(request)


class AuthorDetailView(DestroyModelMixin, RetrieveModelMixin, UpdateModelMixin, GenericAPIView):
    queryset = Author.objects.all()
    serializer_class = AuthorSerializer

    def get(self, requset,pk):
        return self.retrieve(requset)

    def delete(self, request,pk):
        return self.destroy(request)

    def put(self, request,pk):
        return self.update(request)

3. Mixins + APIView混合使用

上面的虽然已经非常非常的简易了，但是其实可以发现，我们每次写的时候，还是有很多重复的地方

  1. 每次都得继承一大堆东西，太长了
  2. 每次都得定义下get/post/put…但是里面逻辑都一样，完全没必要

！！而DRF考虑我们懒人需求，所以就增加了Mixins和APIVies混用的封装！！！

我们现在这里明白需求，我们的同一个请求接口，其实对应两种情况

  1. 路由传参有pk参数(有主键ID) -> GET多个/PUT/PATCH/DELETE
  2. 没有pk参数(无主键ID) -> POST创建/GET单个

所以，其实，就是分成了两种类，一种类是有 GET/POST并且不需要pk

另一种类就是有GET/DELETE/PUT还得要pk

而DRF为我们直接将这两种情况分别封装出来！

from rest_framework.generics import ListCreateAPIView
from rest_framework.generics import RetrieveUpdateDestroyAPIView

3.1 ListCreateAPIView类

看名字就能看出来，他是一个包含创建+List返回的APIView，那么我们看看他的源码是什么样

class ListCreateAPIView(mixins.ListModelMixin,
                        mixins.CreateModelMixin,
                        GenericAPIView):
    """
    	其实一眼就可以看出来，他就是帮我们继承了两个Mixin还有GenericAPIView
    	然后帮我们写个get和post
    """
    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

    def post(self, request, *args, **kwargs):
        return self.create(request, *args, **kwargs)

所以，ListCreateAPIView其实就是帮我们做了我们觉得麻烦的事情，有了 它以后，我们的代码再次简化！

class AuthorListView(ListCreateAPIView):
    """
        好了,就这三行代码,让你把一个视图写完了！
    """
    queryset = Author.objects.all()
    serializer_class = AuthorSerializer

就这么简单，So Easy的实现了你的接口！！

3.2 RetrieveUpdateDestroyAPIView类

这和3.1一样，一眼看出来，就是查询单个/更新/删除+APIView的封装类

说白了就是PUT/PATCH啥的，我们也不用写了，直接继承完事儿

继承后的代码如下:

class AuthorDetailView(RetrieveUpdateDestroyAPIView):
    """
        还是三行代码,带你又完成了一个接口！
    """
    queryset = Author.objects.all()
    serializer_class = AuthorSerializer

现在，我两个ORM对应的视图，一共20行代码，就完成了接口部分的开发，我们只需要去专注于Model和序列化器就够了！

3.3 其他问题！

现在有小朋友问了，万一我这个接口，我不想要PATCH，老板说这个多余，不要这个，怎么办

有没有什么快速解决办法？？

必须有啊，我们首先要明白，为什么RetrieveUpdateDestroyAPIView能直接帮我们直接把三个全部实现了，是因为人家源码中继承了3个

那你自己直接继承两个不就完事儿了？？PATCH的那个你直接不要了就实现了需求！

但是！！！DRF帮我们写好了！

  1. RetrieveUpdateAPIView ： 只有更新和查询单个，没有删除
  2. RetrieveAPIView ：只有查询单个，连更新都没有
  3. UpdateAPIView ： 只有更新，没有删除和查询
  4. 以此类推，全部都支持，想怎么换怎么换！！

4. 重要提醒

虽然这样写非常的爽，十几行代码完成了你所有的需求，但是！！！！

我们这样写出来的代码可定制度实在太低，如果要实现其他额外的需求，这些写就不够用了

这种只适用于标准接口的开发，而复杂逻辑的开发，还是需要用到基类APIView

APIView我在前面的文章也有讲过，他是实现这些高级封装类的基础类

只有看明白了APIView，才能高度定制自己的Django应用

5. 后续还能够简化代码，使用ViewSet，让我们只需要定义一个类，就能完成有主键和无主键两种接口的开发！具体见后续文章，没有看过基础的简易看看我之前的文章！

RSCompany
关注
专栏目录
【Django项目开发】自定义Mixin方法（六）
python全栈
01-04 474
但是在项目开发的过程中,这5个Mixin子类并不能满足所有的需求,例如进行批量删除操作,所以需要自定义Mixin类,将自定义的Mixin类放到utils工具包中。
Python从0到100（四十一）：Django框架从入门到部署
热门推荐
Hello大家好，我是Dream，如果帮得到你，那我深感荣幸！交流学习、商务合作：https://bbs.csdn.net/topics/614347534
07-19 7万+
Django 是一个强大的 Python Web 框架，用于快速开发安全且易于维护的网站。首先，确保你已经安装了 Python。当我们看到出现如下命令时。
在自定义的django mixins中获取request信息
dangfulin的博客
03-29 276
一，需求描述 需要将当前用户拥有的文章分类信息展示到页面顶部。 前提是从django class-based view 中获取当前用户。 二，问题描述 与使用function view直接获取request信息不同的是，我这里将获取文章分类信息这个通用数据的处理抽象为一个CommonViewMixin，然后供其他class-based view进行继承，代码如下： class CommonViewMixin(object): def get_context_data(self, **kwargs):
十九、Django-restframework之类视图、mixins、通用类视图（四）
Sean_0819的博客
03-09 222
Django-restframework之类视图、mixins、通用类视图
Django、Rest framework访问数据库获取数据
deft_的博客
08-24 2239
Django访问数据库获取数据前言一、django是什么？二、models使用1.在所创建的app文件夹下创建models.py文件2.初始化三、Serializers序列化1.在所创建的app文件夹下创建serializers.py文件2.序列化四、filter使用1.在所创建的app文件夹下创建filter.py文件2.引入models五、构造api1.在所创建的app文件夹下创建apis.py文件2.构造api视图六、设置api路由1.在所创建的app文件夹下创建urls.py文件2.设置路由总结心得
Django中mixin使用
菲宇运维
04-20 3622
什么是mixin mixin模式大致来说可以看成是多继承的一种。但是使用这种多继承的时候，为了防止混乱要注意分清主次（其实这种方式的多继承采用mixin的直译理解比较好，混入，补充合作完成的意思） 使用mixin模式要注意： 首先它必须表示某一种功能，而不是某个物品，如同Java中的Runnable，Callable等 其次它必须责任单一，如果有多个功能，那就写多个Mixin类 ...
Django REST Framework——1. API和RESTful接口规范
花城的博客
12-12 1778
文章目录一、Web架构1.1 前后端混合架构（前后端不分离）1.2 前后端分离架构二、API（Application Programming Interface，应用程序编程接口）三、RESTful接口规范3.1 什么是RESTful规范3.2 RESTful API 设计指南安全保障表识API版本控制路径HTTP动词，即请求方法（method）过滤HTTP状态码1xx（信息）：通信传输协议级信息2xx（成功）：表示客户端的请求已成功接受3xx（重定向 ）：表示客户端必须执行一些其他操作才能完成其请求4xx
项目实战 Python Django 个人网站 电影推荐网站 完整代码
05-31
14. **部署与测试**：完成开发后，你需要将项目部署到服务器，如Heroku或AWS。同时，编写单元测试和集成测试确保所有功能正常工作。 通过这个项目，你将全面了解Django框架的各个层面，从基础的MVT（模型-视图-模板...
Python-Python3开发以及部署RESTfulAPI项目
08-10
本项目旨在介绍如何利用Python3、Django2.0框架、Django REST Framework（DRF）、CentOS7操作系统、uWSGI服务器以及Nginx反向代理来开发和部署RESTful API项目。 1. **Python3**：Python3是Python编程语言的最新...
Django之Restful接口测试-Django自带测试模块(七)
美味的世界
04-27 3035
Django自带测试模块 上章博客写的Restful接口测试使用的是python里的Unittest测试框架，而本章使用Django自带的测试模块。 Django的单元测试使用python的unittest模块，这个模块使用基于类的方法来定义测试。类名为django.test.TestCase,继承于python的unittest.TestCase。 项目的目录结构： |-- Django_St...
Django框架DRF基于mixin来封装的视图
python基础
07-07 622
普通CBV视图： 示例环境搭建：新建一个Django项目，连接Mysql数据库，配置路由、视图函数、序列化单独创建py文件： # 配置路由 from django.conf.urls import url from django.contrib import admin from app01 import views urlpatterns = [ url(r'^admin/', ad...
Django中Mixin和View组合技巧
logarrow的专栏
07-25 1772
Mixin和View的职能区分为：Mixin提供数据，View提供模板和渲染。所以一般get_context_data在Mixin中，get(),post(),head()在View中。Mixin和View不是能随意组合的，必须要注意他们之间的方法的解析顺序，也就是MRO(method resolution order)。下面我列出一些常见的MRO，以便方便的使用组合。 ContextMix
Django 简单的mixins（ContextMixin、TemplateResponseMixin）
一念永恒
10-15 1121
基于类的通用视图 - 展平索引 一、ContextMixin        django.views.generic.base.ContextMixin 属性 extra_context Django 2.0中的新功能： 要包含在上下文中的字典。这是指定一些简单上下文的便捷方式 as_view()。用法示例： from django.views.generic import Templa...
Django 进阶（装饰器，Mixin，信号，模式）
tmpbook的专栏
05-30 6545
抽象models类class BaseProfile(models.Model): USER_TYPES = ( (0, 'Ordinary'), (1, 'SuperHero'), ) user = models.OnToOneField(settings.AUTH_USER_MODEL, primary_key=True) user_
0001.关于django中的Mixin以及原理解析
tyltr的博客
05-23 3523
废话不讲，只唠干货！一、引子：在类视图中实现login_required 功能        在函数视图和类视图中实现login_required功能都臭了了大街了，细节不再描述。仅仅用类视图作为切入点。    1.定义LoginRequiredMixin实现校验的动作：class LoginRequiredMixin(object): """ 定义LoginRequiredMix...
django的一些文件
最新发布
m0_68791463的博客
11-02 208
path('api-docs/', include_docs_urls(title='系统监控-API接口文档')),可以在接口文档页面提示，也可在序列化器模型上加。# 模块coreapi,只针对drf的接口文档。# 在每个类的里面直接加注释，就可以反馈到页面上。'''独立视图集，测试操作所有数据'''help_text='CPU使用率'# 接口文档相关配置。
Django ORM详解: model转字典的几种方法
xiaoming0018的博客
10-31 308
name = models.CharField(max_length=255, unique=True, verbose_name='组名称')create_time = models.DateTimeField(auto_now_add=True, verbose_name='创建时间')update_time = models.DateTimeField(auto_now=True, verbose_name='更新时间')
Django数据模型on_delete属性值
Wgq0731的博客
11-01 311
【代码】Django数据模型on_delete属性值。
Django学习-缓存
weixin_67852201的博客
10-30 356
当遇到这种查询慢的时候 ，我们就可以在查询完数据库的时候，将查询的结果存储到缓存中一份，下次查询的时候直接从缓存中获取，避免查询数据库耗费时间，当然需要设置一个过期时间，来更新缓存。Django中设置缓存-本地内存缓存（测试可以使用，正式都是存储到redis中）Django中设置缓存-文件系统缓存 （不建议使用）Django中设置缓存-数据库缓存。缓存的使用分为整体缓存和局部缓存。
Python Django实现RESTful API接口与数据库操作详解
本篇文章详细介绍了如何使用Python和Django框架来构建RESTful API接口。首先，确保有数据来源，这里提到可以通过Python爬虫抓取网站数据，具体爬虫实现可参考作者之前的文章（//www.jb51.net/article/141661.htm）。...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值