DRF视图
REST framework 提供了众多的通用视图基类与扩展类,以简化视图的编写。
DRF中提供的视图之间的继承关系
(一)两个基类
1.APIView
位置:rest_framework.views.APIView
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() 或者其他请求方式的方法。类视图继承APIView运用例子如下:
from rest_framework.views import APIView
from rest_framework.response import Response
# url(r'^books/$', views.BookListView.as_view()),
class BookListView(APIView):
def get(self, request):
books = BookInfo.objects.all()
serializer = BookInfoSerializer(books, many=True)
return Response(serializer.data)
2.GenericAPIView
位置:rest_framework.generics.GenericAPIView
继承自APIVIew,增加了对于列表视图
和详情视图
可能用到的通用支持方法。通常使用时,可搭配一个或多个Mixin扩展类。
①支持定义的属性:
>列表视图与详情视图通用:
queryset
列表视图的查询集
serializer_class
视图使用的序列化器
> 列表视图使用:
pagination_class
分页控制类
filter_backends
过滤控制后端
> 详情页视图使用:
lookup_field
查询单一数据库对象时使用的条件字段,默认为’pk’
lookup_url_kwarg
查询单一数据时URL中的参数关键字名称,默认与look_field相同
②提供的方法:
列表视图与详情视图:
get_queryset()
返回视图使用的查询集,是列表视图与详情视图获取数据的基础,默认返回queryset属性,可以重写。get_serializer_class()
返回序列化器类,默认返回serializer_class,可以重写。get_serializer()
返回序列化器对象,被其他视图或扩展类使用,如果我们在视图中想要获取序列化器对象,可以直接调用此方法。get_object()
返回详情视图需要的一个模型对象,默认使用lookup_field参数来过滤queryset
注意,在提供序列化器对象的时候,REST framework会向对象的context属性补充三个数据:request、format、view,这三个数据对象可以在定义序列化器时使用。
(二)五个扩展类
扩展类 | 提供方法 | 用途 |
---|---|---|
ListModelMixin | list() | 获得多条数据对象 |
CreateModelMixin | create() | 新建单一数据对象 |
RetrieveModelMixin | retrieve() | 获得单一数据对象 |
UpdateModelMixin | update(),partial_update() | update()全更新,partial_update()部分更新 |
DestroyModelMixin | destroy() | 删除单⼀一对象 |
(三)几个可用子类
子类 | 提供方法 | 继承自 |
---|---|---|
CreateAPIView | 提供 post 方法 | GenericAPIView、CreateModelMixin |
ListAPIView | 提供 get 方法 | GenericAPIView、ListModelMixin |
RetireveAPIView | 提供 get 方法 | GenericAPIView、RetrieveModelMixin |
DestoryAPIView | 提供 delete 方法 | GenericAPIView、DestoryModelMixin |
UpdateAPIView | 提供 put 和 patch 方法 | GenericAPIView、UpdateModelMixin |
RetrieveUpdateAPIView | 提供 get、put、patch方法 | GenericAPIView、RetrieveModelMixin、UpdateModelMixin |
RetrieveUpdateDestoryAPIView | 提供 get、put、patch、delete方法 | GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin |
(四)DRF视图之间的继承关系
DRF视图关系