Django Rest Framework之用戶頻率/訪問次數限制

內置接口代碼基本結構

　　settings.py:

REST_FRAMEWORK = {
    'DEFAULT_THROTTLE_CLASSES':['api.utils.mythrottle.UserThrottle',]
    'DEFAULT_THROTTLE_RATES': {
        '未認證用戶': '10/m',
        '已認證用戶': '100/h',
    },
}

　　mythrottle.py:

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import exceptions
from rest_framework.throttling import SimpleRateThrottle


class VisitThrottle(SimpleRateThrottle):
    scope = "未認證用戶"

    def get_cache_key(self, request, view):
        return  self.get_ident(request)
      

class UserThrottle(SimpleRateThrottle):
    scope = "已認證用戶"

    def get_cache_key(self, request, view):
        return  request.user  # 認證經過後，認證方法authenticate的返回值之一

class TestThrottle(APIView):
　　# 這樣設置後，節流功能就會使用VisitThrottle類，而不會使用UserThrottle類
    throttle_classes = [VisitThrottle,] 
    
    def get(self, request, *args, **kwargs):
        pass
        '''
        等等一系列的視圖功能方法
        '''

 　　這裏使用的節流類是繼承了SimplePateThrottle類，而這個類利用了django內置的緩存來存儲訪問記錄。經過全局節流設置，全部的視圖類默認是使用UserThrottle類進行節流，若是不想使用默認的類就自定義給throttle_classes屬性變量賦值，如：「throttle_classes = [VisitThrottle,]」。

原理分析

　　自定義節流方法：

　　views.py:

from rest_framework.views import APIView
import time


# 存儲各個用戶的訪問記錄
VISIT_RECORD = {
    '192.168.3.112': ['1212121212','1334352525',]
}

class VisitThrottle(object):
    '''60s內只能訪問3次'''
    def allow_request(self,request,view):
        # 獲取用戶IP
        remote_addr = request.META.get('REMOTE_ADDR')
        # 獲取當前訪問時間
        ctime = time.time()
        # 判斷該IP用戶以前是否訪問過，沒有訪問過，則加入到VISIT_RECORD全局變量中
        if remote_addr not in VISIT_RECORD:
            VISIT_RECORD[remote_addr] = [ctime,]
            return True
        # 獲取該IP用戶的訪問記錄
        history = VISIT_RECORD.get(remote_addr)
        self.history = history
        # 刪除失效的訪問記錄
        while history and history[-1] < ctime - 60:
            history.pop()
        # 判斷有效的訪問記錄是否大於要求的最大次數
        if len(history) < 3:
            history.insert(0,ctime)
            return True
        return False
        # return True: 表示能夠繼續訪問
        # return False  表示訪問頻率過高，被限制
        
        
    def wait(self):
        '''
        還須要等多長時間才能訪問
        :return
        '''
        ctime = time.time()
        ruturn 60 - (ctime - self.history[-1])


class TestThrottle(APIView):
    throttle_classes = [VisitThrottle,]
    
    def get(self, request, *args, **kwargs):
        pass
        '''
        等等一系列的視圖功能方法
        '''

• 上面代碼中的VisitThrottle類就是自定義節流類，跟認證原理相似，在源碼中能找到throttle_classes屬性變量，一樣將自定義的節流類添加到這個列表中。
• 用戶訪問記錄的數據結構就是VISIT_RECODE全局變量，該變量就是一個字典，key值爲用戶惟一標識（IP或用戶名），value值爲列表，列表元素爲訪問時間戳。
• 節流原理：簡單的說，就是從VISIT_RECODE全局變量中獲取到某個用戶的惟一標識（不存在，則不節流），而後計算獲取到的當前訪問時間與訪問有效時間段（這裏爲60s）的差值（其實也是一個時間戳），利用這個差值來pop出這個列表中小於該差值的時間戳（說白了就是，刪除已通過時的時間戳），最後在，判斷一下列表中剩餘的時間戳是否超過了限定的次數，沒有超過，則容許訪問，超過，則拒絕訪問。
• 當拒絕時，會調用wait方法，來返回還剩多少時間就能夠再次訪問。
• 之因此在項目開發中不使用自定義節流類，是由於drf中已經實現了節流方法。內置接口代碼基本結構，就是內置節流類的使用方法。

源碼分析

• 爲何會使用「scope」屬性變量，它有什麼用？

　　

　　由內置接口代碼基本結構中能夠看到，視圖類TestThrottle繼承了SimpleRateThrottle類，跳轉到這個類中，就能夠看到scope屬性變量。

　　 

　　

　　 由「THROTTLE_RATES[self.scope]」知，scope必定是一個key值，而THROTTLE_RATES不就是在配置文件中所設置的變量嗎？因此說scope表明的就是「未認證用戶」和「已認證用戶」這兩個key值，而這兩個key值表明的就是不一樣的節流方案。返回值就這這兩個key值所對應的value值，具體是哪個，那就看視圖類TestTrottle中對scope屬性變量的值是什麼了，若是這個scope值不存在，就會拋出異常。

• 爲何會使用「get_cache_key」方法，該方法的返回值是什麼？
  

　　在分析get_cache_key方法前，先分析一下SimpleRateThrottle類： 

　　

　　cache = default_cache 它表示的就是存儲用戶訪問記錄的緩存，而這個緩存正是django默認的緩存。

　　get_rate 方法，前面已經說過了，是用來獲取節流方式的。　　

　　

　　parse_rate方法，解析節流方式

　　

　　allow_request方法，就是跟在自定義節流方法同樣，是實現節流算法的。之因此會用內置節流方法，就是由於在這裏，已經實現了節流算法。

 　　

　　wait方法，就是跟在自定義節流類中的wait方法同樣，返回提示用戶還有多長時間就能夠再次訪問了。

　　

　　經過初始化方法，獲取並解析好要使用的節流方式，供allow_request方法使用。

　　

　　經過調用check_throttles方法，來調用allow_request方法，由上面關於allow_request截圖來看，要完成它的功能，就必須經過get_cache_key方法獲取到當前用戶的惟一標識，因此get_cache_key應該返回惟一標識。

　　

　　get_cache_key 方法，這就是在視圖類TestThrottle中重寫的方法。由上圖可知，該方法是必須重寫的，否則就會拋出異常。

• 爲何會使用「throttle_classes」屬性變量，它有什麼用？

　　

　　經過查看dispatch方法中的intial方法能夠看到調用的節流方法「check_throttles」。

　　

　　這個for循環返回的必定是一個列表，相似於認證和受權的源碼，那麼這個列表必定是保存節流類的列表。

　　

　　get_throttles方法返回的是一個列表生成式，而這裏的throttle_classes就是在視圖類TestThrottle中使用的，該變量就保存節流類對象。　　

• 「DEFAULT_THROTTLE_CLASSES」從哪裏來，有什麼用？

　　 

　　經過throttle_classes屬性變量，跳轉到該圖，能夠看到配置文件中說的「DEFAULT_THROTTLE_CLASSES」，它是用來經過配置文件settings來對全局節流類進行配置，功能等價於throttle_classes屬性變量。

• 「DEFAULT_THROTTLE_RATES」從哪裏來，有什麼用？

　　

　　由SimpleRateThrottle類和上文對scope屬性變量的分析可知，THROTTLE_RATES就是爲了存儲在配置文件中設置的不一樣的節流方法的。

 　　

　　綜上所述，能夠看出，在利用內置節流接口時，經過配置文件settings的設置和提供該接口所需的用戶惟一標識外，不須要咱們作再多的操做，這就造成了咱們上文寫的內置接口代碼基本結構的樣式。