Download the PHP package vipkwd/webman-throttle without Composer
On this page you can find all versions of the php package vipkwd/webman-throttle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download vipkwd/webman-throttle
More information about vipkwd/webman-throttle
Files in vipkwd/webman-throttle
Package webman-throttle
Short Description webman框架限流中间件
License MIT
Homepage https://www.vipkwd.com
Informations about the package webman-throttle
webman-throttle
A middleware plugins of webman framework
警告/提示
在任何项目中使用任何插件/中间件,当你进行了自定义配置、二开等操作/编辑后,再卸载相关插件/中间件,都有可能丢失数据或导致项目异常的风险。 本中间件为防止前述问题发生,当你执行 composer remove vipkwd/webman-throttle
删除本中间件时,卸载指令将检测相关文件指纹,只有指纹未发生变化(相对于原始库)时才会删除(即:指令不会删除你改动过的文件
作用
通过本中间件可限定用户在一段时间内的访问次数,可用于保护接口防爬防爆破的目的。
安装
composer require vipkwd/webman-throttle
安装后会自动为项目生成 config/throttle.php
配置文件,安装后组件不会自动启用,需要手动设置。
开启
插件以中间件的方式进行工作,因此它的开启与其他中间件一样,例如在全局中间件中使用:
配置说明
当配置项满足以下条件任何一个时,不会限制访问频率:
key === false || key === null || visit_rate === null
其中 key 用来设置缓存键的, 而 visit_rate 用来设置访问频率,单位可以是秒,分,时,天。例如:1/s, 10/m, 98/h, 100/d , 也可以是 100/600 (600 秒内最多 100 次请求)。
场景用例
示例一:针对用户个体做限制,key 的值可以设为函数,该函数返回新的缓存键值(需要 Session 支持),例如:
实例二:在回调函数里针对不同控制器和方法定制生成 key,中间件会进行转换:
示例三:在闭包内修改本次访问频率或临时更换限流策略:(PS:此示例需要本中间件在路由中间件后启用,这样预设的替换功能才会生效。)
示例四:在路由中独立配置
示例五:路由自定义限流策略
更新日志:
v1.1.1: 优化中间件安装、卸载策略(实现安全卸载
)
v1.1.0: 增加路由自定义限流策略
v1.0.1: 初始版本(webman下实现 think-throttle 的限流策略)
注意:
1、截至(Webman 1.2.5, Webman-framework v1.2.7) 不支持路由中间件默认传参
2、限流命中(禁止访问)时,think-throttle 默认抛出 HttpResponseException, 本中间件场景下将正常响应 HttpResponse(即不会 Throw Except),特殊需求请在 "visit_fail_response" 匿名函数中配置
申明
本库基于 think-throttle v1.3.x 修改再发布