視圖集ViewSet

一 、視圖集ViewSet

使用視圖集ViewSet,能夠將一系列邏輯相關的動做放到一個類中:python

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

ViewSet視圖集類再也不實現get()post()等方法,而是實現動做 actionlist()create() 等。數據庫

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

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)

在設置路由時,咱們能夠以下操做url

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

二 、經常使用視圖集父類

2.1 ViewSet

繼承自APIViewViewSetMixin,做用也與APIView基本相似,提供了身份認證、權限校驗、流量管理等。rest

ViewSet主要經過繼承ViewSetMixin來實如今調用as_view()時傳入字典(如{’get’:’list’})的映射處理工做。code

ViewSet中,沒有提供任何動做action方法,須要咱們本身實現action方法。對象

2.2GenericViewSet

使用ViewSet一般並不方便,由於listretrievecreateupdatedestory等方法都須要本身編寫,而這些方法與前面講過的Mixin擴展類提供的方法同名,因此咱們能夠經過繼承Mixin擴展類來複用這些方法而無需本身編寫。可是Mixin擴展類依賴與GenericAPIView,因此還須要繼承GenericAPIView繼承

GenericViewSet就幫助咱們完成了這樣的繼承工做,繼承自GenericAPIViewViewSetMixin,在實現了調用as_view()時傳入字典(如{'get':'list'})的映射處理工做的同時,還提供了GenericAPIView提供的基礎方法,能夠直接搭配Mixin擴展類使用。路由

舉例:get

from rest_framework.viewsets import GenericViewSet
from rest_framework.mixins import ListModelMixin,CreateModelMixin,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin
class Student4ViewSet(GenericViewSet,ListModelMixin,CreateModelMixin,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

url的定義

urlpatterns = [
    path("students7/", views.Student4ViewSet.as_view({"get": "list", "post": "create"})),
    re_path("students7/(?P<pk>\d+)/", views.Student4ViewSet.as_view({"get": "retrieve","put":"update","delete":"destroy"})),

]

2.3 ModelViewSet

繼承自GenericViewSet,同時包括了ListModelMixinRetrieveModelMixinCreateModelMixinUpdateModelMixinDestoryModelMixin

2.4 ReadOnlyModelViewSet

繼承自GenericViewSet,同時包括了ListModelMixinRetrieveModelMixin

三 、視圖集中定義附加action動做

在視圖集中,除了上述默認的方法動做外,還能夠添加自定義動做。

舉例:

from rest_framework.viewsets import ModelViewSet,ReadOnlyModelViewSet

class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    def login(self,request):
        """學生登陸功能"""
        return Response({"message":"登陸成功"})

url的定義

urlpatterns = [
    path("students8/", views.StudentModelViewSet.as_view({"get": "list", "post": "create"})),
    re_path("students8/(?P<pk>\d+)/",
            views.StudentModelViewSet.as_view({"get": "retrieve", "put": "update", "delete": "destroy"})),

    path("stu/login/",views.StudentModelViewSet.as_view({"get":"login"}))

]

四 、action屬性

在視圖集中,咱們能夠經過action對象屬性來獲取當前請求視圖集時的action動做是哪一個。

例如:

from rest_framework.viewsets import ModelViewSet
from students.models import Student
from .serializers import StudentModelSerializer
from rest_framework.response import Response
class StudentModelViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

    def get_new_5(self,request):
        """獲取最近添加的5個學生信息"""
        # 操做數據庫
        print(self.action) # 獲取本次請求的視圖方法名
        
經過路由訪問到當前方法中.能夠看到本次的action就是請求的方法名
相關文章
相關標籤/搜索