频率组件

一、频率简介

为了控制用户对某个url请求的频率，比如，一分钟以内，只能访问三次

 

二、自定义频率类（了解）：

from rest_framework.throttling import BaseThrottle
class MyThrottle(BaseThrottle):
    VISIT_RECORD = {}
    def __init__(self):
        self.history=None
    def allow_request(self,request,view):
        # 自定义控制每分钟访问多少次，运行访问返回true，不允许访问返回false

        （1）取出访问者ip{ip1:[第二次访问时间，第一次访问时间],ip2:[]}
        （2）判断当前ip不在访问字典里，如果不在添加进去，并且直接返回True,表示第一次访问，在字典里，继续往下走
        （3）循环判断当前ip的列表，有值，并且当前时间减去列表的最后一个时间大于60s，把这种数据pop掉，这样列表中只有60s以内的访问时间，
        （4）判断，当列表小于3，说明一分钟以内访问不足三次，把当前时间插入到列表第一个位置，返回True，顺利通过
        （5）当大于等于3，说明一分钟内访问超过三次，返回False验证失败

        # （1）取出访问者ip
        ip = request.META.get('REMOTE_ADDR')
        import time
        #拿到当前时间
        ctime = time.time()
        # （2）判断当前ip不在访问字典里，添加进去，并且直接返回True,表示第一次访问
        if ip not in self.VISIT_RECORD:
            self.VISIT_RECORD[ip] = [ctime, ]
            return True
        #是个当前访问者ip对应的时间列表 [第一次访问的时间，]
        self.history = self.VISIT_RECORD.get(ip)
        # （3）循环判断当前ip的列表，有值，并且当前时间减去列表的最后一个时间大于60s，把这种数据pop掉，这样列表中只有60s以内的访问时间，
        while self.history and ctime - self.history[-1] > 60:
            self.history.pop()
        # （4）判断，当列表小于3，说明一分钟以内访问不足三次，把当前时间插入到列表第一个位置，返回True，顺利通过
        # （5）当大于等于3，说明一分钟内访问超过三次，返回False验证失败
        if len(self.history) < 3:
            self.history.insert(0, ctime)
            return True
        else:
            return False

    def wait(self):
        import time
        ctime = time.time()
        return 60 - (ctime - self.history[-1])

class Books(APIView):
    throttle_classes=[MyThrottle,]
    def get(self,request):
        return Response('')

自定义频率类限制了访问次数，所以我们使用内置的频率类

 

三、频率组件的使用

1、第一步：新建py文件写一个频率类，继承SimpleRateThrottle，重写get_cache_key，返回self.get_ident(request)，注意一定要记住在里面配置一个：scop='字符串'

from rest_framework.throttling import SimpleRateThrottle

# 频率类
class Throttle(SimpleRateThrottle):
    scope = 'jerry'

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

2、第二步：在setting中配置以下参数

REST_FRAMEWORK = {
    'DEFAULT_THROTTLE_RATES': {'jerry': '3/minute'}  # 一分钟访问三次
}

3、视图函数中使用频率类

from rest_framework.views import APIView
from rest_framework.response import Response
from app01.myth import Throttle

class Books(APIView):
    throttle_classes = [Throttle, ]

    def get(self, request):
        return Response()

urls.py

url(r'^books/', views.Books.as_view()),

效果演示

 

局部使用

全局使用

在settings里配置：

REST_FRAMEWORK = {'DEFAULT_AUTHENTICATION_CLASSES': ['自己定义的频率类'，]}

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': ['app01.myth.Throttle', ]
}

局部禁用

 

源码分析：

执行的是APIView中的dispatch里面的方法

去列表里拿数据找allow_request, 而且传了一个参数，如果不符合，执行self.throttled(request, throttle.wait())
如果符合直接返回，所以我们应该自己写一个类，实现allow_request方法，成功返回True，不成功返回False，这就是需要我们自定义频率类，上面有介绍

 

SimpleRateThrottle源码分析：

点进去看一下它的allow_request

self.key是访问者的ip，放在了缓存中

从缓存中通过key也就是ip拿到了访问者的时间列表，self.history是当前访问者ip对应的时间列表[第一次访问的时间，]，self.now是当前时间

继续下翻，到了操作次数

self.history是一个列表，里面是一个个访问时间，利用len统计次数，如果访问次数大于固定次数，执行failure，否则执行success，那么我们分别点开看一下它们是什么

可以看到：执行failure返回的是False，

执行success，也就是访问次数小于固定次数，返回的是True，注意succcess返回Ture之前，把当前时间插进去，然后再把数据存到缓存中

有了这个方法之后，所以就不需要我们自定义频率类重写allow_request方法了，只需要重写获取ip方法get_cache_key(self, request, view)，返回当前访问者的ip。

完了之后还需要分析：scope为什么要定义在频率类中？

点进源码再分析一下

然后点进rate看一下里面执行了什么

用反射getattr去获取rate的值，没有值就执行self.get_rate()，点进去看一下

这里通过反射到类里面判断scope存不存在，没有直接抛出异常，有就返回self.THROTTLE_RATES[self.scope]

self.scope是频率类定义scope的值

然后再点进THROTTLE_RATES中，这个就是我们在settings里设置的

key值jerry赋给了self.scope，3/minute赋给了self.rate

再点进parse_rate中

parse_rate中执行了哪些操作呢？首先通过字符串的切分把3赋给了num，把minute赋给了period，然后把num的字符串3转成数字3赋给num_requests，然后将period索引取值取第一个字母m作为key取出所对应的的value值为60，这里面不仅可以识别分钟，还可以识别秒，时，天，所以在settings里可以设置s/h/d（单词首字母也可以全称）

最后返回了num_requests的值为3,duration的值为60，那么让我们看一下这两个值被谁接收了

到了这里我们已经清楚了为什么访问三次以后就必须等60秒过了之后才能再次一分钟访问三次