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
  • 移動開發(一):使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說,近來想嘗試開發一款安卓APP,考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP,畢竟是使用Visual Studio開發工具,使用起來也比較的順手,結合微軟官方的教程進行了安卓 ...
  • 前言 QuestPDF 是一個開源 .NET 庫,用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫,它徹底改變了我們生成 PDF 文檔的方 ...
  • 項目地址 項目後端地址: https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址: ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址: http://tree ...
  • 話不多說,直接開乾 一.下載 1.官方鏈接下載: https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe,運行開始下載SQL server; 二. ...
  • 前言 隨著物聯網(IoT)技術的迅猛發展,MQTT(消息隊列遙測傳輸)協議憑藉其輕量級和高效性,已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫,為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog支持多種接收器用於日誌存儲,增強器用於添加屬性,LogContext管理動態屬性,支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項,適用於不同需求。 ...
  • 目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據,爬取信息時需要模擬瀏覽器行為,否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下: 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • 1.前言 什麼是熱更新 游戲或者軟體更新時,無需重新下載客戶端進行安裝,而是在應用程式啟動的情況下,在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR,Xlua,ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles,Addressable, ...
  • 本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺,其實像阿裡雲,騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後,它會送 ...
  • 通過以下方式可以高效,並保證數據同步的可靠性 1.API設計 使用RESTful設計,確保API端點明確,並使用適當的HTTP方法(如POST用於創建,PUT用於更新)。 設計清晰的請求和響應模型,以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證,確保接收到的數據符合預期格 ...