DRF之請求響應與檢視元件

阿新 • • 發佈：2022-04-06

請求響應

　　請求Request

　　　　REST framework 傳入檢視的request物件不再是Django預設的HttpRequest物件，而是REST framework提供的擴充套件了HttpRequest類的Request類的物件。

　　　　REST framework 提供了Parser解析器，在接收到請求後會自動根據Content-Type指明的請求資料型別（如JSON、表單等）將請求資料進行parse解析，解析為類字典[QueryDict]物件儲存到Request物件中。

　　　　Request物件的資料是自動根據前端傳送資料的格式進行解析之後的結果。

　　　　無論前端傳送的哪種格式的資料，我們都可以以統一的方式讀取資料。

　　　　常用屬性：

　　　　　　1.data

　　　　　　　　request.data 返回解析之後的請求體資料。類似於Django中標準的request.POST和 request.FILES屬性，但提供如下特性：

- - - 包含了解析之後的檔案和非檔案資料
    - 包含了對POST、PUT、PATCH請求方式解析後的資料
    - 利用了REST framework的parsers解析器，不僅支援表單型別資料，也支援JSON資料

　　　　　　2.query_params

　　　　　　　　request.query_params與Django標準的request.GET相同，只是更換了更正確的名稱而已。

　　響應Response

　　　　REST framework提供了一個響應類Response，使用該類構造響應物件時，響應的具體資料內容會被轉換（render渲染）成符合前端需求的型別。

　　　　REST framework提供了Renderer 渲染器，用來根據請求頭中的Accept（接收資料型別宣告）來自動轉換響應資料到對應格式。如果前端請求中未進行Accept宣告，則會採用預設方式處理響應資料，我們可以通過配置來修改預設響應格式。

　　　　可以在rest_framework.settings查詢所有的drf預設配置項

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES 
': (  # 預設響應渲染類
        'rest_framework.renderers.JSONRenderer',  # json渲染器
        'rest_framework.renderers.BrowsableAPIRenderer',  # 瀏覽API渲染器
    )
}

　　　　構造方式：

Response(data, status=None, template_name=None, headers=None, content_type=None)

　　　　　　data資料不要是render處理之後的資料，只需傳遞python的內建型別資料即可，REST framework會使用renderer渲染器處理data。

　　　　　　data不能是複雜結構的資料，如Django的模型類物件，對於這樣的資料我們可以使用Serializer序列化器序列化處理後（轉為了Python字典型別）再傳遞給data引數。

　　　　　　引數說明：

- - data: 為響應準備的序列化處理後的資料；
  - status: 狀態碼，預設200；
  - template_name: 模板名稱，如果使用HTMLRenderer 時需指明；
  - headers: 用於存放響應頭資訊的字典；
  - content_type: 響應資料的Content-Type，通常此引數無需傳遞，REST framework會根據前端所需型別資料來設定該引數。

　　　　常用屬性

　　　　　　1.data
　　　　　　　　傳給response物件的序列化後，但尚未render處理的資料

　　　　　　2.status_code
　　　　　　　　狀態碼的數字

　　　　　　3.content
　　　　　　　　經過render處理後的響應資料

檢視元件

　　2個檢視基類

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

　　　　　　舉例：

class BookView(APIView):
    def get(self, request):
        book_list = Book.objects.all()
        ser = BookSerializer(instance=book_list, many=True)

        return Response(ser.data)

    def post(self, request):
        ser = BookSerializer(data=request.data)
        if ser.is_valid():
            ser.save()
            return Response({'code': 100, 'msg': '新增成功', 'data': ser.data})
        return Response({'code': 101, 'msg': '新增失敗', 'err': ser.errors})

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

　　　　為了方便學習上面的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")

　　5個檢視擴充套件類

　　　　作用：

　　　　　　提供了幾種後端檢視（對資料資源進行曾刪改查）處理流程的實現，如果需要編寫的檢視屬於這五種，則檢視可以通過繼承相應的擴充套件類來複用程式碼，減少自己編寫的程式碼量。

　　　　　　這五個擴充套件類需要搭配GenericAPIView父類，因為五個擴充套件類的實現需要呼叫GenericAPIView提供的序列化器與資料庫查詢的方法。

　　　　1.ListModelMixin

　　　　　　列表檢視擴充套件類，提供list(request, *args, **kwargs)方法快速實現列表檢視，返回200狀態碼。

　　　　　　該Mixin的list方法會對資料進行過濾和分頁。

　　　　　　原始碼：

class ListModelMixin(object):
    """
    List a queryset.
    """
    def list(self, request, *args, **kwargs):
        # 過濾
        queryset = self.filter_queryset(self.get_queryset())
        # 分頁
        page = self.paginate_queryset(queryset)
        if page is not None:
            serializer = self.get_serializer(page, many=True)
            return self.get_paginated_response(serializer.data)
        # 序列化
        serializer = self.get_serializer(queryset, many=True)
        return Response(serializer.data)

　　　　　　舉例：

from rest_framework.mixins import ListModelMixin

class BookListView(ListModelMixin, GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    def get(self, request):
        return self.list(request)

　　　　2.CreateModelMixin

　　　　　　建立檢視擴充套件類，提供create(request, *args, **kwargs)方法快速實現建立資源的檢視，成功返回201狀態碼。

　　　　　　如果序列化器對前端傳送的資料驗證失敗，返回400錯誤。

　　　　　　原始碼：

class CreateModelMixin(object):
    """
    Create a model instance.
    """
    def create(self, request, *args, **kwargs):
        # 獲取序列化器
        serializer = self.get_serializer(data=request.data)
        # 驗證
        serializer.is_valid(raise_exception=True)
        # 儲存
        self.perform_create(serializer)
        headers = self.get_success_headers(serializer.data)
        return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers)

    def perform_create(self, serializer):
        serializer.save()

    def get_success_headers(self, data):
        try:
            return {'Location': str(data[api_settings.URL_FIELD_NAME])}
        except (TypeError, KeyError):
            return {}

　　　　3.RetrieveModelMixin

　　　　　　詳情檢視擴充套件類，提供retrieve(request, *args, **kwargs)方法，可以快速實現返回一個存在的資料物件。

　　　　　　如果存在，返回200，否則返回404。

　　　　　　原始碼：

class RetrieveModelMixin(object):
    """
    Retrieve a model instance.
    """
    def retrieve(self, request, *args, **kwargs):
        # 獲取物件，會檢查物件的許可權
        instance = self.get_object()
        # 序列化
        serializer = self.get_serializer(instance)
        return Response(serializer.data)

　　　　　　舉例：

class BookDetailView(RetrieveModelMixin, GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    def get(self, request, pk):
        return self.retrieve(request)

　　　　4.UpdateModelMixin

　　　　　　更新檢視擴充套件類，提供update(request, *args, **kwargs)方法，可以快速實現更新一個存在的資料物件。

　　　　　　同時也提供partial_update(request, *args, **kwargs)方法，可以實現區域性更新。

　　　　　　成功返回200，序列化器校驗資料失敗時，返回400錯誤。

　　　　　　原始碼：

class UpdateModelMixin(object):
    """
    Update a model instance.
    """
    def update(self, request, *args, **kwargs):
        partial = kwargs.pop('partial', False)
        instance = self.get_object()
        serializer = self.get_serializer(instance, data=request.data, partial=partial)
        serializer.is_valid(raise_exception=True)
        self.perform_update(serializer)

        if getattr(instance, '_prefetched_objects_cache', None):
            # If 'prefetch_related' has been applied to a queryset, we need to
            # forcibly invalidate the prefetch cache on the instance.
            instance._prefetched_objects_cache = {}

        return Response(serializer.data)

    def perform_update(self, serializer):
        serializer.save()

    def partial_update(self, request, *args, **kwargs):
        kwargs['partial'] = True
        return self.update(request, *args, **kwargs)

　　　　5.DestroyModelMixin

　　　　　　刪除檢視擴充套件類，提供destroy(request, *args, **kwargs)方法，可以快速實現刪除一個存在的資料物件。

　　　　　　成功返回204，不存在返回404。

　　　　　　原始碼：

class DestroyModelMixin(object):
    """
    Destroy a model instance.
    """
    def destroy(self, request, *args, **kwargs):
        instance = self.get_object()
        self.perform_destroy(instance)
        return Response(status=status.HTTP_204_NO_CONTENT)

    def perform_destroy(self, instance):
        instance.delete()

　　　　　　使用GenericAPIView和檢視擴充套件類，實現api介面，程式碼：

"""GenericAPIView結合檢視擴充套件類實現api介面"""
from rest_framework.mixins import ListModelMixin,CreateModelMixin
class Students2GenericAPIView(GenericAPIView,ListModelMixin,CreateModelMixin):
    # 本次檢視類中要操作的資料[必填]
    queryset = Student.objects.all()
    # 本次檢視類中要呼叫的預設序列化器[玄天]
    serializer_class = StudentModelSerializer

    def get(self, request):
        """獲取多個學生資訊"""
        return self.list(request)

    def post(self,request):
        """新增學生資訊"""
        return self.create(request)


from rest_framework.mixins import RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class Student2GenericAPIView(GenericAPIView,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
    queryset = Student.objects.all()

    serializer_class = StudentModelSerializer

    # 在使用GenericAPIView檢視獲取或操作單個數據時,檢視方法中的代表主鍵的引數最好是pk
    def get(self,request,pk):
        """獲取一條資料"""
        return self.retrieve(request,pk)

    def put(self,request,pk):
        """更新一條資料"""
        return self.update(request,pk)

    def delete(self,request,pk):
        """刪除一條資料"""
        return self.destroy(request,pk)

　　9個檢視子類

　　　　1.CreateAPIView

　　　　　　提供 post 方法

　　　　　　繼承自： GenericAPIView、CreateModelMixin

　　　　2.ListAPIView

　　　　　　提供 get 方法

　　　　　　繼承自：GenericAPIView、ListModelMixin

　　　　3.RetrieveAPIView

　　　　　　提供 get 方法

　　　　　　繼承自: GenericAPIView、RetrieveModelMixin

　　　　4.DestoryAPIView

　　　　　　提供 delete 方法

　　　　　　繼承自：GenericAPIView、DestoryModelMixin

　　　　5.UpdateAPIView

　　　　　　提供 put 和 patch 方法

　　　　　　繼承自：GenericAPIView、UpdateModelMixin

　　　　6.RetrieveUpdateAPIView

　　　　　　提供 get、put、patch方法

　　　　　　繼承自： GenericAPIView、RetrieveModelMixin、UpdateModelMixin

　　　　7.RetrieveDestroyAPIView

　　　　　　提供 get、delete方法

　　　　　　繼承自： GenericAPIView、RetrieveModelMixin、DestoryModelMixin

　　　　8.ListCreateAPIView

　　　　　　提供 get、post方法

　　　　　　繼承自： GenericAPIView、ListModelMixin、CreateModelMixin

　　　　9.RetrieveUpdateDestoryAPIVie

　　　　　　提供 get、put、patch、delete方法

　　　　　　繼承自：GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin

from rest_framework.generics import CreateAPIView, ListAPIView, DestroyAPIView, RetrieveAPIView, UpdateAPIView
from rest_framework.generics import ListCreateAPIView, RetrieveUpdateAPIView, RetrieveUpdateDestroyAPIView,RetrieveDestroyAPIView

　　檢視集ViewSet

　　　　使用檢視集ViewSet，可以將一系列邏輯相關的動作放到一個類中：

- list() 提供一組資料
- retrieve() 提供單個數據
- create() 建立資料
- update() 儲存資料
- destory() 刪除資料

　　　　ViewSet檢視集類不再實現get()、post()等方法，而是實現動作 action 如 list() 、create() 等。

　　　　檢視集只在使用as_view()方法的時候，才會將action動作與具體請求方式對應上。如：

class BookInfoViewSet(viewsets.ViewSet):

    def list(self, request):
        books = BookInfo.objects.all()
        serializer = BookInfoSerializer(books, many=True)
        return Response(serializer.data)

    def retrieve(self, request, pk=None):
        try:
            books = BookInfo.objects.get(id=pk)
        except BookInfo.DoesNotExist:
            return Response(status=status.HTTP_404_NOT_FOUND)
        serializer = BookInfoSerializer(books)
        return Response(serializer.data)

　　　　在設定路由時，我們可以如下操作

urlpatterns = [
    url(r'^books/$', BookInfoViewSet.as_view({'get':'list'}),
    url(r'^books/(?P<pk>\d+)/$', BookInfoViewSet.as_view({'get': 'retrieve'})
]

　　　　常用檢視集父類

　　　　　　1.ViewSet

　　　　　　　　繼承自APIView與ViewSetMixin，作用也與APIView基本類似，提供了身份認證、許可權校驗、流量管理等。

　　　　　　　　ViewSet主要通過繼承ViewSetMixin來實現在呼叫as_view()時傳入字典（如{'get':'list'}）的對映處理工作。

　　　　　　　　在ViewSet中，沒有提供任何動作action方法，需要我們自己實現action方法。

　　　　　　2.GenericViewSet

　　使用ViewSet通常並不方便，因為list、retrieve、create、update、destory等方法都需要自己編寫，而這些方法與前面講過的Mixin擴充套件類提供的方法同名，所以我們可以通過繼承Mixin擴充套件類來複用這些方法而無需自己編寫。但是Mixin擴充套件類依賴與GenericAPIView，所以還需要繼承GenericAPIView。

　　GenericViewSet就幫助我們完成了這樣的繼承工作，繼承自GenericAPIView與ViewSetMixin，在實現了呼叫as_view()時傳入字典（如{'get':'list'}）的對映處理工作的同時，還提供了GenericAPIView提供的基礎方法，可以直接搭配Mixin擴充套件類使用。

　　　　　　　　舉例：

from rest_framework.viewsets import GenericViewSet
from rest_framework.mixins import ListModelMixin,CreateModelMixin,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class Student4ViewSet(GenericViewSet,ListModelMixin,CreateModelMixin,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

　　　　　　　　url的定義

urlpatterns = [
    path("students7/", views.Student4ViewSet.as_view({"get": "list", "post": "create"})),
    re_path("students7/(?P<pk>\d+)/", views.Student4ViewSet.as_view({"get": "retrieve","put":"update","delete":"destroy"})),

]

　　　　　　3.ModelViewSet

　　　　　　　　繼承自GenericViewSet，同時包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。

　　　　　　4.ReadOnlyModelViewSet

　　　　　　　　繼承自GenericViewSet，同時包括了ListModelMixin、RetrieveModelMixin。

　　　　檢視集中定義附加action動作

　　　　　　在檢視集中，除了上述預設的方法動作外，還可以新增自定義動作。

　　　　　　舉例：

from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    def login(self,request):
        """學生登入功能"""
        return Response({"message":"登入成功"})

　　　　　　url的定義：

urlpatterns = [
    path("students8/", views.StudentModelViewSet.as_view({"get": "list", "post": "create"})),
    re_path("students8/(?P<pk>\d+)/",
            views.StudentModelViewSet.as_view({"get": "retrieve", "put": "update", "delete": "destroy"})),

    path("stu/login/",views.StudentModelViewSet.as_view({"get":"login"}))

]

　　　　action屬性

　　　　　　在檢視集中，我們可以通過action物件屬性來獲取當前請求檢視集時的action動作是哪個。

　　　　　　例如：

from rest_framework.viewsets import ModelViewSet
from students.models import Student
from .serializers import StudentModelSerializer
from rest_framework.response import Response
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    def get_new_5(self,request):
        """獲取最近新增的5個學生資訊"""
        # 操作資料庫
        print(self.action) # 獲取本次請求的檢視方法名
        
        
通過路由訪問到當前方法中.可以看到本次的action就是請求的方法名

DRF之請求響應與檢視元件

請求響應

請求Request

常用屬性：

響應Response

構造方式：

常用屬性

檢視元件

2個檢視基類

APIView

GenericAPIView[通用檢視類]

5個檢視擴充套件類

1.ListModelMixin

2.CreateModelMixin

3.RetrieveModelMixin

4.UpdateModelMixin

5.DestroyModelMixin

9個檢視子類

1.CreateAPIView

2.ListAPIView

3.RetrieveAPIView

4.DestoryAPIView

5.UpdateAPIView

6.RetrieveUpdateAPIView

7.RetrieveDestroyAPIView

8.ListCreateAPIView

9.RetrieveUpdateDestoryAPIVie

檢視集ViewSet

常用檢視集父類

1.ViewSet

2.GenericViewSet

3.ModelViewSet

4.ReadOnlyModelViewSet

檢視集中定義附加action動作

action屬性

總結檢視類中的繼承關係

相關推薦

　　請求Request

　　　　常用屬性：

　　響應Response

　　　　構造方式：

　　　　常用屬性

　　2個檢視基類

　　　　APIView

　　　　GenericAPIView[通用檢視類]

　　5個檢視擴充套件類

　　　　1.ListModelMixin

　　　　2.CreateModelMixin

　　　　3.RetrieveModelMixin

　　　　4.UpdateModelMixin

　　　　5.DestroyModelMixin

　　9個檢視子類

　　　　1.CreateAPIView

　　　　2.ListAPIView

　　　　3.RetrieveAPIView

　　　　4.DestoryAPIView

　　　　5.UpdateAPIView

　　　　6.RetrieveUpdateAPIView

　　　　7.RetrieveDestroyAPIView

　　　　8.ListCreateAPIView

　　　　9.RetrieveUpdateDestoryAPIVie

　　檢視集ViewSet

　　　　常用檢視集父類

　　　　　　1.ViewSet

　　　　　　2.GenericViewSet

　　　　　　3.ModelViewSet

　　　　　　4.ReadOnlyModelViewSet

　　　　檢視集中定義附加action動作

　　　　action屬性

　　總結檢視類中的繼承關係