2. 程式人生 > >DRF檢視和檢視集

DRF檢視和檢視集

阿新 • • 發佈：2019-02-17

檢視說明

1. 兩個基類

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)

      返回序列化器類，預設返回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 指明過濾控制後端

2. 五個擴充套件類

作用：

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

這五個擴充套件類需要搭配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()

3. 幾個可用子類檢視

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

檢視集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. 常用檢視集父類

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 import mixins
from rest_framework.viewsets import GenericViewSet
from rest_framework.decorators import action

class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

url的定義

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

3）ModelViewSet

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

4）ReadOnlyModelViewSet

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

2. 檢視集中定義附加action動作

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

舉例：

from rest_framework import mixins
from rest_framework.viewsets import GenericViewSet
from rest_framework.decorators import action

class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    def latest(self, request):
        """
        返回最新的圖書資訊
        """
        book = BookInfo.objects.latest('id')
        serializer = self.get_serializer(book)
        return Response(serializer.data)

    def read(self, request, pk):
        """
        修改圖書的閱讀量資料
        """
        book = self.get_object()
        book.bread = request.data.get('read')
        book.save()
        serializer = self.get_serializer(book)
        return Response(serializer.data)

url的定義

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

3. action屬性

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

例如：

def get_serializer_class(self):
    if self.action == 'create':
        return OrderCommitSerializer
    else:
        return OrderDataSerializer

4. 檢視集的繼承關係

相關推薦

DRF檢視和檢視集

檢視說明 1. 兩個基類 1）APIView rest_framework.views.APIView APIView是REST framework提供的所有檢視的基類，繼承自Django的View父類。 APIView與View的不同之處在於： 傳入到檢視方法中

【SpringMVC】6.SpringMVC的檢視和檢視解析器

注意！！！ 此文章需要配置了SpringDispatcherServlet和InternalResourceViewResolver才能夠使用，如果不會配置，請翻看我【SpringMVC】系列的第一篇文章《【SpringMVC】1. SpringMVC的第

SpringMVC中的檢視和檢視解析器

　　對於控制器的目標方法，無論其返回值是String、View、ModelMap或是ModelAndView，SpringMVC都會在內部將它們封裝為一個ModelAndView物件進行返回。 　　 Spring MVC 藉助檢視解析器（ViewResolve

SpringMVC 學習（五）——檢視和檢視解析器

Spring MVC如何解析檢視       檢視和檢視解析器     •請求處理方法執行完成後，最終返回一個 ModelAndView  對象。對於那些返回 String，View 或 ModeMap 等

SpringMVC-5 檢視和檢視解析器

　　在SpringMVC中，控制器目標方法的返回值均會被裝配為ModelAndView物件，其包含邏輯檢視的名稱和模型資料；邏輯檢視即需要檢視解析器來將其轉換為實際的物理檢視。 　　其中，檢視和檢視解析器的具體實現程式碼下載地址：http://download

Spring 檢視和檢視解析器簡介

什麼是 Spring 檢視和檢視解析器？ Spring MVC（Model View Controller）是 Spring 中一個重要的組成部分，而 Spring 檢視和檢視解析器則是 Spring MVC 中的組成部分。在介紹 Spring 檢視和檢視解析

DRF檢視和路由

APIView : 在django中寫CBV的時候是繼承View, rest_framework繼承的是APIView, 這兩種具體有什麼不同呢? urlpatterns = [ url(r'^book$', BookView.as_view()), url(r'^book/(?P&

Django通用檢視APIView和檢視集ViewSet的介紹和使用

1.APIView DRF框架的檢視的基類是 APIView APIView的基本使用和View類似 Django預設的View請求物件是 HttpRequest，REST framework 的請求物件是 Request。 Request物件的資料是自動

關於django 之 drf 中的 檢視集

檢視集ViewSet使用檢視集ViewSet，可以將一系列邏輯相關的動作放到一個類中：list() 提供一組資料retrieve() 提供單個數據create() 建立資料update() 儲存資料destory() 刪除資料ViewSet檢視集類不再實現get()、post

DRF框架的檢視簡析

首先我們明確REST介面開發的核心任務 在開發REST API介面時，檢視中做的最主要有三件事： 將請求的資料（如JSON格式）轉換為模型類物件 操作資料庫 將模型類物件轉換為響應的資料（如JSON格式） 一：使用Django開發REST 介面 資料的獲取和返回

Flask_學習筆記_02: URL和檢視

今天來學習Flask中URL和檢視的相關知識。 URL不多說了，訪問網站，瀏覽器中的地址大家都可以看到，比如我的51CTO的blog網址是：http://blog.51cto.com/jiaszwx 如果你在位址列裡敲：http://blog.51cto.com/ 那麼瀏覽器返回的是51CTO部落格的主頁

[轉帖]Oracle字符集的檢視與修改 --- 還未嘗試 找個週六 試試. Oracle 字符集的檢視和修改

Oracle 字符集的檢視和修改 感謝原作者 改天試試 https://www.cnblogs.com/rootq/articles/2049324.html   一、什麼是Oracle字符集        Or

ubuntu 安裝和檢視已安裝軟體

說明：由於圖形化介面方法（如Add/Remove... 和Synaptic Package Manageer）比較簡單，所以這裡主要總結在終端通過命令列方式進行的軟體包安裝、解除安裝和刪除的方法。 一、Ubuntu中軟體安裝方法 1、APT方式 （1）普通安裝：apt-get i

Django Rest Framework 檢視和路由

一、DRF的檢視 （一）APIView APIView是REST framework提供的所有檢視的基類，繼承自Django的View父類。 APIView與View的不同之處在於： 傳入到檢視方法中的是REST framework的Request物件，而不是Django的HttpRequese

Django的View(檢視)和路由系統

一、Django的View(檢視) 1、介紹 一個檢視函式（類），簡稱檢視，是一個簡單的Python 函式（類），它接受Web請求並且返回Web響應。 響應可以是一張網頁的HTML內容，一個重定向，一個404錯誤，一個XML文件，或者一張圖片。 無論檢視本身包含什麼邏輯，都要返回響應。 程式碼

linux 檢視和修改檔案（夾）許可權

1. 使用 ls -l 或者 ll 檢視檔案許可權  第一位表示檔案型別：d 表示資料夾 - 表示普通檔案 r （read）表示可讀 w (write)表示可寫 x 表示執行許可權：通常指可以執行的程式檔案或者指令碼檔案     rwx 三個

關於Android的keystore生成和檢視keystore

  關於Android的keystore生成和檢視keystore 因為工作需要最近開始接觸Android，在APP測試版本更新時發現簽名衝突不能正確安裝，這才瞭解到還需要簽名。 在這裡說兩種簽名的方式： 第一種是用ec

CockroachDB SQL開發基礎 ——建立資料庫、表和檢視

       CockroachDB相容PostgreSQL協議和PostgreSQL語法，它的目標是提供對ANSI SQL標準的相容，在相容標準的前提下進行了一定程度的擴充套件。從客戶端的角度看，我們可以把CockroachDB當作一個儲存容量和計算能力可以

Django API、檢視和模板、Django投票系統

一、Django API 1.1 使用python shell 1.1.1 載入python shell 1. 使用如下命令來呼叫Python shell: (django_env)    [[email protected] 

mysql儲存過程遊標檢視select結果集

mysql中使用select（或者使用print未嘗試）檢視引數 DELIMITER $ create PROCEDURE myPro() BEGIN    DECLARE  id varchar(64);   -- id     DE