1. 程式人生 > >檢視集ViewSet

檢視集ViewSet

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

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

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

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

class BookInfoViewSet(viewsets.ViewSet):

    def list(self, request):
        books = BookInfo.objects.all()
        serializer = BookInfoSerializer(books, many=True)
        return Response(serializer.data)

    def retrieve(self, request, pk=None):
        try:
            books = BookInfo.objects.get(id=pk)
        except BookInfo.DoesNotExist:
            return Response(status=status.HTTP_404_NOT_FOUND)
        serializer = BookInfoSerializer(books)
        return Response(serializer.data)

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

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

1. 常用檢視集父類

1) ViewSet

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

ViewSet主要通過繼承ViewSetMixin來實現在呼叫as_view()時傳入字典(如{'get':'list'}

)的對映處理工作。

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

2)GenericViewSet

使用ViewSet通常並不方便,因為list、retrieve、create、update、destory等方法都需要自己編寫,而這些方法與前面講過的Mixin擴充套件類提供的方法同名,所以我們可以通過繼承Mixin擴充套件類來複用這些方法而無需自己編寫。但是Mixin擴充套件類依賴與GenericAPIView,所以還需要繼承GenericAPIView

GenericViewSet就幫助我們完成了這樣的繼承工作,繼承自GenericAPIView

ViewSetMixin,在實現了呼叫as_view()時傳入字典(如{'get':'list'})的對映處理工作的同時,還提供了GenericAPIView提供的基礎方法,可以直接搭配Mixin擴充套件類使用。

舉例:

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

url的定義

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

3)ModelViewSet

繼承自GenericViewSet,同時包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。

4)ReadOnlyModelViewSet

繼承自GenericViewSet,同時包括了ListModelMixin、RetrieveModelMixin。

2. 檢視集中定義附加action動作

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

舉例:

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

    def latest(self, request):
        """
        返回最新的圖書資訊
        """
        book = BookInfo.objects.latest('id')
        serializer = self.get_serializer(book)
        return Response(serializer.data)

    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'})),
]

3. action屬性

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

例如:

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