drf之視圖

一 視圖

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

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

1.1 視圖繼承關系

視圖的方法與屬性：

1.2 視圖

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

1.2.1 2個視圖基類

1.2.1.1 APIView

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

舉例：

1 2 3 4 5 6 7 8 9 10

from rest_framework.views import APIView from rest_framework.response import Response # url(r'^students/$', views.StudentsAPIView.as_view()), classStudentsAPIView(APIView): defget(self, request): data_list = Student.objects.all() serializer = StudentModelSerializer(instance=data_list, many=True) return Response(serializer.data)

2.2.1.2 GenericAPIView[通用視圖類]

1	rest_framework.generics.GenericAPIView

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

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

• 屬性：

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

• 方法：

  • get_serializer_class(self)

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

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

    1 2 3 4

    defget_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屬性，可以重寫，例如：

    1 2 3

    defget_queryset(self): user = self.request.user return user.accounts.all()

  • get_object(self)

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

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

    若詳情訪問的模型類對象不存在，會返回404。

    該方法會默認使用APIView提供的check_object_permissions方法檢查當前對象是否有權限被訪問。

    舉例：

    1 2 3 4 5 6 7 8 9

    # url(r'^books/(?P<pk>\d+)/$', views.BookDetailView.as_view()), classBookDetailView(GenericAPIView): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer defget(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通用視圖類，我們新建一個子應用。

1	python manage.py startapp gen

代碼：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65

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)

序列化器類：

1 2 3 4 5 6 7 8 9 10 11 12 13 14

from rest_framework import serializers from students.models import Student class StudentModelSerializer(serializers.ModelSerializer): classMeta: model= Student fields = "__all__" classStudentModel2Serializer(serializers.ModelSerializer): classMeta: model= Student fields = ("name","class_null")

1.2.2 5個視圖擴展類

作用：

提供了幾種后端視圖（對數據資源進行曾刪改查）處理流程的實現，如果需要編寫的視圖屬於這五種，則視圖可以通過繼承相應的擴展類來復用代碼，減少自己編寫的代碼量。

這五個擴展類需要搭配GenericAPIView父類，因為五個擴展類的實現需要調用GenericAPIView提供的序列化器與數據庫查詢的方法。

1）ListModelMixin

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

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

源代碼：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

classListModelMixin(object): """ List a queryset. """ deflist(self, request, *args, **kwargs): # 過濾 queryset = self.filter_queryset(self.get_queryset()) # 分頁 page = self.paginate_queryset(queryset) if page isnotNone: 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)

舉例：

1 2 3 4 5 6 7 8

from rest_framework.mixins import ListModelMixin class BookListView(ListModelMixin, GenericAPIView): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer defget(self, request): return self.list(request)

2）CreateModelMixin

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

如果序列化器對前端發送的數據驗證失敗，返回400錯誤。

源代碼：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

classCreateModelMixin(object): """ Create a model instance. """ defcreate(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) defperform_create(self, serializer): serializer.save() defget_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。

源代碼：

1 2 3 4 5 6 7 8 9 10

classRetrieveModelMixin(object): """ Retrieve a model instance. """ defretrieve(self, request, *args, **kwargs): # 獲取對象，會檢查對象的權限 instance = self.get_object() # 序列化 serializer = self.get_serializer(instance) return Response(serializer.data)

舉例：

1 2 3 4 5 6

classBookDetailView(RetrieveModelMixin, GenericAPIView): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer defget(self, request, pk): return self.retrieve(request)

4）UpdateModelMixin

更新視圖擴展類，提供update(request, *args, **kwargs)方法，可以快速實現更新一個存在的數據對象。

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

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

源代碼：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24

classUpdateModelMixin(object): """ Update a model instance. """ defupdate(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) defperform_update(self, serializer): serializer.save() defpartial_update(self, request, *args, **kwargs): kwargs['partial'] = True return self.update(request, *args, **kwargs)

5）DestroyModelMixin

刪除視圖擴展類，提供destroy(request, *args, **kwargs)方法，可以快速實現刪除一個存在的數據對象。

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

源代碼：

1 2 3 4 5 6 7 8 9 10 11

classDestroyModelMixin(object): """ Destroy a model instance. """ defdestroy(self, request, *args, **kwargs): instance = self.get_object() self.perform_destroy(instance) return Response(status=status.HTTP_204_NO_CONTENT) defperform_destroy(self, instance): instance.delete()

使用GenericAPIView和視圖擴展類，實現api接口，代碼：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35

"""GenericAPIView結合視圖擴展類實現api接口""" from rest_framework.mixins import ListModelMixin,CreateModelMixin class Students2GenericAPIView(GenericAPIView,ListModelMixin,CreateModelMixin): # 本次視圖類中要操作的數據[必填] queryset = Student.objects.all() # 本次視圖類中要調用的默認序列化器[玄天] serializer_class = StudentModelSerializer defget(self, request): """獲取多個學生信息""" return self.list(request) defpost(self,request): """添加學生信息""" return self.create(request) from rest_framework.mixins import RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin classStudent2GenericAPIView(GenericAPIView,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin): queryset = Student.objects.all() serializer_class = StudentModelSerializer # 在使用GenericAPIView視圖獲取或操作單個數據時,視圖方法中的代表主鍵的參數最好是pk defget(self,request,pk): """獲取一條數據""" return self.retrieve(request,pk) defput(self,request,pk): """更新一條數據""" return self.update(request,pk) defdelete(self,request,pk): """刪除一條數據""" return self.destroy(request,pk)

1.2.3 GenericAPIView的視圖子類

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）RetrieveUpdateDestoryAPIView

提供 get、put、patch、delete方法

繼承自：GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin

1.3 視圖集ViewSet

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

• list() 提供一組數據
• retrieve() 提供單個數據
• create() 創建數據
• update() 保存數據
• destory() 刪除數據

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

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

1 2 3 4 5 6 7 8 9 10 11 12 13 14

classBookInfoViewSet(viewsets.ViewSet): deflist(self, request): books = BookInfo.objects.all() serializer = BookInfoSerializer(books, many=True) return Response(serializer.data) defretrieve(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)

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

1 2 3 4

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

1.3.1 常用視圖集父類

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擴展類使用。

舉例：

1 2 3 4 5

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的定義

1 2 3 4 5

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。

1.3.2 視圖集中定義附加action動作

在視圖集中，除了上述默認的方法動作外，還可以添加自定義動作。

舉例：

1 2 3 4 5 6 7 8

from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet class StudentModelViewSet(ModelViewSet): queryset = Student.objects.all() serializer_class = StudentModelSerializer deflogin(self,request): """學生登錄功能""" return Response({"message":"登錄成功"})

url的定義

1 2 3 4 5 6 7 8

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"})) ]

1.3.3 action屬性

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

例如：

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15

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 defget_new_5(self,request): """獲取最近添加的5個學生信息""" # 操作數據庫 print(self.action) # 獲取本次請求的視圖方法名 通過路由訪問到當前方法中.可以看到本次的action就是請求的方法名

1.4 總結

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32

#兩個基類 APIView GenericAPIView：有關數據庫操作，queryset 和serializer_class #5個視圖擴展類(rest_framework.mixins) CreateModelMixin：create方法創建一條 DestroyModelMixin：destory方法刪除一條 ListModelMixin：list方法獲取所有 RetrieveModelMixin：retrieve獲取一條 UpdateModelMixin：update修改一條 #9個子類視圖(rest_framework.generics) CreateAPIView:繼承CreateModelMixin,GenericAPIView，有post方法，新增數據 DestroyAPIView：繼承DestroyModelMixin,GenericAPIView，有delete方法，刪除數據 ListAPIView：繼承ListModelMixin,GenericAPIView,有get方法獲取所有 UpdateAPIView：繼承UpdateModelMixin,GenericAPIView，有put和patch方法，修改數據 RetrieveAPIView：繼承RetrieveModelMixin,GenericAPIView，有get方法，獲取一條 ListCreateAPIView：繼承ListModelMixin,CreateModelMixin,GenericAPIView，有get獲取所有，post方法新增 RetrieveDestroyAPIView：繼承RetrieveModelMixin,DestroyModelMixin,GenericAPIView，有get方法獲取一條，delete方法刪除 RetrieveUpdateAPIView：繼承RetrieveModelMixin,UpdateModelMixin,GenericAPIView，有get獲取一條，put，patch修改 RetrieveUpdateDestroyAPIView：繼承RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin,GenericAPIView，有get獲取一條，put，patch修改，delete刪除 #視圖集 ViewSetMixin：重寫了as_view ViewSet： 繼承ViewSetMixin和APIView GenericViewSet：繼承ViewSetMixin, generics.GenericAPIView ModelViewSet：繼承mixins.CreateModelMixin,mixins.RetrieveModelMixin,mixins.UpdateModelMixin,mixins.DestroyModelMixin,mixins.ListModelMixin,GenericViewSet ReadOnlyModelViewSet：繼承mixins.RetrieveModelMixin,mixins.ListModelMixin,GenericViewSet