DRF - 檢視

阿新 • • 發佈：2018-11-11

1 Request 與 Response

1.1 Request

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

REST framework 提供了Parser解析器，在接收到請求後會自動根據Content-Type指明的請求資料型別（如JSON、表單等）將請求資料進行parse解析，解析為類字典物件儲存到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相同，只是更換了更正確的名稱而已。

1.2 Response

rest_framework.response.Response

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

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

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。

注意：

這裡說的python的內建型別資料，指的是python字典。

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處理後的響應資料

1.3 狀態碼

為了方便設定狀態碼，REST framewrok在rest_framework.status模組中提供了常用狀態碼常量。

1）資訊告知 - 1xx

HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS

2）成功 - 2xx

HTTP_200_OK
HTTP_201_CREATED
HTTP_202_ACCEPTED
HTTP_203_NON_AUTHORITATIVE_INFORMATION
HTTP_204_NO_CONTENT
HTTP_205_RESET_CONTENT
HTTP_206_PARTIAL_CONTENT
HTTP_207_MULTI_STATUS

3）重定向 - 3xx

HTTP_300_MULTIPLE_CHOICES
HTTP_301_MOVED_PERMANENTLY
HTTP_302_FOUND
HTTP_303_SEE_OTHER
HTTP_304_NOT_MODIFIED
HTTP_305_USE_PROXY
HTTP_306_RESERVED
HTTP_307_TEMPORARY_REDIRECT

4）客戶端錯誤 - 4xx

HTTP_400_BAD_REQUEST
HTTP_401_UNAUTHORIZED
HTTP_402_PAYMENT_REQUIRED
HTTP_403_FORBIDDEN
HTTP_404_NOT_FOUND
HTTP_405_METHOD_NOT_ALLOWED
HTTP_406_NOT_ACCEPTABLE
HTTP_407_PROXY_AUTHENTICATION_REQUIRED
HTTP_408_REQUEST_TIMEOUT
HTTP_409_CONFLICT
HTTP_410_GONE
HTTP_411_LENGTH_REQUIRED
HTTP_412_PRECONDITION_FAILED
HTTP_413_REQUEST_ENTITY_TOO_LARGE
HTTP_414_REQUEST_URI_TOO_LONG
HTTP_415_UNSUPPORTED_MEDIA_TYPE
HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE
HTTP_417_EXPECTATION_FAILED
HTTP_422_UNPROCESSABLE_ENTITY
HTTP_423_LOCKED
HTTP_424_FAILED_DEPENDENCY
HTTP_428_PRECONDITION_REQUIRED
HTTP_429_TOO_MANY_REQUESTS
HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE
HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS

5）伺服器錯誤 - 5xx

HTTP_500_INTERNAL_SERVER_ERROR
HTTP_501_NOT_IMPLEMENTED
HTTP_502_BAD_GATEWAY
HTTP_503_SERVICE_UNAVAILABLE
HTTP_504_GATEWAY_TIMEOUT
HTTP_505_HTTP_VERSION_NOT_SUPPORTED
HTTP_507_INSUFFICIENT_STORAGE
HTTP_511_NETWORK_AUTHENTICATION_REQUIRED

2 檢視概覽

REST framework 提供了眾多的通用檢視基類與擴充套件類，以簡化檢視的編寫。

檢視的繼承關係：

通用檢視的繼承關係

上圖說明：檢視view最根本是django的view，而rest_framework對於view進行了擴充套件叫做APIview，這個類就是rest_framework中最根本的檢視類。

檢視的方法與屬性：

通用檢視的繼承關係_含方法和屬性

3 檢視說明

3.1 兩個基類

3.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)  # books是一個查詢集，故關鍵字many=True
        return Response(serializer.data)

3.1.2 GenericAPIView

rest_framework.generics.GenericAPIView

繼承自APIVIew，增加了對於列表檢視和詳情檢視可能用到的通用支援方法。通常使用時，可搭配一個或多個Mixin擴充套件類。

支援定義的屬性：

列表檢視與詳情檢視通用：
- queryset 列表檢視的查詢集
- serializer_class 檢視使用的序列化器
列表檢視使用：
- pagination_class 分頁控制類
- filter_backends 過濾控制後端
詳情頁檢視使用：
- lookup_field 查詢單一資料庫物件時使用的條件欄位，預設為'pk'
- lookup_url_kwarg 查詢單一資料時URL中的引數關鍵字名稱，預設與look_field相同

lookup_field與lookup_url_kwarg，對應如下：

提供的方法：

列表檢視與詳情檢視通用：

應用場景： get_queryset和get_serializer_class方法一般在類檢視中不同方法需要不同的查詢集和序列化器的時候重寫。
- get_queryset(self)
  
  返回檢視使用的查詢集，是列表檢視與詳情檢視獲取資料的基礎，預設返回queryset屬性，可以重寫，例如：
```
def get_queryset(self):
    user = self.request.user
    return user.accounts.all()
```
- 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)
  
  返回序列化器物件，被其他檢視或擴充套件類使用，如果我們在檢視中想要獲取序列化器物件，可以直接呼叫此方法。
  
  注意：在提供序列化器物件的時候，REST framework會向物件的context屬性補充三個資料：request、format、view，這三個資料物件可以在定義序列化器時使用。
詳情檢視使用：
- get_object(self) 返回詳情檢視所需的模型類資料物件，預設使用lookup_field引數來過濾queryset。在試圖中可以呼叫該方法獲取詳情資訊的模型類物件。
  
  若詳情訪問的模型類物件不存在，會返回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()
        serializer = self.get_serializer(book)
        return Response(serializer.data)

3.2 五個擴充套件類

建議看之前先看一下 ☞ DRF - 五個擴充套件類 - 輔助理解

3.2.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)

3.2.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.2.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)

3.2.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)

3.2.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.3 幾個可用子類檢視

1） CreateAPIView

提供 post 方法

繼承自： GenericAPIView、CreateModelMixin

2）ListAPIView

提供 get 方法

繼承自：GenericAPIView、ListModelMixin

3）RetireveAPIView

提供 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

4 檢視集ViewSet

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

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

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

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

class BookInfoViewSet(viewsets.ViewSet):

    def list(self, request):
        ...

    def retrieve(self, request, pk=None):
        ...

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

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

4.1 action屬性

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

例如：

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

4.2 常用檢視集父類

1） ViewSet

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

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

2）GenericViewSet

繼承自GenericAPIView，作用也與GenericAPIVIew類似，提供了get_object、get_queryset等方法便於列表檢視與詳情資訊檢視的開發。

3）ModelViewSet

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

4）ReadOnlyModelViewSet

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

4.3 檢視集中定義附加action動作

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

新增自定義動作需要使用rest_framework.decorators.action裝飾器。

以action裝飾器裝飾的方法名會作為action動作名，與list、retrieve等同。

action裝飾器可以接收兩個引數：

methods：該action支援的請求方式，列表傳遞
detail：表示是action中要處理的是否是檢視資源的物件（即是否通過url路徑獲取主鍵）
- True 表示使用通過URL獲取的主鍵對應的資料物件
- False 表示不使用URL獲取主鍵

舉例：

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

    # detail為False 表示不需要處理具體的BookInfo物件
    @action(methods=['get'], detail=False)
    def latest(self, request):
        """
        返回最新的圖書資訊
        """
        book = BookInfo.objects.latest('id')
        serializer = self.get_serializer(book)
        return Response(serializer.data)

    # detail為True，表示要處理具體與pk主鍵對應的BookInfo物件
    @action(methods=['put'], detail=True)
    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'})),
]

4.4 檢視集的繼承關係

檢視集類繼承關係

5 路由Routers

對於檢視集ViewSet，我們除了可以自己手動指明請求方式與動作action之間的對應關係外，還可以使用Routers來幫助我們快速實現路由資訊。

REST framework提供了兩個router

SimpleRouter
DefaultRouter

5.1 使用方法

1）建立router物件，並註冊檢視集，例如

from rest_framework import routers

router = routers.SimpleRouter()
router.register(r'books', BookInfoViewSet, base_name='book')

register(prefix, viewset, base_name)

prefix 該檢視集的路由字首

viewset 檢視集

base_name 路由名稱的字首

如上述程式碼會形成的路由如下：

^books/$    name: book-list
^books/{pk}/$   name: book-detail

2）新增路由資料

可以有兩種方式：

urlpatterns = [
    ...
]
urlpatterns += router.urls

或

urlpatterns = [
    ...
    url(r'^', include(router.urls))
]

5.2 檢視集中包含附加action的

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

    @action(methods=['get'], detail=False)
    def latest(self, request):
        ...

    @action(methods=['put'], detail=True)
    def read(self, request, pk):
        ...

此檢視集會形成的路由：

^books/latest/$    name: book-latest
^books/{pk}/read/$  name: book-read

5.3 路由router形成URL的方式

1） SimpleRouter

simple_router

2）DefaultRouter

default_router

DefaultRouter與SimpleRouter的區別是，DefaultRouter會多附帶一個預設的API根檢視，返回一個包含所有列表檢視的超連結響應資料。

DRF - 檢視

1 Request 與 Response

1.1 Request

常用屬性

1.2 Response

構造方式

1.3 狀態碼

2 檢視概覽

3 檢視說明

3.1 兩個基類

3.1.1 APIView

3.1.2 GenericAPIView

3.2 五個擴充套件類

3.2.1 ListModelMixin

3.2.2 CreateModelMixin

3.2.3 RetrieveModelMixin

3.2.4 UpdateModelMixin

3.2.5 DestroyModelMixin

3.3 幾個可用子類檢視

1） CreateAPIView

2）ListAPIView

3）RetireveAPIView

4）DestoryAPIView

5）UpdateAPIView

6）RetrieveUpdateAPIView

7）RetrieveUpdateDestoryAPIView

4 檢視集ViewSet

4.1 action屬性

4.2 常用檢視集父類

1） ViewSet

2）GenericViewSet

3）ModelViewSet

4）ReadOnlyModelViewSet

4.3 檢視集中定義附加action動作

4.4 檢視集的繼承關係

5 路由Routers

5.1 使用方法

5.2 檢視集中包含附加action的

5.3 路由router形成URL的方式

相關推薦