Django-Restful-Framework-常用视图

通用视图

drf 基于类的视图允许我们编写可重复使用的模式,并且提供了大量常用视图及其常用模式,运用各类常用视图可以快速构建紧密映射到数据库的 API 视图,而如果视图不符合我们的需求,可以继承于常规的 APIView 类,自行扩展。

在使用通用试图时,我们需要设置几个属性,如下:

from django.contrib.auth.models import User
from myapp.serializers import UserSerializer
from rest_framework import generics
from rest_framework.permissions import IsAdminUser

class UserList(generics.ListCreateAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    permission_classes = (IsAdminUser,)

若我们想要重写视图类的各种方法,可以如下:

class UserList(generics.ListCreateAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    permission_classes = (IsAdminUser,)

    def list(self, request):
        # 注意使用`get_queryset()`而不是`self.queryset`
        queryset = self.get_queryset()
        serializer = UserSerializer(queryset, many=True)
        return Response(serializer.data)

甚至,可以通过 .as_view() 方法传递类属性,这样连视图类都不用写了

url(r'^/users/', ListCreateAPIView.as_view(queryset=User.objects.all(), serializer_class=UserSerializer), name='user-list')

GenericAPIView

GenericAPIView 类继承于APIView类,添加了常见行为
内置的每一个通用试图都是通过将GenericAPIView 类和一个或多个 minxin 类相互结合来构建的

基本设置

如上所述,我们需要在视图类中添加属性控制视图的行为:

  • queryset,从此视图返回对象的查询集。通常必须设置此属性,或者通过调用 get_queryset() 方法覆盖
  • serializer_class,用于验证和反序列化输入以及序列化输出的序列化类。通常必须设置,或者调用get_serializer_class()方法覆盖
  • lookup_field,用于执行各个模型实例的对象查找的模型字段。默认为'pk'
  • lookup_url_kwarg,用于对象查找的 URL 关键字参数。URL conf 应该包含与此值相对应的关键字参数。如果未设置,则默认使用与lookup_field相同的值

分页

pagination_class 对列表进行分页时使用的分页类。默认值与DEFAULT_PAGINATION_CLASS设置相同,设置pagination_class = None将禁用此视图的分页

过滤

filter_backends 用于过滤查询集的过滤器类的列表。默认值与DEFAULT_FILTER_CLASS设置相同

方法

get_queryset(self)
返回列表视图的查询集,并应该将其用作查看详细视图的基础。默认返回由 queryset 属性指定的查询集
应该始终使用此方法, 而不是直接访问 self.queryset,因为 REST 会在内部对 self.queryset 的结果进行缓存用于后续所有请求

get_object(self)
返回详细视图的对象实例。默认使用lookup_field参数来过滤基本查询集

可以覆盖重写以提供更复杂的行为,例如基于多个 URL kwarg 的对象查找,如:

def get_object(self):
    queryset=self.get_queryset()
    filter={}
    for field in self.multiple_lookup_fields:
        filter[field]=self.kwargs[field]

    obj=get_object_or_404(queryset,**filter)
    self.check_object_permissions(self.request,obj)
    return obj

filter_queryset(self,queryset)
给定一个查询集,使用过滤器进行过滤,返回一个新的查询集,如下:

def filter_queryset(self,queryset):
    filter_backends=(CategoryFilter,)

    if 'geo_route' in self.request.query_params:
        filter_backends=(GeoRouteFilter,CategoryFilter)
    elif 'geo_point' in self.request.query_params:
        filter_backends=(GeoPointFilter,CategoryFilter)

    for backend in list(filter_backends):
        queryset=backend.filter_queryset(self.request,queryset,view=self)

    return queryset

get_serializer_class(self)
返回用以序列化的类,默认返回serializer_class属性

可以覆盖重写以提供动态行为,例如使用不同的序列化器进行读写操作,或为不同类型的用户提供不同的序列化器

例子:

def get_serializer_class(self):
    if self.request.user.is_staff:
        return FullAccountSerializer
    return BasicAccountSerializer

保存和删除钩子

以下方法由 mixin 类提供,可以很轻松地重写对象的保存和删除行为

  • perform_create(self,serializer),保存新对象实例时由CreateModelMixin调用
  • perform_update(self,serializer),保存现有对象实例时由UpdateModelMixin调用
  • perform_destroy(self,serializer),删除对象实例时由DestroyModelMixin调用

这些钩子对设置请求中隐含的但不属于请求数据的属性特别有用。例如,可以根据请求用户或基于 URL 关键字参数在对象上设置属性

def perform_create(self,serializer):
    serializer.save(user=self.request.user)

这些钩子的覆盖对于添加保存对象之前或之后发生的行为(如发送确认电子邮件或记录更新)也特别有用

def perform_create(self,serializer):
    queryset=SignRequest.object.filter(user=self.request.user):
    if queryset.exists():
        raise ValidationError('You have already signed up')
    serializer.save(user=self.request.user)

Mixins

mixins 类用于提供基本视图行为的操作。mixin类提供操作方法,而不是直接定义处理方法,通过rest_framework.mixins导入

ListModelMixin

提供一个.list(request,*args,**kwargs)方法,实现列出一个查询集

如果查询集已填充,则返回200 OK响应,并将 queryset 的序列化表示形式作为响应的主体

CreateModelMixin

提供.create(request,*arg,**kwargs)方法,实现创建和保存新模型数据实例

如果创建了一个对象,则会返回一个201 Created响应,并将该对象的序列化表示形式作为响应的主体
如果为创建对象提供的请求数据无效,则将返回400 Bad Request响应,并将错误细节作为响应的主体

RetrieveModelMixin

提供.retrieve(request,*args,**kwargs)方法,该方法实现在响应中返回现有的模型实例

如果可以获取对象,则返回200 OK响应,并将对象的序列化表示为响应的主体。否则,将返回一个404 Not Found

UpdateModelMixin

提供.update(request,*args,**kwargs)方法,实现更新和保存现有模型实例。还提供了一个 .partial_update(request, *args, **kwargs) 方法,它与更新方法类似,只是更新的所有字段都是可选的。这允许支持 HTTP PATCH 请求。

如果成功更新对象,则返回 200 OK 响应,并将对象的序列化表示形式作为响应的主体
如果提供的用于更新对象的请求数据无效,则将返回 400 Bad Request 响应,并将错误细节作为响应的主体

DestroyModelMixin

提供一个 .destroy(request, *args, **kwargs) 方法,实现现有模型实例的删除

如果一个对象被删除,则返回一个 204 No Content ,否则它将返回一个 404 Not Found

内置视图类

以下类是具体的通用试图,从rest_framework.generics导入

CreateAPIView

仅用于创建实例,提供一个post请求的处理方法
继承自:GenericAPIViewCreateModelMixin

ListAPIView

仅用于读取模型实例列表,提供一个get请求的处理方法
继承自:GenericAPIViewListModelMixin

RetrieveAPIView

仅用于查询单个模型实例,提供一个get请求的处理方法
继承自:GenericAPIViewRetrieveModelMixin

DestroyAPIView

仅用于删除单个模型实例,提供一个delete请求的处理方法
继承其:GenericAPIViewDestroyModelMixin

UpdateAPIView

仅用于更新单个模型实例,提供 putpatch 请求的处理方法
继承自: GenericAPIViewUpdateModelMixin

ListCreateAPIView

既可以获取也可以实例集合,也可以创建实例列表,提供 getpost 请求的处理方法
继承自: GenericAPIView, ListModelMixinCreateModelMixin

RetrieveUpdateAPIView

既可以查询也可以更新单个实例,提供 getputpatch 请求的处理方法
继承自: GenericAPIView, RetrieveModelMixinUpdateModelMixin

RetrieveDestroyAPIView

既可以查询也可以删除单个实例,提供 getdelete 请求的处理方法
继承自: GenericAPIView, RetrieveModelMixinDestroyModelMixin

RetrieveUpdateDestroyAPIView

同时支持查询,更新,删除,提供 getputpatchdelete 请求的处理方法
继承自: GenericAPIView, RetrieveModelMixinUpdateModelMixinDestroyModelMixin

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

推荐阅读更多精彩内容