DRF檢視說明
檢視說明
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 2）GenericAPIView
rest_framework.generics.GenericAPIView
繼承自APIVIew，增加了對於列表檢視和詳情檢視可能用到的通用支援方法。通常使用時，可搭配一個或多個Mixin擴充套件類。
支援定義的屬性：
- 列表檢視與詳情檢視通用：
- queryset 列表檢視的查詢集
- serializer_class 檢視使用的序列化器
列表檢視使用：
- pagination_class 分頁控制類
- filter_backends 過濾控制後端
詳情頁檢視使用：
- lookup_field 查詢單一資料庫物件時使用的條件欄位，預設為’pk’
- lookup_url_kwarg 查詢單一資料時URL中的引數關鍵字名稱，預設與look_field相同
提供的方法：
-
列表檢視與詳情檢視通用：
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)
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)
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）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. 檢視的繼承關係
REST framework 提供了眾多的通用檢視基類與擴充套件類，以簡化檢視的編寫。
5. 檢視的方法與屬性：
