开放平台的API接口调用须要限制其频率,以节约服务器资源和避免恶意的频繁调用python
自定义频率限制组件: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.pydjango
class TestThrottle(APIView): throttle_classes = [MyThrottle, ] def get(self, request, *args, **kwargs): pass
一样,须要配置setttings文件api
REST_FRAMEWORK = { "DEFAULT_PERMISSION_CLASSES": [] # 默认的权限类 }
DRF提供了四种频率控制组件:
缓存
SimpleRateThrottle AnonRateThrottle UserRateThrottle ScopedRateThrottle
以SimpleRateThrottle为例:服务器
settings.pyide
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.pyspa
class TestThrottle(APIView):<br> # 这样设置后,节流功能就会使用VisitThrottle类,而不会使用UserThrottle类 throttle_classes = [VisitThrottle,] def get(self, request, *args, **kwargs):
这里使用的节流类是继承了SimplePateThrottle类,而这个类利用了django内置的缓存来存储访问记录。经过全局节流设置,全部的视图类默认是使用UserThrottle类进行节流,若是不想使用默认的类就自定义给throttle_classes属性变量赋值,如:“throttle_classes = [VisitThrottle,]”。3d
由内置接口代码基本结构中能够看到,视图类TestThrottle继承了SimpleRateThrottle类,跳转到这个类中,就能够看到scope属性变量。
由“THROTTLE_RATES[self.scope]”知,scope必定是一个key值,而THROTTLE_RATES不就是在配置文件中所设置的变量吗?因此说scope表明的就是“未认证用户”和“已认证用户”这两个key值,而这两个key值表明的就是不一样的节流方案。返回值就这这两个key值所对应的value值,具体是哪个,那就看视图类TestTrottle中对scope属性变量的值是什么了,若是这个scope值不存在,就会抛出异常。
在分析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中重写的方法。由上图可知,该方法是必须重写的,否则就会抛出异常。
经过查看dispatch方法中的intial方法能够看到调用的节流方法“check_throttles”。
这个for循环返回的必定是一个列表,相似于认证和受权的源码,那么这个列表必定是保存节流类的列表。
get_throttles方法返回的是一个列表生成式,而这里的throttle_classes就是在视图类TestThrottle中使用的,该变量就保存节流类对象。
经过throttle_classes属性变量,跳转到该图,能够看到配置文件中说的“DEFAULT_THROTTLE_CLASSES”,它是用来经过配置文件settings来对全局节流类进行配置,功能等价于throttle_classes属性变量
由SimpleRateThrottle类和上文对scope属性变量的分析可知,THROTTLE_RATES就是为了存储在配置文件中设置的不一样的节流方法的。
综上所述,能够看出,在利用内置节流接口时,经过配置文件settings的设置和提供该接口所需的用户惟一标识外,不须要咱们作再多的操做,这就造成了咱们上文写的内置接口代码基本结构的样式。