cn.omisheep.authz.annotation

注释类型 RateLimit

@Target(value={TYPE,METHOD})
 @Retention(value=RUNTIME)
public @interface RateLimit

RateLimit 的注解配置，也可以使用json配置来完成对于某个api的配置或者对全局进行配置 json 配置如下：

     {
         "zxc": "admin"
     }
 

【注：网关上的配置一样生效】

从以下版本开始:

1.0.0

作者:

zhouxinchen[1269670415@qq.com]

可选元素概要

可选元素

限定符和类型	可选元素和说明
String[]	associatedPatterns 1.
BannedType	bannedType 封禁角色时，是针对某个接口来说的封禁还是全局的封禁 API 针对接口 IP 全局封禁
RateLimit.CheckType[]	checkType 检查类型，可以是ip或则用户id，或者同时检查
int	maxRequests 在规定的时间窗口内的最大请求数量，超出范围则拉入黑名单(禁止对该接口继续请求)
String	minInterval 最小请求间隔，小于等于0时不对间隔做限制
String[]	punishmentTime 被禁止后在规定时间后释放，默认 [5分钟,10分钟,30分钟,1小时]。
String	window 规定时间段内(默认1秒) 请求数量大于最大数量maxRequests()，则将其禁止。

元素详细资料

window

public abstract String window

规定时间段内(默认1秒) 请求数量大于最大数量maxRequests()，则将其禁止。

禁止时间punishmentTime()默认1h

返回:

时间窗口（单位 ms | s | m | h | d）

默认值:

"1s"

maxRequests

public abstract int maxRequests

在规定的时间窗口内的最大请求数量，超出范围则拉入黑名单(禁止对该接口继续请求)

返回:

在时间窗口内，最大的请求数量

默认值:

5

punishmentTime

public abstract String[] punishmentTime

被禁止后在规定时间后释放，默认 [5分钟,10分钟,30分钟,1小时]。

在解封之后，若在一个窗口的时间周期内仍然出发封禁机制，那么惩罚等级（0是正常）会增加（依次往后+1），时间按照所给的依次往后，直到最后。 如："1h","2h" 当在第一次触发封禁机制时，会禁止1h 当解封之后的一个window时间内，又触发封禁机制。那么会封禁2h。再此触发时，仍然还是2h。

当解封后，若过了window窗口时间，没有再触发，惩罚等级会归零。

返回:

封禁时间（单位 ms | s | m | h | d）

默认值:

{"5m", "10m", "30m", "1h"}

minInterval

public abstract String minInterval

最小请求间隔，小于等于0时不对间隔做限制

返回:

最小请求间隔（单位 ms | s | m | h | d）

默认值:

"0ms"

bannedType

public abstract BannedType bannedType

封禁角色时，是针对某个接口来说的封禁还是全局的封禁

API 针对接口 IP 全局封禁

返回:

-

默认值:

cn.omisheep.authz.annotation.BannedType.API

checkType

public abstract RateLimit.CheckType[] checkType

检查类型，可以是ip或则用户id，或者同时检查

返回:

检查类型

默认值:

cn.omisheep.authz.annotation.RateLimit.CheckType.IP

associatedPatterns

public abstract String[] associatedPatterns

1. 关联的api.当此api封禁时，该ip或者用户id在其他api同样封禁，支持*

2. 如果需要选择模式，则加上前缀可多个，用空格隔开，方法类型 + 空格

3. 当不加时默认为GET，全加可以用*代替

例子:

 * /api/login   --->  GET POST ... /api/login 

 /api/log   --->   GET /api/log 

 POST /api/login 

 POST GET /api/login 

 DELETE /api/delete 

 GET /api/*  --->  /api下的全部封禁 

返回:

关联的api集合

默认值:

{}