所有视图的基类、Mixin类视图、通用视图类、子类视图
APIView是REST framework提供的所有视图的基类,继承自Django的View父类。
APIView与View的不同之处在于:
-
传入到视图方法中的是REST framework的
Request对象,而不是Django的HttpRequeset对象; -
视图方法可以返回REST framework的
Response对象,视图会为响应数据设置(render)符合前端要求的格式; -
任何
APIException异常都会被捕获到,并且处理成合适的响应信息; -
在进行dispatch()分发前,会对请求进行身份认证、权限检查、流量控制。
支持定义的属性:
-
authentication_classes列表或元祖,身份认证类
-
permissoin_classes列表或元祖,权限检查类
-
throttle_classes列表或元祖,流量控制类
在APIView中仍以常规的类视图定义方法来实现get() 、post() 或者其他请求方式的方法。
rest_framework.generics.GenericAPIView:
继承自APIVIew
使用GenericAPIView类一般需要实现queryset属性或者重写get_queryset方法
支持定义的属性:
-
列表视图与详情视图通用:
-
queryset列表视图的查询集
-
serializer_class视图使用的序列化器
-
-
列表视图使用:
-
pagination_class分页控制类
-
filter_backends过滤控制后端
-
-
详情页视图使用:
-
lookup_field查询单一数据库对象时使用的条件字段,默认为'
pk' -
lookup_url_kwarg查询单一数据时URL中的参数关键字名称,默认与look_field相同
-
提供的方法:
-
列表视图与详情视图通用:
-
get_queryset(self)
返回视图使用的查询集,是列表视图与详情视图获取数据的基础,默认返回
queryset属性,可以重写,例如:def get_queryset(self):
user = self.request.user
return user.accounts.all() -
get_serializer_class(self)
返回序列化器类,默认返回
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(self)返回详情视图所需的模型类数据对象,默认使用
lookup_field参数来过滤queryset。 在试图中可以调用该方法获取详情信息的模型类对象。若详情访问的模型类对象不存在,会返回404。
该方法会默认使用APIView提供的check_object_permissions方法检查当前对象是否有权限被访问。
Mixin类视图:
:使用基于类的视图的最大好处之一是它使我们能够轻松地组合可重用的行为。
到目前为止,对于我们创建的任何基于模型操作的API视图,我们一直在使用的create / retrieve / update / delete操作将非常相似。这些常见行为在REST框架的mixin类中实现。
-
mixin类提供用于提供基本视图行为的操作。
-
注意,mixin类提供了操作方法,而不是直接定义处理请求方法(例如
.get()和.post())。 -
mixin类可以从导入
rest_framework.mixins。
*GenericAPIView* 只是提供了数据,对应的访问功能是没有实现的,所以 DRF 还有五个提供方法的混入类,可以完成基本增删改查功能,我们也叫 Mixin 混入类,通过 *GenericAPIView* 与混入类的多继承,可以实现更加复杂的接口功能,*GenericAPIView* 提供数据,而混入类提供操作
UpdateModelMixin、
通用类视图 generics
通过使用mixin类,我们重写了视图,使其使用的代码比以前稍微少一些,但我们还可以更进一步。REST框架提供了一组已经混合在一起的通用视图,我们可以使用它们来进一步精简views.py
子类视图(三级)
1) CreateAPIView
提供 post 方法
继承自: GenericAPIView、CreateModelMixin
2)ListAPIView
提供 get 方法
继承自:GenericAPIView、ListModelMixin
3)RetireveAPIView
提供 get 方法
继承自: GenericAPIView、RetrieveModelMixin
4)DestroyAPIView
提供 delete 方法
继承自:GenericAPIView、DestoryModelMixin
5)UpdateAPIView
提供 put 和 patch 方法
继承自:GenericAPIView、UpdateModelMixin
6)RetrieveUpdateAPIView
提供 get、put、patch方法
继承自: GenericAPIView、RetrieveModelMixin、UpdateModelMixin
7)RetrieveUpdateDestoryAPIView
提供 get、put、patch、delete方法
继承自:GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin
浙公网安备 33010602011771号