【Django-DRF】多年md筆記第5篇：Django-DRF的Request、Response和視圖詳解

本文從分析現在流行的前后端分離Web應用模式說起，然后介紹如何設計REST API，通過使用Django來實現一個REST API為例，明確后端開發REST API要做的最核心工作，然后介紹Django REST framework能幫助我們簡化開發REST API的工作。

Django-DRF全套筆記直接地址：請移步這里

共 5 章，24 子模塊

視圖

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

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

Request 與 Response

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相同，只是更換了更正確的名稱而已。

2. Response

rest_framework.response.Response

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

REST framework提供了Renderer 渲染器，用來根據請求頭中的Accept（接收數據類型聲明）來自動轉換響應數據到對應格式。如果前端請求中未進行Accept聲明，則會采用默認方式處理響應數據，我們可以通過配置來修改默認響應格式。

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處理后的響應數據

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

視圖概覽

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

視圖的繼承關系：

通用視圖繼承關系

視圖的方法與屬性：

視圖的方法與屬性

視圖說明

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 FullAccountSerializerreturn 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.userreturn user.accounts.all()
```
- get_object(self)
返回詳情視圖所需的模型類數據對象，主要用來提供給Mixin擴展類使用。

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

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

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

舉例：

url(r’^books/(?P\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方法會對數據進行過濾和分頁。源代碼：```python
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 ListModelMixinclass BookListView(ListModelMixin, GenericAPIView):queryset = BookInfo.objects.all()serializer_class = BookInfoSerializerdef 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 = BookInfoSerializerdef 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'] = Truereturn 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()