DRF之視圖家族

一:GenericAPIView

(1)特色:數據庫

  (1)其繼承APIVies,使用徹底兼容APIViewdjango

  (2)其在APIView之上又添加了新的功能api

(2)使用方式函數

(3)單取工具

# 路由層
urlpatterns = [
    url(r'^v2/books/$', views.BookGenericAPIView.as_view()),
    url(r'^v2/books/(?P<pk>.*)/$', views.BookGenericAPIView.as_view()),
]
 # 視圖層
def get(self, request, *args, **kwargs): # 傳統的羣查方式 單查一樣 此處不列舉 book_query = models.Book.objects.all().filter(is_delete=False) book_ser = serializers.BookModelSerializer(book_query, many=True) data = book_ser.data return APIResponse(results=data)
def get(self, request, *args, **kwargs):
# GenericAPIView 方式取值
book_query = self.get_queryset() # 獲取序列化對象
book_ser = self.get_serializer(book_query,many=True) # 進行序列化
book_data = book_ser.data # 獲取數據
return APIResponse(results=book_data)

PS:post

  (1)此種方式會報錯 沒有獲取queryset對象 url

  (2)沒有獲取序列化類spa

    queryset = models.Book.objects.filter(is_delete=False)
    serializer_class = serializers.BookModelSerializer
    def get(self, request, *args, **kwargs):

        # GenericAPIView 方式取值
        book_query = self.get_queryset()  # 獲取序列化對象
        book_ser = self.get_serializer(book_query,many=True)  # 進行序列化
        book_data = book_ser.data   # 獲取數據
        return APIResponse(results=book_data)

PS:rest

       (1)get_queryset():從類屬性queryset中得到model的queryset數據
  (2)get_object():從類屬性queryset中得到model的queryset數據,再經過有名分組pk肯定惟一操做對象
  (3)get_serializer():從類屬性serializer_class中得到serializer的序列化類code

# 單取
    lookup_field = 'pk'  # 能夠經過該方法自定義主鍵名稱
    def get(self, request, *args, **kwargs):
        book_query = self.get_object()
        book_ser = self.get_serializer(book_query)
        book_data = book_ser.data
        return APIResponse(results=book_data)

 PS:

  (1)上述代碼結構看起來感受代碼量不減小反而增長

  (2)別急 請看下面的

二:mixins視圖工具集

(1)做用:

  (1)提供了五個工具類

  (2)提供了六個工具方法,單查,羣查,單增,單刪,單總體改,單局部改

(2)特色

  (1)mixins須要繼承GenericAPIView 

  (2)調用GenericAPIView 中的queryset ,serializer_class 以及函數中的一些方法get方法

(3)代碼示例

# 路由層
 url(r'^v3/books/$', views.BookMixinAPIView.as_view()),
 url(r'^v3/books/(?P<pk>.*)/$', views.BookMixinAPIView.as_view()),
# 視圖層

# 導入方法模塊
from rest_framework.mixins import ListModelMixin, RetrieveModelMixin, CreateModelMixin,UpdateModelMixin
class BookMixinAPIView(ListModelMixin, GenericAPIView, RetrieveModelMixin, CreateModelMixin,UpdateModelMixin): queryset = models.Book.objects.filter(is_delete=False) serializer_class = serializers.BookModelSerializer # 羣查 單查 def get(self, request, *args, **kwargs): print(self) # <api.views.BookMixinAPIView object at 0x0000000005456A20> 當前視圖類 if 'pk' in kwargs: # 判斷主鍵 是否在kwargs中 # 單查 response = self.retrieve(request, *args, **kwargs) else: # 羣查 response = self.list(request, args, **kwargs) # 數據的返回值都是在data中 經過.data獲取數據 data = response.data # mixins提供的list方法返回值都是在response中 須要使用本身定義的APIResponse return APIResponse(results=data) # 添加數據 def post(self, request, *args, **kwargs): response = self.create(request, *args, **kwargs) data = response.data return APIResponse(results=data) # 單個總體改 def put(self, request, *args, **kwargs): response = self.update(request, *args, **kwargs) data = response.data return APIResponse(results=data) # 單個局部改 def patch(self, request, *args, **kwargs): response = self.partial_update(request,*args,**kwargs) data = response.data

三:工具視圖

(1)做用:

  (1)工具視圖都是GenericAPIView的子類 且不一樣子類繼承不一樣的視圖 提供了不一樣的方法

  (2)工具視圖的功能若是能夠直接知足需求 只須要直接繼承便可

(2)使用

# 路由層
url(r'^v4/books/$', views.BookListCreatePIView.as_view()),
url(r'^v4/books/(?P<pk>.*)/$', views.BookListCreatePIView.as_view()),
# 視圖層
from rest_framework.generics import ListCreateAPIView,UpdateAPIView
class BookListCreatePIView(ListCreateAPIView,UpdateAPIView):
    # 羣查 和單增 ListCreateAPIView
    queryset = models.Book.objects.filter(is_delete=False)
    serializer_class = serializers.BookModelSerializer

    # UpdateAPIView 單局部修改 單總體修改

四:視圖集

# 路由層
urlpatterns = [
       # View的as_view():將get請求映射到視圖類的get方法
    # ViewSet的as_view({'get': 'my_get_list'}):將get請求映射到視圖類的my_get_list方法
    url(r'^v5/books/$', views.BookGenericViewSet.as_view({'get': 'my_get_list'})),
    url(r'^v5/books/(?P<pk>.*)/$', views.BookGenericViewSet.as_view({'get': 'my_get_obj'})),
]
# 視圖層
from rest_framework.viewsets import GenericViewSet
from rest_framework import mixins
class BookGenericViewSet(mixins.RetrieveModelMixin, mixins.ListModelMixin, GenericViewSet):
    queryset = models.Book.objects.filter(is_delete=False)
    serializer_class = serializers.BookModelSerializer

    def my_get_list(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)

    def my_get_obj(self, request, *args, **kwargs):
        return self.retrieve(request, *args, **kwargs)

PS:

  (1)視圖集都是優先繼承ViewSetMixin類,再繼承一個視圖類(GenericAPIView或APIView)
      GenericViewSet、ViewSet
  (2)ViewSetMixin提供了重寫的as_view()方法,繼承視圖集的視圖類,配置路由時調用as_view()必須傳入 請求名-函數名 映射關係字典
     eg: url(r'^v5/books/$', views.BookGenericViewSet.as_view({'get': 'my_get_list'})),
     表示get請求會交給my_get_list視圖函數處理

五:GenericAPIView 與 APIView兩大繼承區別

# 1:GenericViewSet和ViewSet都繼承了ViewSetMixin,as_view均可以配置 請求-函數 映射
# 2:GenericViewSet繼承的是GenericAPIView視圖類,用來完成標準的 model 類操做接口
# 3:ViewSet繼承的是APIView視圖類,用來完成不須要 model 類參與,或是非標準的 model 類操做接口
#       post請求在標準的 model 類操做下就是新增接口,登錄的post不知足
#       post請求驗證碼的接口,不須要 model 類的參與
# 案例:登錄的post請求,並非完成數據的新增,只是用post提交數據,獲得的結果也不是登錄的用戶信息,而是登錄的認證信息

六:工具視圖集

# 路由層
urlpatterns = [
       url(r'^v6/books/$', views.BookModelViewSet.as_view({'get': 'list', 'post': 'create'})),
    url(r'^v6/books/(?P<pk>.*)/$', views.BookModelViewSet.as_view({'get': 'retrieve', 'put': 'update', 'patch': 'partial_update', 'delete': 'destroy'})),
]
from rest_framework.viewsets import ModelViewSet
class BookModelViewSet(ModelViewSet):
    queryset = models.Book.objects.filter(is_delete=False)
    serializer_class = serializers.BookModelSerializer

    # 刪不是數據庫,而是該記錄中的刪除字段
    def destroy(self, request, *args, **kwargs):
        instance = self.get_object()  # type: models.Book
        if not instance:
            return APIResponse(1, '刪除失敗')  # 實際操做,在此以前就作了判斷
        instance.is_delete = True
        instance.save()
        return APIResponse(0, '刪除成功')

七:路由組件

from django.conf.urls import include
from rest_framework.routers import SimpleRouter
router = SimpleRouter()
# 全部路由與ViewSet視圖類的均可以註冊,會產生 '^v6/books/$' 和 '^v6/books/(?P<pk>[^/.]+)/$'
router.register('v6/books', views.BookModelViewSet)

urlpatterns = [
    # 第一種添加子列表方式
    url(r'^', include(router.urls)),
]
# 第二種添加子列表方式
# urlpatterns.extend(router.urls)
相關文章
相關標籤/搜索