1. 程式人生 > >rest_framework -- mixins&generics

rest_framework -- mixins&generics

上面的mixins、generics都是rest_framework裡的模組,我們可以繼承其中的某些類,達到程式碼量減少的效果,這裡充分體現出了面向物件的繼承

一、mixins模組

mixins  : from rest_framework import mixins #匯入方式
          存放一些增刪改查的一些類  
          CreateModelMixin,ListModelMixin,RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin

二、generics模組

generics: from
rest_framework import generics # 匯入方式 首先mixins檔案中就是一個一個類,寫著某些方法,但是你想用於CBV,必須繼承django的View,這裡我們用rest_framework則需繼承APIView, 這個py檔案裡定義了許多類,但是有一個最基本的類GenericAPIView(views.APIView),裡面其他的類都會繼承這個類,因為這個類定義的一些 方法是專門提供於mixins檔案裡的類的,再看其他generics模組裡的其他類,你會發現那麼類全是基於mixins模組和GenericAPIView之間的組 合,那麼你想用rest_framework提供給我們的簡便方法,那麼必須要繼承GenericAPIView,和mixins模組裡的類。

三、通過一個簡單的例子,順帶寫mixins,generics的用處

eg:寫一個介面,獲取到所有書籍的資料,這裡我只寫檢視類裡的程式碼
from rest_framework.generics import GenericAPIView
from rest_framework.mixins import ListModelMixin
from app import models
from write_serializers import BooksSerializers

class Books(GenericAPIView,ListModelMixin):
    queryset 
= models.Book.objects.all() serializer_class = BooksSerializers def get(self,request,*args,**kwargs): return self.list(request, *args, **kwargs)
好了,上面就是我們通過rest_framework提供的方法之一,完成了一個簡單的介面,
來一個GET請求,便會執行這個檢視類的get方法,最終返回了self.list方法的執行結果,那我們去看看list方法是怎麼執行的,
那麼我們順著繼承的基類去找list方法,基於深度查詢,我們找完GenericAPIView繼承的基類們,並沒有找到,那麼我們去ListModelMixin
這個類中找,這個類很簡單,就寫了一個list方法。

   

先看list方法,裡面有self.filter_queryset(),self.paginate_queryset(),self.get_serializer()等等方法,很明顯檢視類中
沒有寫這些方法,ListModelMixin這個類裡也沒有,那麼肯定在GenericAPIView,所以我之前就說了,GenericAPIView類是為mixins模組裡
類提供方法的,所以二者必須一起使用。
分析1: queryset = self.filter_queryset(self.get_queryset())
queryset = self.filter_queryset(self.get_queryset())
這行程式碼整體意思應該能看得懂吧,filter_queryset這個方法的返回值賦值給queryset,而filter_queryset的引數是get_queryset
的返回值,那麼我們先去看filter_queryset這方法的引數是什麼,也就是get_queryset的返回值
  
首先,斷言self.queryset這個屬性的布林值必須是True的,不是的話便會拋異常,我們先看GenericAPIView類中有沒有這個屬性(這並不是 屬性的查詢順序),我們可以找到queryset = None,這樣的話,我們再寫檢視類的話(前提是繼承了這個類),沒有寫queryset這個屬性或者值 為False,那麼便會出錯,所以queryset這個屬性必須在檢視類中為True。 根據這個我想到一點分享下,你可以用斷言這種方法,指定它的子類必須要有該屬性且值為True,對吧,方法也是一樣,定義一個方法,在該方法 內寫一個raise異常,rest_framework裡很多就是通過這種方法,比如rest_framework.throttling.BaseThrottle這個類裡的方法為allow_request。
接著上面繼續,能走到return,就代表self.queryset肯定為True吧,前面的邏輯處理就不多說了。從現在看的話,那麼這個queryset可以為 任何值吧,引數的值是什麼了,繼續看self.filter_queryset()這個方法的返回值
  
這個你可以看它的註釋,大概意思是將傳來的引數queryset,再過濾一遍,self.filter_backends它的值為None,前提不進行任何設定,而 這個設定是在settings檔案裡的REST_FRAMEWORK,也就是之前進行全域性設定登陸認證,許可權認證的地方。不進行設定的話,還是會返回之前的 傳進來的引數。最終賦值給queryset
分析2:page = self.paginate_queryset(queryset)
page = self.paginate_queryset(queryset)
引數我們知道是什麼,直接看paginate_queryset方法吧

self.paginator它是被裝飾成屬性的方法,self.paginator它的返回不是None就是一個物件(這個物件是進行分頁的),上面我們列舉的例子
檢視類中並沒有寫pagination_class這個屬性,那麼就會去找到預設pagination_class,預設值為None,如果你再檢視類中寫了該屬性,
值應該是是一個類,最後會返回這個類的物件回去。如果self.paginator為True,那麼self.paginator就是一個物件了,就會執行該物件
下面的paginate_queryset這個方法。
提醒:不管self.paginator這個物件是自定義的類產生的,還是rest_framework自帶的,那麼肯定會有paginate_queryset方法。它的返
          回值肯定是某一頁的物件列表。
分析3:serializer = self.get_serializer(queryset, many=True)
不管有沒有進行分頁,都會執行get_serializer這個方法,返回值為serializer,最終返回serializer.data
不難可以看出,我們寫的檢視類中必須要有serializer_class屬性,且有值,這個和前面queryset這屬性是一樣的。最終返回序列化的物件
 
 
總結下:我們寫的檢視類必須要有serializer_class --->> 寫序列化類
                                        queryset  ---->> queryset的物件
             可有可無看需求:pagination_class ---->>   進行分頁的類
在GenericAPIView還有一個方法再說下get_object方法,這個方法在RetrieveModelMixin,UpdateModelMixin,DestroyModelMixin都用上了,看方法名就差不多知道,返回一個物件。
         
            分析1: queryset = self.filter_queryset(self.get_queryset()) 這個跟之前分析的一樣,(見上面的分析1)
            
            分析2: lookup_url_kwarg = self.lookup_url_kwarg or self.lookup_field
                   這個其實沒啥好說的,就說一點or,and的用法,我部落格也寫了這個,可以去看看
                   
            分析3: lookup_url_kwarg in self.kwargs
                   這句話很簡單,判斷lookup_url_kwarg這個值在不在self.kwargs這個容器裡,但是這個self.kwargs到底是什麼呢?self就是
                   當前的檢視類的物件,它有kwargs這個屬性?
                   先自己思考下,我在後面再寫出來
                   
            分析4: obj = get_object_or_404(queryset, **filter_kwargs)
                   首先我們要弄清傳的引數的是什麼,filter_kwargs是一個字典({'pk':1}),那麼**filter_kwargs就是pk=1,queryset這個就不
                   用在介紹了,看看這個方法get_object_or_404,
                  
                    利用get方法,如果get裡的引數不能找到唯一的一條資料的話,便會拋異常,通過捕捉異常去處理。程式順利進行的話,那麼返回的就是get
                    到的物件。
                    注意:屬性的檢視順序,不要直接ctrl+滑鼠左鍵,上面這個方法我就是直接ctrl+左鍵點進去的,雖然最後還是執行的這個方法,但是這是
                         誤打誤撞,在generics這個模組裡,就有get_object_or_404方法。所以先去generics這個模組裡get_object_or_404,再去
                         上面的get_object_or_404方法。。。
                         
            分析5: self.check_object_permissions(self.request, obj)
                   上面這行程式碼其實很熟悉,這個和之前進行使用者許可權認證差不多一樣,不一樣的是對誰進行許可權認證,一個是使用者,一個是一條記錄(資料
                   庫),也就是這裡的obj。
                   
                    permission就是一個進行許可權認證的物件,那麼該物件必須要有has_object_permission方法,進行一系列判斷,許可權許可的話,
                    就返回True,不許可的話,返回False。光這麼說,也不知道用在哪個地方,我想了個例子:首先obj就是我們從資料庫拿到的資料
                    (物件),其實資料也分等級,也有不同許可權的資料,我們可以再根據判斷,再進行資料的返回。
                    提醒:這裡我們是繼承了GenericAPIView,它裡面的get_object裡做的許可權認證,我們不繼承GenericAPIView,也一樣可以去
                         呼叫這個方法。但check_object_permissions方法是rest_framework提供的。
        
            對於get_object方法的分析差不多了,再講上面的分析3,self.kwargs哪裡來的。
            我們回到APIView中的dispatch方法就知道了
 generics這個模組裡還有其他類,可以去看看,很簡單就是類的繼承問題。
好了,這塊就寫到這裡了