Django REST Framework之頻率限制

2019 年 10 月 3 日
筆記

開放平台的API介面調用需要限制其頻率，以節約伺服器資源和避免惡意的頻繁調用

使用

自定義頻率限制組件：utils/thottle.py

class MyThrottle(BaseThrottle):        def __init__(self):          self.history = None        def allow_request(self, request, view):          # 實現限流的邏輯          # 以IP限流          # 訪問列表 {IP: [time1, time2, time3]}          # 1, 獲取請求的IP地址          ip = request.META.get("REMOTE_ADDR")          # 2，判斷IP地址是否在訪問列表          now = time.time()          if ip not in VISIT_RECORD:              # --1， 不在 需要給訪問列表添加key，value              VISIT_RECORD[ip] = [now,]              return True              # --2 在 需要把這個IP的訪問記錄 把當前時間加入到列表          history = VISIT_RECORD[ip]          history.insert(0, now)          # 3， 確保列表裡最新訪問時間以及最老的訪問時間差 是1分鐘          while history and history[0] - history[-1] > 60:              history.pop()          self.history = history          # 4，得到列表長度，判斷是否是允許的次數          if len(history) > 3:              return False          else:              return True        def wait(self):          # 返回需要再等多久才能訪問          time = 60 - (self.history[0] - self.history[-1])          return time

views.py

class TestThrottle(APIView):      throttle_classes = [MyThrottle, ]        def get(self, request, *args, **kwargs):          pass

allow_request() 方法內定義頻率控制的實現
wait() 方法的返回值代表了距離下次允許訪問還剩多久，單位：秒

全局使用

同樣，需要配置setttings文件

REST_FRAMEWORK = {      "DEFAULT_PERMISSION_CLASSES": [] # 默認的許可權類  }

使用REST Framework提供的頻率控制組件

DRF提供了四種頻率控制組件：

SimpleRateThrottle  AnonRateThrottle  UserRateThrottle  ScopedRateThrottle

以SimpleRateThrottle為例：

settings.py

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

utils.thorttle.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的返回值之一

views.py

class TestThrottle(APIView):<br>　　# 這樣設置後，節流功能就會使用VisitThrottle類，而不會使用UserThrottle類      throttle_classes = [VisitThrottle,]        def get(self, request, *args, **kwargs):

這裡使用的節流類是繼承了SimplePateThrottle類，而這個類利用了django內置的快取來存儲訪問記錄。通過全局節流設置，所有的視圖類默認是使用UserThrottle類進行節流，如果不想使用默認的類就自定義給throttle_classes屬性變數賦值，如：“throttle_classes = [VisitThrottle,]”。

源碼分析

1.為什麼會使用“scope”屬性變數，它有什麼用？

由內置介面程式碼基本結構中可以看到，視圖類TestThrottle繼承了SimpleRateThrottle類，跳轉到這個類中，就可以看到scope屬性變數。

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