Django視圖基類

Django視圖基類

Django REST framwork 提供的視圖的主要做用：

• 控制序列化器的執行（檢驗、保存、轉換數據）
• 控制數據庫查詢的執行

一 、視圖

REST framework 提供了衆多的通用視圖基類與擴展類，以簡化視圖的編寫。

二 、兩個視圖基類

2.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'^students/$', views.StudentsAPIView.as_view()),
class StudentsAPIView(APIView):
    
    def get(self, request):
        data_list = Student.objects.all()
        serializer = StudentModelSerializer(instance=data_list, many=True)
        return Response(serializer.data)

2.2 GenericAPIView ( 通用視圖類 )

rest_framework.generics.GenericAPIView

繼承自APIVIew，主要增長了操做序列化器和數據庫查詢的方法，做用是爲下面Mixin擴展類的執行提供方法支持。一般在使用時，可搭配一個或多個Mixin擴展類。

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

屬性

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

2.2.2 方法：

2.2.2.1 get_serializer_class(self)

當出現一個視圖類中調用多個序列化器時,那麼能夠經過條件判斷在get_serializer_class方法中經過返回不一樣的序列化器類名就能夠讓視圖方法執行不一樣的序列化器對象了。

返回序列化器類，默認返回serializer_class，能夠重寫，例如：

def get_serializer_class(self):
        if self.request.user.is_staff:
            return FullAccountSerializer
        return BasicAccountSerializer

2.2.2.2 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 指明過濾控制後端

爲了方便學習上面的GenericAPIView通用視圖類，咱們新建一個子應用。

python manage.py startapp gen

代碼：

from rest_framework.generics import GenericAPIView

from students.models import Student
from .serializers import StudentModelSerializer, StudentModel2Serializer
from rest_framework.response import Response

class StudentsGenericAPIView(GenericAPIView):
    # 本次視圖類中要操做的數據[必填]
    queryset = Student.objects.all()
    # 本次視圖類中要調用的默認序列化器[玄天]
    serializer_class = StudentModelSerializer

    def get(self, request):
        """獲取全部學生信息"""
        serializer = self.get_serializer(instance=self.get_queryset(), many=True)

        return Response(serializer.data)

    def post(self,request):

        data = request.data

        serializer = self.get_serializer(data=data)

        serializer.is_valid(raise_exception=True)

        instance = serializer.save()

        serializer = self.get_serializer(instance=instance)

        return Response(serializer.data)


class StudentGenericAPIView(GenericAPIView):
    queryset = Student.objects.all()

    serializer_class = StudentModelSerializer

    def get_serializer_class(self):
        """重寫獲取序列化器類的方法"""
        if self.request.method == "GET":
            return StudentModel2Serializer
        else:
            return StudentModelSerializer

    # 在使用GenericAPIView視圖獲取或操做單個數據時,視圖方法中的表明主鍵的參數最好是pk
    def get(self,request,pk):
        """獲取一條數據"""
        serializer = self.get_serializer(instance=self.get_object())

        return Response(serializer.data)

    def put(self,request,pk):

        data = request.data

        serializer = self.get_serializer(instance=self.get_object(),data=data)

        serializer.is_valid(raise_exception=True)

        serializer.save()

        serializer = self.get_serializer(instance=self.get_object())

        return Response(serializer.data)

序列化器類：

from rest_framework import serializers

from students.models import Student

class StudentModelSerializer(serializers.ModelSerializer):
    class Meta:
        model= Student
        fields = "__all__"


class StudentModel2Serializer(serializers.ModelSerializer):
    class Meta:
        model= Student
        fields = ("name","class_null")