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

action屬性

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

例如：

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

常用檢視集父類

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。

檢視集中定義附加action動作

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

新增自定義動作需要使用rest_framework.decorators.action裝飾器。

以action裝飾器裝飾的方法名會作為action動作名，與list、retrieve等同。

action裝飾器可以接收兩個引數：

• methods: 該action支援的請求方式，列表傳遞
• detail: 表示是action中要處理的是否是檢視資源的物件（即是否通過url路徑獲取主鍵）
  • True 表示使用通過URL獲取的主鍵對應的資料物件
  • False 表示不使用URL獲取主鍵

舉例：

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

    # detail為False 表示不需要處理具體的BookInfo物件
    @action(methods=['get'], detail=False)
    def latest(self, request):
        """
        返回最新的圖書資訊
        """
        book = BookInfo.objects.latest('id')
        serializer = self.get_serializer(book)
        return Response(serializer.data)

    # detail為True，表示要處理具體與pk主鍵對應的BookInfo物件
    @action(methods=['put'], detail=True)
    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'})),
]