Django REST Framework之频率限制的使用


Posted in Python onSeptember 29, 2019

开放平台的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文件

EST_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”属性变量,它有什么用?

Django REST Framework之频率限制的使用

由内置接口代码基本结构中可以看到,视图类TestThrottle继承了SimpleRateThrottle类,跳转到这个类中,就可以看到scope属性变量。

Django REST Framework之频率限制的使用

Django REST Framework之频率限制的使用

由“THROTTLE_RATES[self.scope]”知,scope一定是一个key值,而THROTTLE_RATES不就是在配置文件中所设置的变量吗?所以说scope代表的就是“未认证用户”和“已认证用户”这两个key值,而这两个key值代表的就是不同的节流方案。返回值就这这两个key值所对应的value值,具体是哪一个,那就看视图类TestTrottle中对scope属性变量的值是什么了,如果这个scope值不存在,就会抛出异常。

2.为什么会使用“get_cache_key”方法?该方法的返回值是什么?

在分析get_cache_key方法前,先分析一下SimpleRateThrottle类:

Django REST Framework之频率限制的使用

cache = default_cache 它表示的就是存储用户访问记录的缓存,而这个缓存正是django默认的缓存。

get_rate 方法,前面已经说过了,是用来获取节流方式的。

Django REST Framework之频率限制的使用

parse_rate方法,解析节流方式

Django REST Framework之频率限制的使用

allow_request方法,就是跟在自定义节流方法一样,是实现节流算法的。之所以会用内置节流方法,就是因为在这里,已经实现了节流算法。

Django REST Framework之频率限制的使用

wait方法,就是跟在自定义节流类中的wait方法一样,返回提示用户还有多长时间就可以再次访问了。

Django REST Framework之频率限制的使用

通过初始化方法,获取并解析好要使用的节流方式,供allow_request方法使用。

Django REST Framework之频率限制的使用

通过调用check_throttles方法,来调用allow_request方法,由上面关于allow_request截图来看,要完成它的功能,就必须通过get_cache_key方法获取到当前用户的唯一标识,所以get_cache_key应该返回唯一标识。

Django REST Framework之频率限制的使用

get_cache_key 方法,这就是在视图类TestThrottle中重写的方法。由上图可知,该方法是必须重写的,不然就会抛出异常。

3.为什么会使用“throttle_classes”属性变量,它有什么用?

Django REST Framework之频率限制的使用

通过查看dispatch方法中的intial方法可以看到调用的节流方法“check_throttles”。

Django REST Framework之频率限制的使用

这个for循环返回的一定是一个列表,类似于认证和授权的源码,那么这个列表一定是保存节流类的列表。

Django REST Framework之频率限制的使用

get_throttles方法返回的是一个列表生成式,而这里的throttle_classes就是在视图类TestThrottle中使用的,该变量就保存节流类对象。

4.“DEAFULT_THROTTLE_CLASSES”从哪里来?有什么用?

Django REST Framework之频率限制的使用

通过throttle_classes属性变量,跳转到该图,可以看到配置文件中说的“DEFAULT_THROTTLE_CLASSES”,它是用来通过配置文件settings来对全局节流类进行配置,功能等价于throttle_classes属性变量

5.“DEAFULT_THROTTLE_RATES”从哪里来?有什么用?

Django REST Framework之频率限制的使用

由SimpleRateThrottle类和上文对scope属性变量的分析可知,THROTTLE_RATES就是为了存储在配置文件中设置的不同的节流方法的。

综上所述,可以看出,在利用内置节流接口时,通过配置文件settings的设置和提供该接口所需的用户唯一标识外,不需要我们做再多的操作,这就形成了我们上文写的内置接口代码基本结构的样式。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
Django的URLconf中使用缺省视图参数的方法
Jul 18 Python
Python实现Linux命令xxd -i功能
Mar 06 Python
Flask框架中密码的加盐哈希加密和验证功能的用法详解
Jun 07 Python
实例讲解Python中global语句下全局变量的值的修改
Jun 16 Python
使用Python对SQLite数据库操作
Apr 06 Python
python直接获取API传递回来的参数方法
Dec 17 Python
python 利用文件锁单例执行脚本的方法
Feb 19 Python
30秒学会30个超实用Python代码片段【收藏版】
Oct 15 Python
python自动化测试之异常及日志操作实例分析
Nov 09 Python
PyTorch 普通卷积和空洞卷积实例
Jan 07 Python
PyCharm配置KBEngine快速处理代码提示冲突、配置命令问题
Apr 03 Python
Python爬虫 简单介绍一下Xpath及使用
Apr 26 Python
基于Python实现大文件分割和命名脚本过程解析
Sep 29 #Python
Python2比较当前图片跟图库哪个图片相似的方法示例
Sep 28 #Python
python使用opencv实现马赛克效果示例
Sep 28 #Python
python打包成so文件过程解析
Sep 28 #Python
python基于FTP实现文件传输相关功能代码实例
Sep 28 #Python
python网络爬虫 Scrapy中selenium用法详解
Sep 28 #Python
在vscode中配置python环境过程解析
Sep 28 #Python
You might like
PHP中文URL编解码(urlencode()rawurlencode()
2010/07/03 PHP
php读取qqwry.dat ip地址定位文件的类实例代码
2016/11/15 PHP
Laravel框架路由管理简单示例
2019/05/07 PHP
捕获关闭窗口的脚本
2009/01/10 Javascript
基于jquery的一个图片hover的插件
2010/04/24 Javascript
JavaScript获取网页中第一个图片id的方法
2015/04/03 Javascript
js禁止页面刷新与后退的方法
2015/06/08 Javascript
jquery获取当前元素索引值用法实例
2015/06/10 Javascript
javascript删除数组重复元素的方法汇总
2015/06/24 Javascript
JavaScritp添加url参数并将参数加入到url中及更改url参数的方法
2015/10/26 Javascript
js中获取 table节点各tr及td的内容简单实例
2016/10/14 Javascript
js HTML5多媒体影音播放
2016/10/17 Javascript
jQuery实现搜索页面关键字的功能
2017/02/16 Javascript
Vue 表单控件绑定的实现示例
2017/08/11 Javascript
基于vue配置axios的方法步骤
2017/11/09 Javascript
基于$.ajax()方法从服务器获取json数据的几种方式总结
2018/01/31 Javascript
Vue中&quot;This dependency was not found&quot;问题的解决方法
2018/06/19 Javascript
layui中使用jquery控制radio选中事件的示例代码
2018/08/15 jQuery
详解webpack引用jquery(第三方模块)的三种办法
2019/08/21 jQuery
python学习笔记:字典的使用示例详解
2014/06/13 Python
Python3.6笔记之将程序运行结果输出到文件的方法
2018/04/22 Python
python中验证码连通域分割的方法详解
2018/06/04 Python
python实现汉诺塔算法
2021/03/01 Python
Django后端接收嵌套Json数据及解析详解
2019/07/17 Python
python 实现list或string按指定分段
2019/12/25 Python
Django实现前台上传并显示图片功能
2020/05/29 Python
Python xmltodict模块安装及代码实例
2020/10/05 Python
Lululemon英国官网:加拿大瑜伽服装品牌
2019/01/14 全球购物
门卫工作岗位职责
2013/12/17 职场文书
2015年医院创卫工作总结
2015/04/22 职场文书
大学毕业谢师宴致辞
2015/07/27 职场文书
公司年会晚会开幕词
2019/04/02 职场文书
检讨书范文
2019/04/16 职场文书
Mysql中 unique列插入重复值该怎么解决呢
2021/05/26 MySQL
html+css实现环绕倒影加载特效
2021/07/07 HTML / CSS
HTML中的表格元素介绍
2022/02/28 HTML / CSS