【DRF】快速上手 View APIView Viewset

简介

APIViewViewset 是 DRF 中引入的视图类,Viewset 对 DRF 自身提供的 APIView 进行了再次封装,而 APIView 是对原生 Django View 的封装,灵活运用 APIViewViewset 可以大幅度提升业务开发效率,且大大提升了代码的可维护性。


三者区别

继承关系

    ViewSet(GenericViewSet)        -drf
        APIView(GenericAPIView)    -drf
            View                   -django

【View】

来自 Django 原生中,是所有基于类的view的父类,它负责将视图连接到URL、HTTP 方法调度(GET,POST等)和其它简单的功能。

【APIView】

APIView 是 DRF 中所有view的父类,本身继承于Django的view,只有简单的调度方法和检查。

【ViewSet】

ViewSet 继承了APIView 之外,还加入了 .as_view().initialize_request(),并可以结合 router 映射路由

三者的不同

三者之间最重要的不同在于 mixin

APIView 和 View

在APIView中仍以常规的类视图定义方法来实现get()post() 或者其他请求方式的方法

新增的自定义属性

  • authentication_classes 列表或元祖,身份认证类
  • permissoin_classes 列表或元祖,权限检查类
  • throttle_classes 列表或元祖,流量控制类
请求和返回使用的 DRF 的Request Response而不是django的HttpRequest HttpResponse
请求传入时进行身份验证,并在传给处理方法前进行权限检验
任何APIException都会被捕捉并放入合适的想要中
response返回的内容需是序列化的json

GenericAPIView 和 APIView

GenericAPIView 继承于 APIView

GenericAPIView新加的配置项

  • 【列表视图】与【详情视图】通用

    • queryset 指定作用的 model 数据范围【如果设置了 get_queryset() 这个配置则不生效】
    • serializer_class 设置视图使用的 serializer
  • 【列表视图】使用

    • pagination_class 设置分页
    • filter_backends 设置过滤
  • 【详情页视图】使用

    • lookup_field 查询单一数据库对象时使用的条件字段,默认为'pk'
    • lookup_url_kwarg 查询单一数据时URL中的参数关键字名称,默认与look_field相同

GenericAPIView新加的方法

  • get_queryset()
    【列表视图与详情视图通用】
    返回视图使用的查询集,是列表视图与详情视图获取数据的基础,默认返回queryset属性,可以重写,例如:
def get_queryset(self):
    user = self.request.user
    return user.accounts.all()
  • get_serializer_class()
    【列表视图与详情视图通用】
    返回序列化器类,默认返回serializer_class,可以重写,例如:
def get_serializer_class(self):
    if self.request.user.is_staff:
        return FullAccountSerializer
    return BasicAccountSerializer
  • get_serializer(self, args, *kwargs)
    【列表视图与详情视图通用】
    返回序列化器对象,被其他视图或扩展类使用,如果我们在视图中想要获取序列化器对象,可以直接调用此方法。
    注意,在提供序列化器对象的时候,REST framework会向对象的context属性补充三个数据:request、format、view,这三个数据对象可以在定义序列化器时使用。

  • get_object()
    【详情视图使用】
    返回详情视图所需的模型类数据对象,默认使用lookup_field参数来过滤queryset。
    在试图中可以调用该方法获取详情信息的模型类对象。
    若详情访问的模型类对象不存在,会返回404。
    该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。

# url(r'^books/(?P<pk>\d+)/$', views.BookDetailView.as_view()),
class BookDetailView(GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer
 
    def get(self, request, pk):
        book = self.get_object()
        serializer = self.get_serializer(book)
        return Response(serializer.data)
  • get_serializer_context()
  • filter_queryset()
   GenericAPIView 可组合的 mixin
       mixins.CreateModelMixin
       mixins.ListModelMixin
       mixins.RetrieveModelMixin
       mixins.UpdateModelMixin
       mixins.DestroyModelMixin
   
   GenericAPIView 已经组合的 mixin (与GenericAPIView放在同一目录)
       CreateAPIView = GenericAPIView + mixins.CreateModelMixin (POST 有 create 方法)
       ListAPIView = GenericAPIView + mixins.ListModelMixin (GET 有 list 方法)
       RetrieveAPIView = GenericAPIView + mixins.RetrieveModelMixin (GET 有 retrieve 方法)
       DestroyAPIView = GenericAPIView + mixins.DestroyModelMixin
       UpdateAPIView = GenericAPIView + mixins.UpdateModelMixin
       ListCreateAPIView = GenericAPIView + mixins.ListModelMixin + mixins.CreateModelMixin
       RetrieveUpdateAPIView = GenericAPIView + mixins.RetrieveModelMixin + mixins.UpdateModelMixin
       RetrieveDestroyAPIView = GenericAPIView + mixins.RetrieveModelMixin + mixins.DestroyModelMixin
       RetrieveUpdateDestroyAPIView = GenericAPIView + mixins.RetrieveModelMixin + mixins.DestroyModelMixin + mixins.DestroyModelMixin

ViewSet 和 APIView

ViewSet 和 APIView 的区别:

ViewSet 继承于 APIView 的同时,多了一个 ViewSetMixin
ViewSetMixin 多了一个 .as_view() 方法,可将 get、post 等绑定到指定方法上
ViewSet 需要借助 router 实现配置 url
ViewSetMixin 还多了一个 .initialize_request()
initialize_request 给 request 绑定了很多的 action,主要用于动态的 serializers

GenericViewSet 和 ViewSet

ViewSet 继承于 APIView
GenericViewSet 继承于 GenericAPIView

GenericViewSet 已经组合的 mixin (与 GenericViewSet 放在同一目录)

    ReadOnlyModelViewSet = GenericViewSet + mixins.RetrieveModelMixin + mixins.ListModelMixin
    ModelViewSet = GenericViewSet + mixins.CreateModelMixin + mixins.RetrieveModelMixin + UpdateModelMixin + mixins.DestroyModelMixin + mixins.ListModelMixin

引入Viewset

from rest_framework import viewsets

Viewsets包含的Class(常用的)

0.ViewSetMixin

简介:Viewset的基类,它重写了原来 django view 中 .as_view() 方法,使得注册Url变得更加简单,原生 Django View 通过重写 get 和 post 方法的具体视图来达到实现逻辑
在 Viewset 中则可通过:

view = MyViewSet.as_view({'get': 'list', 'post': 'create'})

指定请求调用的函数


最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 217,734评论 6 505
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 92,931评论 3 394
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 164,133评论 0 354
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 58,532评论 1 293
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 67,585评论 6 392
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 51,462评论 1 302
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,262评论 3 418
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,153评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 45,587评论 1 314
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,792评论 3 336
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,919评论 1 348
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 35,635评论 5 345
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,237评论 3 329
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,855评论 0 22
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,983评论 1 269
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,048评论 3 370
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,864评论 2 354