視圖

視圖說明

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擴展類。

支持定義的屬性：
列表視圖與詳情視圖通用：
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 \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