內置接口代碼基本結構
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的設置和提供該接口所需的用戶唯一標識外,不需要我們做再多的操作,這就形成了我們上文寫的內置接口代碼基本結構的樣式。