視圖說明

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視圖和視圖集視圖說明視圖集ViewSet

DRF視圖和視圖集視圖說明視圖集ViewSet

視圖說明

1. 兩個基類

1）APIView

2）GenericAPIView

2. 五個擴充類

1）ListModelMixin

2）CreateModelMixin

3） RetrieveModelMixin

4）UpdateModelMixin

5）DestroyModelMixin

3. 幾個可用子類視圖

1） CreateAPIView

2）ListAPIView

3）RetrieveAPIView

4）DestoryAPIView

5）UpdateAPIView

6）RetrieveUpdateAPIView

7）RetrieveUpdateDestoryAPIView

視圖集ViewSet

1. 常用視圖集父類

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

3. action屬性

繼續閱讀

第七章建構線上商店7 建構線上商店

【django】模闆繼承詳解

xadmin使用（二）使用者登陸

腳本管理器項目

Python--django實作分頁功能

Django—— F、Q查詢

Django F() 的作用

Using django Models 批注 Models

django F和Q

Django項目實戰——3—(圖形驗證碼後端邏輯、短信驗證碼、短信驗證碼後端邏輯)1、圖形驗證碼後端邏輯2、短信驗證碼3、短信驗證碼後端邏輯

短信驗證碼後端-接口設計

django短信驗證碼的後端實作

Django項目後端實作注冊功能---短信驗證碼(容聯雲)。

django之注冊會員發送短信驗證碼的業務

Django之驗證碼（十七）驗證碼

python中的兩種拆包示範