[Django REST framework - 檢視元件之檢視基類、檢視擴充套件類、檢視子類、檢視集]
檢視繼承關係
詳圖見文章末尾
檢視元件可點我檢視
兩個檢視基類:APIView、GenericAPIView
from rest_framework.views import APIView
APIView與View的不同之處在於:
傳入到檢視方法中的是REST framework的Request物件,而不是Django的HttpRequeset物件;
檢視方法可以返回REST framework的Response物件,檢視會為響應資料設定(render)符合前端要求的格式;
任何APIException異常都會被捕獲到,並且處理成合適的響應資訊;
在進行dispatch()分發前,會對請求進行身份認證、許可權檢查、流量控制。
支援定義的類屬性
authentication_classes 列表或元祖,身份認證類
permission_classes 列表或元祖,許可權檢查類
throttle_classes 列表或元祖,流量控制類
在APIView中仍以常規的類檢視定義方法來實現get() 、post() 或者其他請求方式的方法
********示例在下方*******
繼承 APIView
匯入模組: from rest_framework.views import APIView
from rest_framework.views import APIView # 匯入模組
class Books(APIView):
def get(self,request): # get請求會執行此方法 用於查詢全部資訊
book = Book.objects.all() # 獲取Book下全部欄位資訊
obj = BookSerializer(book,many=True) # 查詢多條需要指定many=True
return Response(obj.data) # obj.data將資料返回
def post(self,request): # post請求執行此方法 用於建立新的資訊
obj = BookSerializer(data=request.data) # 將資料傳入序列化器(類)
if obj.is_valid(): # 校驗資料是否合法
obj.save() # .save儲存資料
return Response(obj.data)
class Bookss(APIView):
def put(self,request,pk):
book = Book.objects.filter(pk=pk).first()
obj = BookSerializer(instance=book,data=request.data)
if obj.is_valid():
obj.save()
return Response(obj.data)
def get(self,request,pk):
book = Book.objects.filter(pk=pk).first()
obj = BookSerializer(instance=book)
return Response(obj.data)
def delete(self,request,pk):
Book.objects.filter(pk=pk).delete()
return Response()
繼承 GenericAPIView
繼承自APIVIew
,主要增加了操作序列化器和資料庫查詢的方法,作用是為下面Mixin擴充套件類的執行提供方法支援。通常在使用時,可搭配一個或多個Mixin擴充套件類。
from rest_framework.generics import GenericAPIView
GenericAPIView(APIView):做了一些封裝
-屬性:
queryset # 要序列化的資料
serializer_class # 指明檢視使用的序列化器
-方法:
get_queryset:獲取qs資料(返回檢視使用的查詢集,主要用來提供給Mixin擴充套件類使用,
是列表檢視與詳情檢視獲取資料的基礎,預設返回queryset屬性)
get_object:獲取一條資料的物件(返回詳情檢視所需的模型類資料物件,主要用來
提供給Mixin擴充套件類使用。在試圖中可以呼叫該方法獲取詳情資訊的模型類物件)
get_serializer:以後使用它來例項化得到ser物件(返回序列化器物件,主要用來
提供給Mixin擴充套件類使用,如果我們在檢視中想要獲取序列化器物件,也可以直接呼叫此方法)
get_serializer_class:獲取序列化類,注意跟上面區分
匯入模組: from rest_framework.views import GenericAPIView
-queryset = None #查那個表,就把 表名.objects.all()
-serializer_class = None # 要使用那個序列化類序列化資料,把類名寫上
---------------------------------------------------------------------------------------
from rest_framework.views import GenericAPIView
from .serializer import BookSerializer # 匯入序列化器(類)
class Books(GenericAPIView):
# 將資料和序列化提示為類屬性,所有的請求方法都可以複用
queryset = Book.objects.all() # 要序列化的資料
serializer_class = BookSerializer # BookSerializer是匯入的序列化類
lookup_field = 'pk' # 可以省略,預設是pk,與url有名分組對應的
def get(self,request):
# book = models.Book.objects.filter(is_delete=False).all() # => 方法+屬性兩行程式碼
book = self.get_queryset()
# serializer = serializers.BookSerializer(instance=book, many=True) # => 方法+屬性兩行程式碼
obj = self.get_serializer(book,many=True) # 多條需要指定many=True
return Response(obj.data)
def post(self,request):
# obj = serializers.BookModelSerializer(data=request.data)
# 把前端傳入的資料,完成例項化,得到序列化類的物件
obj = self.get_serializer(data = request.data) # 等同於上面的操作
if obj.is_valid():
obj.save()
return Response(obj.data)
class Bookss(GenericAPIView):
queryset = Book.objects.all() # 同上~
serializer_class = BookSerializer
def get(self,request,pk):
book = self.get_object() # 不同的是獲取單挑是用self.get_object()
obj = self.get_serializer(instance=book)
return Response(obj.data)
def put(self,request,pk):
book = self.get_object()
obj = self.get_serializer(instance=book,data=request.data)
if obj.is_valid():
obj.save()
return Response(obj.data)
def delete(self,request,pk):
self.get_object().delete()
return Response()
五個檢視擴充套件類
檢視擴充套件類:mixins包下的五個類(六個方法)
作用:
提供了幾種後端檢視(對資料資源進行曾刪改查)處理流程的實現,如果需要編寫的檢視屬於這五種,則檢視可以通過繼承相應的擴充套件類來複用程式碼,減少自己編寫的程式碼量。
這五個擴充套件類需要搭配GenericAPIView父類,因為五個擴充套件類的實現需要呼叫GenericAPIView提供的序列化器與資料庫查詢的方法。
匯入模組:
from rest_framework.mixins import CreateModelMixin,ListModelMixin,DestroyModelMixin,UpdateModelMixin,RetrieveModelMixin
CreateModelMixin #內部有create方法,就是新增
ListModelMixin #內部有list方法,就是查詢所有
DestroyModelMixin # 內部有destory方法,就是刪除單條
UpdateModelMixin # 內部有update方法,就是修改一條
RetrieveModelMixin # 內部有retrieve方法,就是查詢單條
"""
檢視基類:APIView、GenericAPIView
檢視擴充套件類:mixins包下的五個類(六個方法)
"""
""" GenericAPIView基類(基本不會單獨使用,瞭解即可,但是是高階檢視類的依賴基礎)
1)GenericAPIView繼承APIView,所有APIView子類寫法在繼承GenericAPIView時可以保持一致
2)GenericAPIView給我們提供了三個屬性 queryset、serializer_class、lookup_field
3)GenericAPIView給我們提供了三個方法 get_queryset、get_serializer、get_obj
"""
""" mixins包存放了檢視工具類(不能單獨使用,必須配合GenericAPIView使用)
1 查所有:ListModelMixin
列表檢視擴充套件類,提供list(request, *args, **kwargs)方法快速實現列表檢視,返回200狀態碼。
該Mixin的list方法會對資料進行過濾和分頁。
2 查一個:RetrieveModelMixin
建立檢視擴充套件類,提供create(request, *args, **kwargs)方法快速實現建立資源的檢視,成功返回201狀態碼。
如果序列化器對前端傳送的資料驗證失敗,返回400錯誤。
3 增一個:CreateModelMixin
詳情檢視擴充套件類,提供retrieve(request, *args, **kwargs)方法,可以快速實現返回一個存在的資料物件。
如果存在,返回200, 否則返回404
4 改一個:UpdateModelMixin
更新檢視擴充套件類,提供update(request, *args, **kwargs)方法,可以快速實現更新一個存在的資料物件。
同時也提供partial_update(request, *args, **kwargs)方法,可以實現區域性更新。
成功返回200,序列化器校驗資料失敗時,返回400錯誤。
5 刪一個:DestroyModelMixin
刪除檢視擴充套件類,提供destroy(request, *args, **kwargs)方法,可以快速實現刪除一個存在的資料物件
成功返回204,不存在返回404。
"""
""" generics包下的所有GenericAPIView的子類(就是繼承GenericAPIView和不同mixins下的工具類的組合)
1)定義的檢視類,繼承generics包下已有的特點的GenericAPIView子類,可以在只初始化queryset和serializer_class兩個類屬性後,就獲得特定的功能
2)定義的檢視類,自己手動繼承GenericAPIView基類,再任意組合mixins包下的一個或多個工具類,可以實現自定義的工具檢視類,獲得特定的功能或功能們
注:
i)在這些模式下,不能實現單查群查共存(可以加邏輯區分,也可以用檢視集知識)
ii)DestroyModelMixin工具類提供的destory方法預設是從資料庫中刪除資料,所以一般刪除資料的需求需要自定義邏輯
"""
案例:
from rest_framework.generics import GenericAPIView
from rest_framework.mixins import CreateModelMixin,ListModelMixin,DestroyModelMixin,UpdateModelMixin,RetrieveModelMixin
class BookView(GenericAPIView,CreateModelMixin,ListModelMixin):
queryset = Books.objects.all()
serializer_class = BookSerializer
def get(self,request):
# # 拿到所有
# obj_list=self.get_queryset()
# # 得到序列化物件
# ser=self.get_serializer(obj_list,many=True)
# # 返回資料
# return Response(ser.data)
return self.list(request) # 無需上面操作 直接self.list即可 都封裝好了
def post(self,request):
# # 把前端傳入的資料,完成例項化,得到序列化類的物件
# ser = self.get_serializer(data=request.data)
# # 校驗資料
# if ser.is_valid():
# ser.save()
# return Response(ser.data)
return self.create(request)
#
# def perform_create(self, serializer):
# #邏輯
# super().perform_create()
class BookDetailView(GenericAPIView,RetrieveModelMixin,DestroyModelMixin,UpdateModelMixin):
queryset = Books.objects.all()
serializer_class = BookSerializer
def get(self, request,pk):
# 獲取單條
# obj=self.get_object()
# # 得到單條的序列化物件
# ser = self.get_serializer(obj)
# return Response(ser.data)
return self.retrieve(request, pk)
def delete(self,request,pk):
# # 獲取單條,通過pk獲取的
# obj=self.get_object()
# # 刪除物件
# obj.delete()
# return Response()
return self.destroy(request,pk)
def put(self,request,pk):
# # 獲取單條
# obj = self.get_object()
# # 得到序列化類物件,傳入單條物件和要修改的資料字典
# ser=self.get_serializer(obj,data=request.data)
# if ser.is_valid():
# ser.save()
# return Response(ser.data)
return self.update(request,pk)
九個檢視子類
ListAPIView,
CreateAPIView,
UpdateAPIView,
DestroyAPIView,
RetrieveAPIView,
ListCreateAPIView,
RetrieveUpdateDestroyAPIView,
RetrieveDestroyAPIView,
RetrieveUpdateAPIView
九個檢視子類詳解
1)查所有:ListAPIView # 獲取所有,檢視類只需要繼承它,寫兩個類屬性,就有獲取所有的功能了
提供 get 方法
繼承自:GenericAPIView、ListModelMixin
例如:
class Books(ListAPIView): # 獲取所有
queryset = Book.objects.all() # 寫兩個類屬性
serializer_class = BookSerializer
2)增一個:CreateAPIView
# 建立1個,檢視類只需要繼承它,寫兩個類屬性,就有建立一個所有的功能了
提供 post 方法
繼承自: GenericAPIView、CreateModelMixin
3)查所有+增一個:ListCreateAPIView
# 查詢所有與建立一個 檢視類只需要繼承它,寫兩個類屬性,就有建立一個和查詢所有的功能了
提供 get 和 post 方法
繼承自: GenericAPIView、ListModelMixin、CreateModelMixin
4)查一個:RetrieveAPIView
# 查詢1個,檢視類只需要繼承它,寫兩個類屬性,就有查詢一個的功能了
提供 get 方法
繼承自: GenericAPIView、RetrieveModelMixin
5)改一個:UpdateAPIView
# 修改1個,檢視類只需要繼承它,寫兩個類屬性,就有修改一個的功能了
提供 put 和 patch 方法
繼承自:GenericAPIView、UpdateModelMixin
6)刪一個:DestoryAPIView
# 刪除1個,檢視類只需要繼承它,寫兩個類屬性,就有刪除一個的功能了
提供 delete 方法
繼承自:GenericAPIView、DestoryModelMixin
7)查一個+改一個:RetrieveUpdateAPIView
# 查1個+改1個,檢視類只需要繼承它,寫兩個類屬性,就有查1個與改1個的功能了
提供 get、put、patch方法
繼承自: GenericAPIView、RetrieveModelMixin、UpdateModelMixin
8)查一個+刪一個:RetrieveDestroyAPIView
# 查1個+刪1個,檢視類只需要繼承它,寫兩個類屬性,就有查1個與刪1個的功能了
提供 get 和 delete 方法
繼承自: GenericAPIView、RetrieveModelMixin、DestoryModelMixin
9) 查一個+改一個+刪一個:RetrieveUpdateDestoryAPIView
# 查1個+改1個+刪1個,檢視類只需要繼承它,寫兩個類屬性,就有查1個+改1個+刪1個的功能了
提供 get、put、patch、delete方法
繼承自:GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin
案例:
from rest_framework.generics import ListAPIView,CreateAPIView,UpdateAPIView,RetrieveAPIView,DestroyAPIView,ListCreateAPIView,RetrieveDestroyAPIView,RetrieveUpdateAPIView,RetrieveUpdateDestroyAPIView
class Books(ListAPIView,CreateAPIView): # 繼承這兩個類 寫兩個類屬性
# 查詢所有與建立一個 寫兩個類屬性,就有建立一個和查詢所有的功能了
# 也可以直接繼承ListCreateAPIView 效果一樣
queryset = Book.objects.all()
serializer_class = BookSerializer
class Bookss(RetrieveUpdateDestroyAPIView):
# 繼承RetrieveUpdateDestroyAPIView就有查1個+改1個+刪1個的功能了
queryset = Book.objects.all() # 之後寫兩個類屬性即可
serializer_class = BookSerializer
也可以單獨繼承你所需要的介面屬性
例如:
你只需要刪除資訊與修改資訊 那麼你只需要繼承UpdateAPIView,DestroyAPIView即可
檢視集ViewSet
使用檢視集ViewSet,可以將一系列邏輯相關的動作放到一個類中:
-
list() 提供一組資料
-
retrieve() 提供單個資料
-
create() 建立資料
-
update() 儲存資料
-
destory() 刪除資料
ViewSet檢視集類不再實現get()、post()等方法,而是實現動作 action 如 list() 、create() 等。
檢視集只在使用as_view()方法的時候,才會將action動作與具體請求方式對應上。
只要繼承ViewSetMixin的檢視類,以後路由寫發特殊了
而檢視集都直接或者間接的繼承了ViewSetMixin
# ViewSetMixin類----》重寫了as_view方法---》view跟之前(APIView的as_view)不一樣了
-path('books/', views.BookView.as_view({'get':'list','post':'create'}))
常用的檢視集父類
1) ViewSet
繼承自APIView與ViewSetMixin,作用也與APIView基本類似,提供了身份認證、許可權校驗、流量管理等。
ViewSet主要通過繼承ViewSetMixin來實現在呼叫as_view()時傳入字典(如{‘get’:’list’})的對映處理工作。
在ViewSet中,沒有提供任何動作action方法,需要我們自己實現action方法。
總結:如果路由想寫成特殊的,如果要繼承APIView----》直接繼承ViewSet
2)GenericViewSet
使用ViewSet通常並不方便,因為list、retrieve、create、update、destory等方法都需要自己編寫,而這些方法與前面講過的Mixin擴充套件類提供的方法同名,所以我們可以通過繼承Mixin擴充套件類來複用這些方法而無需自己編寫。但是Mixin擴充套件類依賴與GenericAPIView,所以還需要繼承GenericAPIView。
GenericViewSet就幫助我們完成了這樣的繼承工作,繼承自GenericAPIView與ViewSetMixin,在實現了呼叫as_view()時傳入字典(如{'get':'list'})的對映處理工作的同時,還提供了GenericAPIView提供的基礎方法,可以直接搭配Mixin擴充套件類使用。
總結:如果路由想寫成特殊的,如果要繼承GenericAPIView----》直接繼承GenericViewSet
3)ModelViewSet
繼承自GenericViewSet,同時包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。
5個介面寫好了、ModelViewSet繼承了5個檢視擴充套件類,GenericAPIView 和 ViewSetMixin
4)ReadOnlyModelViewSet
繼承自GenericViewSet,同時包括了ListModelMixin、RetrieveModelMixin。
檢視集案例:
# 模型層models.py 和序列化類層 serializer.py參照上面即可
# 路由層 urls.py
from django.contrib import admin
from django.urls import path
from app01 import views
urlpatterns = [
path('admin/', admin.site.urls),
# 查詢所有書籍,增加書籍
path('book/', views.BookView.as_view({'get': 'list', 'post': 'create'})),
# 查詢,修改,刪除單本書籍
path('book/<int:pk>/', views.BookView.as_view({'get': 'retrieve', 'put': 'update', 'delete': 'destroy'})),
path('publish/', views.PublishView.as_view({'get': 'lqz'})),
]
# 檢視層 views.py
###目標:只寫一個檢視類,實現5個介面,最大的問題是,倆介面,都是get
####第五層:檢視集
# ModelViewSet 5個介面都有
# ModelViewSet 繼承了GenericViewSet和五個檢視擴充套件類
# ReadOnlyModelViewSet:只有讀的兩個介面
from rest_framework.viewsets import ModelViewSet, ReadOnlyModelViewSet
from rest_framework.viewsets import ViewSet, GenericViewSet, ViewSetMixin
#ViewSet是:ViewSetMixin, views.APIView
#GenericViewSet是:ViewSetMixin, GenericAPIView
# ViewSetMixin:魔法
### 如果檢視類繼承了ViewSetMixin這個類,路由寫法就需要path('book/', views.BookView.as_view({'get': 'list', 'post': 'create'})
'''
原始碼對映關係
{'get': 'list', 'post': 'create'}
'get' 'list'
for method, action in actions.items():
handler = getattr(self, action)
setattr(self, method, handler)
'''
###如果檢視類繼承了ViewSetMixin這個類,路由的as_view執行的是ViewSetMixin的as_view
# 查詢所有書籍,增加一本書籍,查詢、修改、刪除單本書籍
class BookView(ModelViewSet):
queryset = models.Book.objects.all() # 要序列化的資料
serializer_class = serializer.BookModelSerializer # 要序列化的類
class PublishView(GenericViewSet): # 路由變了,其它都沒變(注意繼承的類,不要混淆了)
queryset = models.Publish.objects.all() # 要序列化的資料
serializer_class = serializer.PublishModelSerializer # 要序列化的類
def lqz(self,request): # 自定義lqz就是獲取所有
qs = self.get_queryset()
ser = self.get_serializer(qs, many=True)
return Response(ser.data)
總結
#兩個基類
APIView
GenericAPIView:有關資料庫操作,queryset 和serializer_class
#5個檢視擴充套件類(rest_framework.mixins)
CreateModelMixin:create方法建立一條
DestroyModelMixin:destory方法刪除一條
ListModelMixin:list方法獲取所有
RetrieveModelMixin:retrieve獲取一條
UpdateModelMixin:update修改一條
#9個子類檢視(rest_framework.generics)
CreateAPIView:繼承CreateModelMixin,GenericAPIView,有post方法,新增資料
DestroyAPIView:繼承DestroyModelMixin,GenericAPIView,有delete方法,刪除資料
ListAPIView:繼承ListModelMixin,GenericAPIView,有get方法獲取所有
UpdateAPIView:繼承UpdateModelMixin,GenericAPIView,有put和patch方法,修改資料
RetrieveAPIView:繼承RetrieveModelMixin,GenericAPIView,有get方法,獲取一條
ListCreateAPIView:繼承ListModelMixin,CreateModelMixin,GenericAPIView,有get獲取所有,post方法新增
RetrieveDestroyAPIView:繼承RetrieveModelMixin,DestroyModelMixin,GenericAPIView,有get方法獲取一條,delete方法刪除
RetrieveUpdateAPIView:繼承RetrieveModelMixin,UpdateModelMixin,GenericAPIView,有get獲取一條,put,patch修改
RetrieveUpdateDestroyAPIView:繼承RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin,GenericAPIView,有get獲取一條,put,patch修改,delete刪除
#檢視集
ViewSetMixin:重寫了as_view
ViewSet: 繼承ViewSetMixin和APIView
GenericViewSet:繼承ViewSetMixin, generics.GenericAPIView
ModelViewSet:繼承mixins.CreateModelMixin,mixins.RetrieveModelMixin,mixins.UpdateModelMixin,mixins.DestroyModelMixin,mixins.ListModelMixin,GenericViewSet
ReadOnlyModelViewSet:繼承mixins.RetrieveModelMixin,mixins.ListModelMixin,GenericViewSet
本篇知識回顧
1 序列化器原始碼
-many引數控制,在__new__中控制了物件的生成
-區域性和全域性鉤子原始碼:is_valid--》找self.方法一定要從根上找
-source引數是如何執行的:‘publish.name’,'方法'
2 檢視:
-2個檢視基類
-5個檢視擴充套件類
-9個檢視子類
-檢視集
-ViewSetMixin
-ViewSet, GenericViewSet
-ModelViewSet, ReadOnlyModelViewSet
3 檢視類的繼承原則
-如果不涉及資料庫操作:繼承APIView
-如果想讓路由可以對映:繼承ViewSetMixin
-如果不涉及資料庫操作,又要讓路由可以對映:繼承ViewSet
-比如發郵件介面,發簡訊介面
-如果涉及到資料庫操作:繼承GenericAPIView
-如果想讓路由可以對映:繼承ViewSetMixin
-如果涉及資料庫操作,又要讓路由可以對映:繼承GenericViewSet
-如果涉及資料庫操作,又要讓路由可以對映,還要能新增:繼承GenericViewSet+CreateModelMixin或者繼承ViewSetMixin+CreateAPIView
-如果只涉及到資料庫操作和新增:繼承CreateAPIView
-路由有對映,資料庫操作,3個介面(查一個,刪一個改一個)
4 ViewSetMixin:路由的寫法就特殊了
5 類例項化,先執行了元類的__call__:呼叫了這個類的__new__,生成一個空物件,呼叫了類的__init__,完成了物件的初始化
6 物件()---->會觸發類的 __call__
7 類()----->會觸發類的類(元類)的__call__