【DRF】快速上手 View APIView Viewset

简介

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

---

三者区别

继承关系

    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'})

指定请求调用的函数

---