快捷導(dǎo)航

Django REST Framework之頻率限制的使用

更新時(shí)間：2019年09月29日 08:26:59 作者：學(xué)霸初養(yǎng)成

這篇文章主要介紹了Django REST Framework之頻率限制的使用，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

開放平臺(tái)的API接口調(diào)用需要限制其頻率，以節(jié)約服務(wù)器資源和避免惡意的頻繁調(diào)用

使用

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

class MyThrottle(BaseThrottle):
 
  def __init__(self):
    self.history = None
 
  def allow_request(self, request, view):
    # 實(shí)現(xiàn)限流的邏輯
    # 以IP限流
    # 訪問列表 {IP: [time1, time2, time3]}
    # 1, 獲取請(qǐng)求的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 在 需要把這個(gè)IP的訪問記錄 把當(dāng)前時(shí)間加入到列表
    history = VISIT_RECORD[ip]
    history.insert(0, now)
    # 3， 確保列表里最新訪問時(shí)間以及最老的訪問時(shí)間差 是1分鐘
    while history and history[0] - history[-1] > 60:
      history.pop()
    self.history = history
    # 4，得到列表長(zhǎng)度，判斷是否是允許的次數(shù)
    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() 方法內(nèi)定義頻率控制的實(shí)現(xiàn)
wait() 方法的返回值代表了距離下次允許訪問還剩多久，單位：秒

全局使用

同樣，需要配置setttings文件

EST_FRAMEWORK = {
  "DEFAULT_PERMISSION_CLASSES": [] # 默認(rèn)的權(quán)限類
}

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

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

SimpleRateThrottle
AnonRateThrottle
UserRateThrottle
ScopedRateThrottle

以SimpleRateThrottle為例：

settings.py

REST_FRAMEWORK = {
  'DEFAULT_THROTTLE_CLASSES':['api.utils.mythrottle.UserThrottle',]
  'DEFAULT_THROTTLE_RATES': {
    '未認(rèn)證用戶': '10/m',
    '已認(rèn)證用戶': '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 = "未認(rèn)證用戶"
 
  def get_cache_key(self, request, view):
    return self.get_ident(request)
    
 
class UserThrottle(SimpleRateThrottle):
  scope = "已認(rèn)證用戶"
 
  def get_cache_key(self, request, view):
    return request.user # 認(rèn)證通過后，認(rèn)證方法authenticate的返回值之一

views.py

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

這里使用的節(jié)流類是繼承了SimplePateThrottle類，而這個(gè)類利用了django內(nèi)置的緩存來存儲(chǔ)訪問記錄。通過全局節(jié)流設(shè)置，所有的視圖類默認(rèn)是使用UserThrottle類進(jìn)行節(jié)流，如果不想使用默認(rèn)的類就自定義給throttle_classes屬性變量賦值，如：“throttle_classes = [VisitThrottle,]”。

源碼分析

1.為什么會(huì)使用“scope”屬性變量，它有什么用？

由內(nèi)置接口代碼基本結(jié)構(gòu)中可以看到，視圖類TestThrottle繼承了SimpleRateThrottle類，跳轉(zhuǎn)到這個(gè)類中，就可以看到scope屬性變量。

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

2.為什么會(huì)使用“get_cache_key”方法？該方法的返回值是什么？

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

cache = default_cache 它表示的就是存儲(chǔ)用戶訪問記錄的緩存，而這個(gè)緩存正是django默認(rèn)的緩存。

get_rate 方法，前面已經(jīng)說過了，是用來獲取節(jié)流方式的。

parse_rate方法，解析節(jié)流方式

allow_request方法，就是跟在自定義節(jié)流方法一樣，是實(shí)現(xiàn)節(jié)流算法的。之所以會(huì)用內(nèi)置節(jié)流方法，就是因?yàn)樵谶@里，已經(jīng)實(shí)現(xiàn)了節(jié)流算法。

wait方法，就是跟在自定義節(jié)流類中的wait方法一樣，返回提示用戶還有多長(zhǎng)時(shí)間就可以再次訪問了。

通過初始化方法，獲取并解析好要使用的節(jié)流方式，供allow_request方法使用。

通過調(diào)用check_throttles方法，來調(diào)用allow_request方法，由上面關(guān)于allow_request截圖來看，要完成它的功能，就必須通過get_cache_key方法獲取到當(dāng)前用戶的唯一標(biāo)識(shí)，所以get_cache_key應(yīng)該返回唯一標(biāo)識(shí)。