DRF中五大擴展類及視圖集的介紹

五個擴展類

(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) 

(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) 

(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

視圖集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'}) ] 

常用視圖集父類

(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。