1 認(rèn)證源碼分析
資料鏈接:http://www.sohu.com/a/222215490_729271
2 處理請求wsgi分析與視圖View
資料鏈接:https://blog.csdn.net/qq_33339479/article/details/78879571
- 基類View的簡要分析
在url中牵寺,調(diào)用View類中的as_view方法,此時(shí)就會調(diào)用as_view中的view方法腐泻,該方法最終調(diào)用View類的self.dispatch,通過篩選后調(diào)用相應(yīng)的handler處理绿语。 handler對應(yīng)的就是get/post/put/delete等具體的方法腊敲。所以在繼承View的class中谢翎,只要重新定義了get/post/put/delete方法,URL調(diào)用時(shí)會自動進(jìn)入該類相應(yīng)的方法中哲戚。
3 視圖類的對比分析
資料鏈接:https://blog.csdn.net/odyssues_lee/article/details/80895207
3.1 APIView與View的不同(APIView繼承與View)
from django.views import View
from rest_framework.views import APIView
- (1) View來自django.views爹耗,APIView來自rest_framework.views耙考,APIView比View有更多的封裝,且APIView繼承于View潭兽。
- (2) APIView傳入到視圖方法中的是REST framework的Request對象琳骡,而不是Django的HttpRequeset對象;
- (3)視圖方法可以返回REST framework的Response對象讼溺,視圖會為響應(yīng)數(shù)據(jù)設(shè)置(render)符合前端要求的格式楣号;
- (4) 任何APIException異常都會被捕獲到,并且處理成合適的響應(yīng)信息怒坯;
- (5)在進(jìn)行dispatch()分發(fā)前炫狱,多了對請求進(jìn)行身份認(rèn)證、權(quán)限檢查、流量控制。對應(yīng)的源碼如下:
# Ensure that the incoming request is permitted
self.perform_authentication(request)
self.check_permissions(request)
self.check_throttles(request)
- (6)獲取參數(shù)的區(qū)別
繼承View的類:
get 獲取參數(shù):params = req.GET
post 獲取參數(shù):params = req.POST
put/delete獲取參數(shù):params = QueryDict(req.body)
from django.http import QueryDict
繼承APIView的類:
get 獲取參數(shù):params = req.query_params
post/put/delete獲取參數(shù):params = req.data
APIView支持定義的屬性:
- authentication_classes 列表或元祖蕊唐,身份認(rèn)證類
- permissoin_classes 列表或元祖,權(quán)限檢查類
- throttle_classes 列表或元祖酷含,流量控制類
3.2 GenericAPIView(繼承自APIView)
GenericAPIView較APIView有了更多的封裝:增加了對于列表視圖和詳情視圖可能用到的通用支持方法鄙早。通常使用時(shí),可搭配一個(gè)或多個(gè)Mixin擴(kuò)展類椅亚。
- 多了屬性:
queryset 列表視圖的查詢集
serializer_class 視圖使用的序列化器
pagination_class 分頁控制類
filter_backends 過濾控制后端
lookup_field 查詢單一數(shù)據(jù)庫對象時(shí)使用的條件字段(lookup_field的值為數(shù)據(jù)庫表里的字段)限番,默認(rèn)為'pk'
lookup_url_kwarg 查詢單一數(shù)據(jù)時(shí)URL中的參數(shù)關(guān)鍵字名稱,默認(rèn)與look_field相同
# lookup_field與lookup_url_kwarg的使用舉例
url(r"^config/(?P<id>/$", views.TestView.as_view()),
class TestView(mixins.UpdateModelMixin,
mixins.DestroyModelMixin,
generics.GenericAPIView):
"""改配置"""
queryset = Config.objects.all()
lookup_field = ('uuid')
lookup_url_kwarg = ('id')
def put(self, request, *args, **kwargs):
instance = self.get_object()
# get_object會根據(jù)lookup_field 和lookup_url_kwarg 的值來過濾獲取單個(gè)對象呀舔,過濾方法相當(dāng)于:filter(uuid=id參數(shù)的值)弥虐。
# uuid為數(shù)據(jù)庫表里的字段,id為參數(shù)中的關(guān)鍵字媚赖,即獲取的是字段uuid=id參數(shù)的值的對象霜瘪。通常lookup_url_kwarg 默認(rèn)就是lookup_field 的值,代碼中只需要設(shè)置lookup_field 惧磺,只有兩者值不相同時(shí)才需要分別單獨(dú)設(shè)置颖对。
- 多提供的方法:
get_queryset(self):返回視圖使用的查詢集,是列表視圖與詳情視圖獲取數(shù)據(jù)的基礎(chǔ)磨隘,默認(rèn)返回queryset屬性缤底,可以重寫,例如:
def get_queryset(self):
user = self.request.user
return user.accounts.all()
get_serializer_class(self)返回序列化器類琳拭,默認(rèn)返回serializer_class训堆,可以重寫描验,例如:
def get_serializer_class(self):
if self.request.user.is_staff:
return FullAccountSerializer
return BasicAccountSerializer
get_serializer(self, args, *kwargs)返回序列化器對象白嘁,被其他視圖或擴(kuò)展類使用,如果我們在視圖中想要獲取序列化器對象膘流,可以直接調(diào)用此方法絮缅。
get_object(self):返回詳情視圖所需的模型類數(shù)據(jù)對象,默認(rèn)使用lookup_field參數(shù)來過濾queryset呼股。 在試圖中可以調(diào)用該方法獲取詳情信息的模型類對象耕魄。
若詳情訪問的模型類對象不存在,會返回404彭谁。
get_serializer_context:獲取序列化的數(shù)據(jù)吸奴,定義了某種格式的字典
class BookDetailView(GenericAPIView):
queryset = BookInfo.objects.all()
serializer_class = BookInfoSerializer
def get(self, request, pk):
book = self.get_object()
serializer = self.get_serializer(book)
return Response(serializer.data)
3.3 配合使用的5個(gè)類擴(kuò)展(from rest_framework import mixins)
宏觀感受: mixins的這5個(gè)類擴(kuò)展方法主要是對數(shù)據(jù)的增刪改查進(jìn)行封裝.
ListModelMixin:提供list(request, *args, **kwargs)方法快速實(shí)現(xiàn)列表視圖,返回200狀態(tài)碼缠局。該Mixin的list方法會對數(shù)據(jù)進(jìn)行過濾和分頁则奥。
CreateModelMixin:提供create(request, *args, **kwargs)方法快速實(shí)現(xiàn)創(chuàng)建資源的視圖,成功返回201狀態(tài)碼狭园。在一些情境下读处,我們需要對里面的perform_create( )進(jìn)行重寫。例如:
def perform_create(self, serializer):
# 重寫save的邏輯,除了serializer.save()外,還需要對course的收藏?cái)?shù)fav_num加1
instance = serializer.save()
course = instance.course
course.fav_num += 1
course.save()
RetrieveModelMixin:提供retrieve(request, *args, **kwargs)方法唱矛,可以快速實(shí)現(xiàn)返回一個(gè)存在的數(shù)據(jù)對象罚舱。對retrieve這個(gè)方法的重寫幾率比較高井辜,例如我們在增加點(diǎn)擊數(shù)的時(shí)候,經(jīng)常要對其進(jìn)行一個(gè)重寫管闷。
UpdateModelMixin:提供update(request, *args, **kwargs)方法粥脚,可以快速實(shí)現(xiàn)更新一個(gè)存在的數(shù)據(jù)對象。同時(shí)也提供partial_update(request, *args, **kwargs)方法渐北,可以實(shí)現(xiàn)局部更新阿逃。如果需要對更新這個(gè)邏輯進(jìn)行自定義,那么需要重寫perform_update( )方法赃蛛,而盡量少去重寫update( )
DestroyModelMixin:提供destroy(request, *args, **kwargs)方法恃锉,可以快速實(shí)現(xiàn)刪除一個(gè)存在的數(shù)據(jù)對象。
3.4 子類視圖
rest_framework.generics里面除了提供GenericAPIView以外,還有CreateAPIView/ListAPIView/RetrieveAPIView/DestroyAPIView/UpdateAPIView/ListCreateAPIView/RetrieveUpdateAPIView/RetrieveDestroyAPIView/RetrieveUpdateDestroyAPIView 9個(gè)子類視圖,這些視圖函數(shù)無非都是GenericAPIView與上面mixins的5個(gè)類擴(kuò)展的各種組合.例如:
- 1) CreateAPIView
提供 post 方法呕臂,繼承自: GenericAPIView破托、CreateModelMixin - 2)ListAPIView
提供 get 方法,繼承自:GenericAPIView歧蒋、ListModelMixin - 3)RetireveAPIView
提供 get 方法土砂,繼承自: GenericAPIView、RetrieveModelMixin - 4)DestoryAPIView
提供 delete 方法谜洽,繼承自:GenericAPIView萝映、DestoryModelMixin - 5)UpdateAPIView
提供 put 和 patch 方法,繼承自:GenericAPIView阐虚、UpdateModelMixin - 6)RetrieveUpdateAPIView
提供 get序臂、put、patch方法实束,繼承自: GenericAPIView奥秆、RetrieveModelMixin、UpdateModelMixin - 7)RetrieveUpdateDestoryAPIView
提供 get咸灿、put构订、patch、delete方法避矢,繼承自:GenericAPIView悼瘾、RetrieveModelMixin、UpdateModelMixin审胸、DestoryModelMixin
3.5 視圖類的使用舉例
參考資料1:https://blog.csdn.net/u013210620/article/details/79869661
BookView是對book表的所有記錄查詢亥宿、增加某些數(shù)據(jù)記錄
BookViewDetail是對book表單條數(shù)據(jù)的查詢、修改歹嘹、刪除
from rest_framework import mixins
from rest_framework import generics
#ListModelMixin適用于查詢數(shù)據(jù)列表
class BookView(mixins.ListModelMixin,
mixins.CreateModelMixin,
generics.GenericAPIView):
queryset = Book.objects.all()
serializer_class = BookSerializers
def get(self, request, *args, **kwargs):
return self.list(request, *args, **kwargs)
def post(self, request, *args, **kwargs):
return self.create(request, *args, **kwargs)
/*
RetrieveModelMixin 適用于查詢單個(gè)對象的詳情數(shù)據(jù)箩绍,
UpdateModelMixin 適用于更新單條數(shù)據(jù)
DestroyModelMixin 刪除單條數(shù)據(jù)
*/
class BookViewDetail(
mixins.RetrieveModelMixin,
mixins.DestroyModelMixin,
mixins.UpdateModelMixin,
generics.GenericAPIView
):
queryset = Book.objects.all()
serializer_class = BookSerializers
def get(self,request, *args, **kwargs):
return self.retrieve(request, *args, **kwargs)
def delete(self,request, *args, **kwargs):
return self.destroy(request, *args, **kwargs)
def put(self,request, *args, **kwargs):
return self.update(request, *args, **kwargs)
3.6 viewSet視圖
django中除了上面提到的GenericAPIView等視圖外,還有一類很重要的視圖函數(shù)--ViewSet類視圖,viewsets.py文件中提供的.
參考資料:https://blog.csdn.net/u013210620/article/details/79879611
http://www.reibang.com/p/2c3fc8060a63
幾種ViewSet類的關(guān)系圖:
- 基類ViewSetMixin中重寫了as_view()方法,方便了對API路由的管理.
3.6.1 viewSet類視圖與url的綁定方法
- 方法一:action中綁定
ViewSetMixin的as_view()方法中提供了actions參數(shù),可以利用action參數(shù)將get/post/put/delete等方法與list/create/update/destroy等動作關(guān)聯(lián)起來.使用舉例:
urlpatterns = [
url(r"bookset/$",BookSet.as_view({'get': 'list', 'post': 'create'})),
url(r"bookset/(?P<pk>\d+)/$",BookSet.as_view({'get': 'retrieve', 'put': 'update','delete': 'destroy'})),
]
- 方法二:action中綁定方式二
這種方法的本質(zhì)同方法一,只不過是將as_view的綁定過程抽出來了,例如:
book_list = BookSet.as_view({
'get': 'list',
'post': 'create'
})
book_detail = BookSet.as_view({
'get': 'retrieve',
'put': 'update',
'patch': 'partial_update',
'delete': 'destroy'
})
urlpatterns = [
url(r'^bookset/$', book_list, name='book-list'),
url(r'^bookset/(?P<pk>\d+)/$', book_detail, name='book-detail'),
]
- 方法三:routers自動綁定
使用舉例:
from django.conf.urls import url,include
from rest_framework.routers import DefaultRouter
router = DefaultRouter()
router.register(r'bookset', BookSet)
urlpatterns = [
url(r'^', include(router.urls)),
]
備注:router的方式中雖然沒有定義name參數(shù),但router內(nèi)部會自動生成,name的格式同方法二中name的格式.
3.7 @list_route和@detail_route的使用
list_route和detail_route裝飾器是為了能在Viewset中自定義方法而提供的.兩者的區(qū)別是list_route對應(yīng)的detail=False,detail_route對應(yīng)的detail=True,也就是list_route對應(yīng)的是一般列表,而detail_route需要返回詳情.
在DRF 3.10這個(gè)版本后使用 @action 代替了 @list_router和@detail_router。
@detail_route 相當(dāng)于 @action(detail=True).
@list_route 相當(dāng)于 @action(detail=False).