Django Rest Framework之認證

来源:https://www.cnblogs.com/cjaaron/archive/2019/02/25/10433325.html
-Advertisement-
Play Games

代碼基本結構 url.py: views.py: 說明: 1)在authenticate方法的返回值是一個元組,元組中第一個元素是用戶名,第二個元素是認證數據token。這個返回值會在我們的視圖類中通 過request.user 和 request.auth獲取到。具體為什麼是這兩個值,會在後面的源 ...


代碼基本結構

  url.py:

from django.conf.urls import url, include
from web.views.s1_api import TestView
 
urlpatterns = [
    url(r'^test/', TestView.as_view()),
]

   views.py:

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.authentication import BaseAuthentication
from rest_framework.request import Request
from rest_framework import exceptions


class TestAuthentication(BaseAuthentication):
    def authenticate(self, request):
    '''
    認證代碼編寫區域
    '''
    return (用戶,用戶Token)

    def authenticate_header(self, request):
        # 驗證失敗時,返回的響應頭WWW-Authenticate對應的值
        pass  


class TestView(APIView):
    authentication_classes = [TestAuthentication, ]  

    def get(self, request, *args, **kwargs):
        pass

    
     def post(self, request, *args, **kwargs):
        pass

        '''
        等等一系列的視圖功能方法
        '''

   說明:

    1)在authenticate方法的返回值是一個元組,元組中第一個元素是用戶名,第二個元素是認證數據token。這個返回值會在我們的視圖類中通       過request.user 和 request.auth獲取到。具體為什麼是這兩個值,會在後面的源碼分析中說明。

    2)認證的返回值有三種情況:

      返回元組(如(1)中所述):認證成功

      返回None:處理下一個認證類

      拋出異常:認證失敗

    3)上面的基本結構是做局部的類的認證方式,如果相對絕大多數的類做認證,那麼可以通過全局認證的方式實現。該方法在下文中介紹。

    4)authentication_classes 屬性變數是一個列表,列表元素是類,一般情況只使用一個認證類。     

源碼分析

  1) 為什麼要使用authentication_classes 屬性變數?

  

   python 的面向對象編程中,我們首先要執行的方法肯定是dispatch方法,所以我們的分析入口就是dispatch方法,在dispatch方法中,可以看到,通過initialize_request方法將django原生的request進行了一次封裝。由initialize_request方法的實現過程可以看出,將其封裝實例化成了一個Request對象。而authenticators屬性就是認證屬性。

 

   

  通過查看get_authenticators方法,可以知道,它的返回值是一個列表生成式,而這個列表生成式中所用的就是我們在認證類中賦值authenticatin_classes屬性變數。在查找該變數的定義位置,就看到了它是通過settings配置文件來實現賦值的,除非,在子類中將其賦值。我們的代碼就是這樣做的。同時,也可以看出,我們可以修改settings配置文件來為全局定義認證規則。

2)為什麼要認證類中要使用authenticate方法?

   

   

  回到前面說是的dispatch方法來,在做完了對django原生的request的封裝和實例化後,緊接著就會開始認證(try...中,捕獲異常,如果沒有捕獲到異常,說明認證成功,就會繼續執行下麵的反射過程)。認證的過程就包含在上圖中的inital方法中,有圖可知,是通過perform_authentication方法實現的認證。

   

   

  在perform_authentication方法中可以看到,只調用了一個request.user,而這個user一定是方法,不會是屬性變數,因為如果是屬性變數,那麼就一定有語法錯誤,變數一定是要賦值的,不可能孤零零的寫到那裡。我們在源碼中找到它,就明白了,之所以它能這麼寫,就是因為有了property裝飾器。在user方法中找到_authenticate方法,這就是認證的方法。

 

   在這個方法中,一切答案都就找到了。首先看authenticators,是不是很眼熟,沒錯它就是前面說的,封裝和實例化原生request的Request類中所定義的屬性變數。在實例化時,我們就將authentication_classes列表的值通過get_authenticators方法中的列表生成式賦值給了authenticators。再往下看,authenticator.autheneicate(self)中的authenticator是不是就是我們自己定義的認證類,而它在源碼中要做“.authenticate(self)”的操作,那自然而然,我們定義的認證類中要實現這個方法了。

  3)為什麼認證成功後的返回值在request.user和request.auth中?

  由 2)中最後一個圖可知,當我們認證成功後會執行“self.user, self.auth = user_auth_tuple”代碼,我們在認證類定義的方法authenticate的返回值就保存在 user_auth_tuple中,所以我們通過request.user 和 request.auth 就可以獲取到了。

實例

from django.conf.urls import url, include
from web.viewsimport TestView

urlpatterns = [
    url(r'^test/', TestView.as_view()),
]
urls.py
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework.authentication import BaseAuthentication
from rest_framework.request import Request
from rest_framework import exceptions

token_list = [
    'sfsfss123kuf3j123',
    'asijnfowerkkf9812',
]


class TestAuthentication(BaseAuthentication):
    def authenticate(self, request):
        """
        用戶認證,如果驗證成功後返回元組: (用戶,用戶Token)
        :param request: 
        :return: 
            None,表示跳過該驗證;
                如果跳過了所有認證,預設用戶和Token和使用配置文件進行設置
                self._authenticator = None
                if api_settings.UNAUTHENTICATED_USER:
                    self.user = api_settings.UNAUTHENTICATED_USER()
                else:
                    self.user = None
        
                if api_settings.UNAUTHENTICATED_TOKEN:
                    self.auth = api_settings.UNAUTHENTICATED_TOKEN()
                else:
                    self.auth = None
            (user,token)表示驗證通過並設置用戶名和Token;
            AuthenticationFailed異常
        """
        val = request.query_params.get('token')
        if val not in token_list:
            raise exceptions.AuthenticationFailed("用戶認證失敗")

        return ('登錄用戶', '用戶token')

    def authenticate_header(self, request):
        """
        Return a string to be used as the value of the `WWW-Authenticate`
        header in a `401 Unauthenticated` response, or `None` if the
        authentication scheme should return `403 Permission Denied` responses.
        """
        # 驗證失敗時,返回的響應頭WWW-Authenticate對應的值
        pass


class TestView(APIView):
    authentication_classes = [TestAuthentication, ]
    permission_classes = []

    def get(self, request, *args, **kwargs):
        print(request.user)
        print(request.auth)
        return Response('GET請求,響應內容')

    def post(self, request, *args, **kwargs):
        return Response('POST請求,響應內容')

    def put(self, request, *args, **kwargs):
        return Response('PUT請求,響應內容')
Views.py

擴展:全局認證

  如果要進行全局配置,由上面的源碼分析可知,我們只需要在配置文件中配置我們存儲到authentication_classes的值即可。但還要註意的是,在寫配置文件時,要使用的是路徑,所以最好在和views.py同級目錄下新建一個文件夾(我習慣叫utils),再在該文件夾下新建一個認證文件(auth.py),將我們的認證類都寫到這裡。

REST_FRAMEWORK = {
    "DEFAULT_AUTHENTICATION_CLASSES" :['api.utils.auth',]     
}

 註意:如果有部分類不需要認證的話,可以在這裡類中添加“authentication_classes = []”,即可。


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 迭代 通常意義上的迭代是指:重覆執行一系列運算,從前面的量依次推出後面的量的過程,每一次迭代的結果,會作為下一次迭代的初始值。 在c、c++、java等編程語言中的for迴圈語句,就是一個迭代過程,例如: 這種for迴圈語句比較符合迭代的含義,for語句中給定了一個初始輸入 i=0 ,然後開始執行一 ...
  • [TOC] 如何使用yii2的緩存依賴特性 概述 緩存是Yii2的強大特性之一,合理使用緩存技術可以有效地減小伺服器的訪問壓力。Yii2最基本的緩存包括 數據緩存 、 片段緩存 、 頁面緩存 和 HTTP緩存 ,這部分內容在官方文檔中有更加詳細的說明,這裡不再贅述,如有需要可以參考Yii2官方開發文 ...
  • 首先分享這篇文章《ParameterizedType詳解》 https://blog.csdn.net/JustBeauty/article/details/81116144 ParameterizedType就是參數化類型的意思 聲明類型中帶有“<>”的都是參數化類型,比如List<Integer ...
  • 一、HashMap概述; 1.HashMap是一個散列表,它存儲的是鍵值對(key-value)映射; 2.HashMap繼承AbstractMap,實現了Map,Cloneable,Serializable介面; 3.HashMap的實現不是同步的,線程不安全,但是效率高; 4.HashMap允許 ...
  • Java基本數據類型 java的基本數據類型可以分為4類8種 布爾型(boolean):true,false 整數類型:byte、short、int、long 浮點數類型:float、double 字元型:char 定義變數時:long,float類型後面要加上字母 8種數據類型的大小 一個漢字占2 ...
  • pythn print格式化輸出。 %r 用來做 debug 比較好,因為它會顯示變數的原始數據(raw data),而其它的符號則是用來向用戶顯示輸出的。 1. 列印字元串 print ("His name is %s"%("Aviad"))效果: 2.列印整數 print ("He is %d ...
  • [TOC] 一、為什麼要重載賦值運算符 ​ 在前面的內容中講解 "拷貝構造函數調用的時機" 時說明瞭初始化和賦值的區別:在定義的同時進行賦值叫做 ,定義完成以後再賦值(不管在定義的時候有沒有賦值)就叫做 。初始化只能有一次,賦值可以有多次。 ​ 當以拷貝的方式初始化一個對象時,會調用拷貝構造函數;當 ...
  • 今天真的是累哭了,周一課從早八點半一直上到晚九點半,整個人要虛脫的感覺,因為時間不太夠鴨所以就回頭看看找了一些比較有知識點的題來總結總結分析一下,明天有空了就開始繼續打題,嘻嘻嘻。 今日興趣電影: 《超能查派》 這是一部關於未來人工智慧的一個故事,感覺特別有思維開拓性,一個程式員寫出了真正的AI智能 ...
一周排行
    -Advertisement-
    Play Games
  • 前言 本文介紹一款使用 C# 與 WPF 開發的音頻播放器,其界面簡潔大方,操作體驗流暢。該播放器支持多種音頻格式(如 MP4、WMA、OGG、FLAC 等),並具備標記、實時歌詞顯示等功能。 另外,還支持換膚及多語言(中英文)切換。核心音頻處理採用 FFmpeg 組件,獲得了廣泛認可,目前 Git ...
  • OAuth2.0授權驗證-gitee授權碼模式 本文主要介紹如何筆者自己是如何使用gitee提供的OAuth2.0協議完成授權驗證並登錄到自己的系統,完整模式如圖 1、創建應用 打開gitee個人中心->第三方應用->創建應用 創建應用後在我的應用界面,查看已創建應用的Client ID和Clien ...
  • 解決了這個問題:《winForm下,fastReport.net 從.net framework 升級到.net5遇到的錯誤“Operation is not supported on this platform.”》 本文內容轉載自:https://www.fcnsoft.com/Home/Sho ...
  • 國內文章 WPF 從裸 Win 32 的 WM_Pointer 消息獲取觸摸點繪製筆跡 https://www.cnblogs.com/lindexi/p/18390983 本文將告訴大家如何在 WPF 裡面,接收裸 Win 32 的 WM_Pointer 消息,從消息裡面獲取觸摸點信息,使用觸摸點 ...
  • 前言 給大家推薦一個專為新零售快消行業打造了一套高效的進銷存管理系統。 系統不僅具備強大的庫存管理功能,還集成了高性能的輕量級 POS 解決方案,確保頁面載入速度極快,提供良好的用戶體驗。 項目介紹 Dorisoy.POS 是一款基於 .NET 7 和 Angular 4 開發的新零售快消進銷存管理 ...
  • ABP CLI常用的代碼分享 一、確保環境配置正確 安裝.NET CLI: ABP CLI是基於.NET Core或.NET 5/6/7等更高版本構建的,因此首先需要在你的開發環境中安裝.NET CLI。這可以通過訪問Microsoft官網下載並安裝相應版本的.NET SDK來實現。 安裝ABP ...
  • 問題 問題是這樣的:第三方的webapi,需要先調用登陸介面獲取Cookie,訪問其它介面時攜帶Cookie信息。 但使用HttpClient類調用登陸介面,返回的Headers中沒有找到Cookie信息。 分析 首先,使用Postman測試該登陸介面,正常返回Cookie信息,說明是HttpCli ...
  • 國內文章 關於.NET在中國為什麼工資低的分析 https://www.cnblogs.com/thinkingmore/p/18406244 .NET在中國開發者的薪資偏低,主要因市場需求、技術棧選擇和企業文化等因素所致。歷史上,.NET曾因微軟的閉源策略發展受限,儘管後來推出了跨平臺的.NET ...
  • 在WPF開發應用中,動畫不僅可以引起用戶的註意與興趣,而且還使軟體更加便於使用。前面幾篇文章講解了畫筆(Brush),形狀(Shape),幾何圖形(Geometry),變換(Transform)等相關內容,今天繼續講解動畫相關內容和知識點,僅供學習分享使用,如有不足之處,還請指正。 ...
  • 什麼是委托? 委托可以說是把一個方法代入另一個方法執行,相當於指向函數的指針;事件就相當於保存委托的數組; 1.實例化委托的方式: 方式1:通過new創建實例: public delegate void ShowDelegate(); 或者 public delegate string ShowDe ...