Django REST framework 中 3 种类视图的对比

时间:2023-01-18 17:08:20

相较于使用基于方法(function based)的视图,我们更加倾向使用基于类(class based)的视图。接下来,你将看到这是一个强大的模式,是我们能够重用公共的功能,并且,帮我们减少重复的造*。

我们现在开始了。首先,重写根视图(root view),变成基于类的视图。所涉及的,只是对 views.py 文件的一点重构。

一、使用基于 APIView 类的视图

from testapps.models import Testapp
from testapps.serializers import TestappSerializer
from django.http import Http404
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status

class TestappList(APIView):
"""
列出所有代码片段(testapps), 或者新建一个代码片段(testapp).
"""
    def get(self, request, format=None):
        testapps = Testapp.objects.all()
        serializer = TestappSerializer(testapps, many=True)
        return Response(serializer.data)

    def post(self, request, format=None):
        serializer = TestappSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

至此为止,一切顺利。看起来,跟基于方法的差别不大,但我们将各个 HTTP 请求方法之间,做了更好的分离。接着,我们将同样的更改我们,处理片段详细的视图,继续我们的  views.py  文件:

class TestappDetail(APIView):

"""
读取, 更新 or 删除一个代码片段(testapp)实例(instance).
"""
    def get_object(self, pk):
        try:
            return Testapp.objects.get(pk=pk)
        except Testapp.DoesNotExist:
            raise Http404

    def get(self, request, pk, format=None):
        testapp = self.get_object(pk)
        serializer = TestappSerializer(testapp)
        return Response(serializer.data)

    def put(self, request, pk, format=None):
        testapp = self.get_object(pk)
        serializer = TestappSerializer(testapp, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

    def delete(self, request, pk, format=None):
        testapp = self.get_object(pk)
        testapp.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)

看起来不错。但还是跟基于方法的视图,差别不多。

我们也需要重构 urls.py文件,因为我们现在使用的是基于类的视图。

from django.conf.urls import url
from rest_framework.urlpatterns import format_suffix_patterns
from testapp import views

urlpatterns = [
    url(r'^testapp/$', views.TestappList.as_view()),
    url(r'^testapp/(?P<pk>[0-9]+)/$', views.TestappDetail.as_view()),
]

urlpatterns = format_suffix_patterns(urlpatterns)

好,搞定。如果你跑起开发者服务器,应该跟之前的效果是一样的。

二、使用 Mixins 类的视图

使用类视图的一大好处是,我们可以很容易地,组成可重复使用的行为。

目前为止,我们所用的增删改查操作,在我们创建的,任何支持模型的视图里,都没有太大区别。这些通用的行为,在 REST framework的 Mixin类中,都已经实现了。

让我们看看,使用混合类,如何组建视图。下面同样是我们的 views.py 模块:

from testapp.models import Testapp
from testapp.serializers import Testapperializer
from rest_framework import mixins
from rest_framework import generics

class TestappList(mixins.ListModelMixin,
                  mixins.CreateModelMixin,
                  generics.GenericAPIView):
    queryset = Testapp.objects.all()
    serializer_class = Testapperializer

    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 创建了我们的视图,并且加入了 ListModelMixin 和 CreateModelMixin 。

基本类提供了核心的功能,Mixin 类提供了 .list() 和 .create() 行为。然后,我们显式地在 get 和 post 方法里面,放入对应的行动。非常简单,但目前够用。

class TestappDetail(mixins.RetrieveModelMixin,
                    mixins.UpdateModelMixin,
                    mixins.DestroyModelMixin,
                    generics.GenericAPIView):
    queryset = Testapp.objects.all()
    serializer_class = TestappSerializer

    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)

非常的类似。我们使用了 GenericAPIView 类提供了核心功能,而 Mixin 类提供了 .retrieve() ,.update() 和 .destroy() 行为。

三、使用 Generic 类的视图

使用混 Mixin 类重新视图,相比之前,我们减少了一些代码,但我们还可以更进一步。REST framework 提供了一套已经实现了 Mixin 类的 Generic 视图,我们可以使我们的 views.py 模块,更加瘦身!

from testapps.models import Testapp
from testapps.serializers import TestappSerializer
from rest_framework import generics

class TestappList(generics.ListCreateAPIView):
    queryset = Testapp.objects.all()
    serializer_class = TestappSerializer

class TestappDetail(generics.RetrieveUpdateDestroyAPIView):
    queryset = Testapp.objects.all()
    serializer_class = TestappSerializer

这下够简洁了。代码看起来像是很厉害的,干净的,地道的 Django。

Django REST framework 中 3 种类视图的对比的更多相关文章

  1. Django REST framework 中文文档

    Django REST framework介绍 现在前后端分离的架构设计越来越流行,业界甚至出现了API优先的趋势. 显然API开发已经成为后端程序员的必备技能了,那作为Python程序员特别是把Dj ...

  2. DRF &lpar;Django REST framework&rpar; 中的视图类

    视图说明 1. 两个基类 1)APIView rest_framework.views.APIView APIView是REST framework提供的所有视图的基类,继承自Django的View父 ...

  3. Django REST framework中的版本控制

    1.REST framework版本控制的流程分析 1.1 determine_version方法的执行流程 首先,请求到达REST framework的CBV,执行CBV中的dispatch方法再次 ...

  4. Django rest framework(8)---- 视图和渲染器

    django rest framework 之视图 序列化器    PagerSerialiser from rest_framework import serializers from api im ...

  5. 在django restful framework中设置django model的property

    众所周知,在django的model中,可以某些字段设置@property和setter deleter getter,这样就可以在存入数据的时候进行一些操作,具体原理请参见廖雪峰大神的博客https ...

  6. JWT验证机制【刘新宇】【Django REST framework中使用JWT】

    JWT 在用户注册或登录后,我们想记录用户的登录状态,或者为用户创建身份认证的凭证.我们不再使用Session认证机制,而使用Json Web Token认证机制. 什么是JWT Json web t ...

  7. Django REST framework 中的视图

    1.Request REST framework传入视图的request对象不再是Django默认的Httprequest对象,而是DRF提供的扩展类的Request类的对象 常用属性 request ...

  8. DRF &lpar;Django REST framework&rpar; 中的视图扩展类

    2. 五个扩展类 1)ListModelMixin 列表视图扩展类,提供list(request, *args, **kwargs)方法快速实现列表视图,返回200状态码. 该Mixin的list方法 ...

  9. DRF &lpar;Django REST framework&rpar; 中的Request 与 Response

    DRF中的Request 与 Response 1. Request - REST framework 传入视图的request对象不再是Django默认的HttpRequest对象,而是REST f ...

随机推荐

  1. adb server无法终止问题

    这两天通过python去连接Android手机时,一直提示:Adb connection Error:An existing connection was forcibly closed by the ...

  2. JSTL 的 if else &colon; 有 c&colon;if 没有 else 的处理

    jstl的c:if 没有else 想要实现if...else...: 可以用下面的解决 -------------------------------------------------------- ...

  3. php文件删除unlink&lpar;&rpar;详解

    请记住从PHP文件创建的教训,我们创建了一个文件,名为testFile.txt . $myFile = "testFile.txt"; $fh = fopen($myFile, ' ...

  4. Docker初步认识安装和简单实例

    前话 问题 开发网站需要搭建服务器环境,FQ官网下载软件包,搭建配置nginx,apache,数据库等.官网没有直接可用的运行版本,担心网络流传的非官方发布软件包不安全还得自行编译官方源码安装,忘记步 ...

  5. java 访问器方法中对象引用的问题

    "注意不要编写返回引用可变对象的访问器方法".因为会破坏类的封装性,引用的内容可能会被改变,产生业务逻辑上的错误. 什么是可变对象? 先要搞清楚java中值传递和引用传递的问题,总结如下: 1.对象就 ...

  6. &OpenCurlyDoubleQuote;DBUtility&period;DbHelperSQL”的类型初始值设定项引发异常 &OpenCurlyDoubleQuote;DBUtility&period;DbHelperSQL”的类型初始值设定项引发异常

    今天遇到了一个这样的问题“DBUtility.DbHelperSQL”的类型初始值设定项引发异常“DBUtility.DbHelperSQL”的类型初始值设定项引发异常 也许有和我遇到这问题的人也在这 ...

  7. AIX上面Oracle数据库相关启动

    1,启动停止Oracle实例 (1) su -oracle (2) echo $ORACLE_SID (3) sqlplus /nolog //以不登录到数据库的方式进入sqlplus环境 (4) c ...

  8. SSM框架搭建后在tomcat部署报错lineNumber&colon; 15&semi; columnNumber&colon; 59&semi; 必须为元素类型 &quot&semi;beans&quot&semi; 声明属性 &quot&semi;xmlns&quot&semi;

    删除applicationContext.xml中的文件头上的这个就可以<!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" &q ...

  9. 【模板】AC自动机(简单版)

    我:“woc...AC自动机?” 我:“可以自动AC???” 然鹅... 大佬:“傻...” 我:“(⊙_⊙)?” 大佬:“缺...” 我:“......” (大佬...卒 | 逃...) emm.. ...

  10. ListView鼠标框选实现蓝色蒙板

    此问题留心已久,今日方悉心求之,记录心得. ListView控件,不论Delphi中的TListView还是c#中的ListView,在开启其MultiSelect属性时,鼠标框选只是显示框张,如下图 ...