DRF中兩大視圖基類APIView/GenericAPIView的介紹

(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() 或者其他請求方式的方法。

(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(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方法檢查當前對象是否有權限被訪問。

舉例：

# url(r'^books/(?P<pk>\d+)/$', views.BookDetailView.as_view()), class BookDetailView(GenericAPIView): queryset = BookInfo.objects.all()　　　　# BookInfo為自己定義的模型數據類 serializer_class = BookInfoSerializer # 自己定義的序列化器 def get(self, request, pk): book = self.get_object() serializer = self.get_serializer(book) return Response(serializer.data)