Django Restful Framework 基础 Api (三)
常用视图类介绍以及使用
通用视图
drf 基于类的视图允许我们编写可重复使用的模式,并且提供了大量常用视图及其常用模式,运用各类常用视图可以快速构建紧密映射到数据库的 API 视图,而如果视图不符合我们的需求,可以继承于常规的 APIView 类,自行扩展。
在使用通用试图时,我们需要设置几个属性,如下:
1 | from django.contrib.auth.models import User |
若我们想要重写视图类的各种方法,可以如下:
1 | class UserList(generics.ListCreateAPIView): |
甚至,可以通过 .as_view()
方法传递类属性,这样连视图类都不用写了
1 | 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 的对象查找,如:
1 | def get_object(self): |
filter_queryset(self,queryset)
给定一个查询集,使用过滤器进行过滤,返回一个新的查询集,如下:
1 | def filter_queryset(self,queryset): |
get_serializer_class(self)
返回用以序列化的类,默认返回serializer_class
属性
可以覆盖重写以提供动态行为,例如使用不同的序列化器进行读写操作,或为不同类型的用户提供不同的序列化器
例子:
1 | def get_serializer_class(self): |
保存和删除钩子
以下方法由 mixin 类提供,可以很轻松地重写对象的保存和删除行为
perform_create(self,serializer)
,保存新对象实例时由CreateModelMixin
调用perform_update(self,serializer)
,保存现有对象实例时由UpdateModelMixin
调用perform_destroy(self,serializer)
,删除对象实例时由DestroyModelMixin
调用
这些钩子对设置请求中隐含的但不属于请求数据的属性特别有用。例如,可以根据请求用户或基于 URL 关键字参数在对象上设置属性
1 | def perform_create(self,serializer): |
这些钩子的覆盖对于添加保存对象之前或之后发生的行为(如发送确认电子邮件或记录更新)也特别有用
1 | def perform_create(self,serializer): |
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
请求的处理方法
继承自:GenericAPIView
,CreateModelMixin
ListAPIView
仅用于读取模型实例列表,提供一个get
请求的处理方法
继承自:GenericAPIView
,ListModelMixin
RetrieveAPIView
仅用于查询单个模型实例,提供一个get
请求的处理方法
继承自:GenericAPIView
,RetrieveModelMixin
DestroyAPIView
仅用于删除单个模型实例,提供一个delete
请求的处理方法
继承其:GenericAPIView
, DestroyModelMixin
UpdateAPIView
仅用于更新单个模型实例,提供 put
和 patch
请求的处理方法
继承自: GenericAPIView
, UpdateModelMixin
ListCreateAPIView
既可以获取也可以实例集合,也可以创建实例列表,提供 get
和 post
请求的处理方法
继承自: GenericAPIView
, ListModelMixin
,CreateModelMixin
RetrieveUpdateAPIView
既可以查询也可以更新单个实例,提供 get
,put
和 patch
请求的处理方法
继承自: GenericAPIView
, RetrieveModelMixin
,UpdateModelMixin
RetrieveDestroyAPIView
既可以查询也可以删除单个实例,提供 get
和 delete
请求的处理方法
继承自: GenericAPIView
, RetrieveModelMixin
,DestroyModelMixin
RetrieveUpdateDestroyAPIView
同时支持查询,更新,删除,提供 get
,put
,patch
和 delete
请求的处理方法
继承自: GenericAPIView
, RetrieveModelMixin
,UpdateModelMixin
,DestroyModelMixin