04-01 兩個視圖基類

兩個視圖基類

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

舉例：

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擴展類的執行提供方法支持。通常在使用時，可搭配一個或多個Mixin擴展類。

提供的關於序列化器使用的屬性與方法

• 屬性：

  • serializer_class 指明視圖使用的序列化器

• 方法：

  • get_serializer_class(self)

    當出現一個視圖類中調用多個序列化器時,那么可以通過條件判斷在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)

    返回序列化器對象，主要用來提供給Mixin擴展類使用，如果我們在視圖中想要獲取序列化器對象，也可以直接調用此方法。

    注意，該方法在提供序列化器對象的時候，會向序列化器對象的context屬性補充三個數據：request、format、view，這三個數據對象可以在定義序列化器時使用。

    • request 當前視圖的請求對象
    • view 當前請求的類視圖對象
    • format 當前請求期望返回的數據格式

提供的關於數據庫查詢的屬性與方法

• 屬性：

  • queryset 指明使用的數據查詢集

• 方法：

  • get_queryset(self)

    返回視圖使用的查詢集，主要用來提供給Mixin擴展類使用，是列表視圖與詳情視圖獲取數據的基礎，默認返回queryset屬性，可以重寫，例如：

    def get_queryset(self):
        user = self.request.user
        return user.accounts.all()
    

  • get_object(self)

    返回詳情視圖所需的模型類數據對象，主要用來提供給Mixin擴展類使用。

    在試圖中可以調用該方法獲取詳情信息的模型類對象。

    若詳情訪問的模型類對象不存在，會返回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() # get_object()方法根據pk參數查找queryset中的數據對象
            serializer = self.get_serializer(book)
            return Response(serializer.data)
    

其他可以設置的屬性

• pagination_class 指明分頁控制類
• filter_backends 指明過濾控制后端