author: van , ggfanwentao@gmail.com
Ip-Limit: 轻量级注解式IP限流组件
项目简介
基于JVM缓存的轻量级、注解式IP限流组件,方便项目快速引用,满足多线程场景。
默认为滑动窗口限流器,内置令牌桶限流器,可通过注解的属性配置修改
项目地址: https://github.com/DDAaTao/ip-limiter
使用样例
包含较为详细的演示使用代码
样例项目地址: https://github.com/DDAaTao/ip-limiter-example
Ip-Limit 具有以下特性:
- 基于注解使用,简单快捷,可添加到Controller类上,也可以添加到具体的API方法上
- 业务入侵小,不用过多配置类,但可以支持多种场景配置
- 实现组级别统一限流,即可满足单接口单组场景,又可满足多接口单组
- 支持配置文件配置、外部动态配置(新增、删除)黑白名单
# 配置文件中配置,需要注意分隔符为半角的','
my.white.ip.list=172.16.50.21,172.16.50.22,172.16.50.23
// 代码中使用时
@IpLimit(limitType = LimitType.WHITE_LIST, whiteList = "${my.white.ip.list}")
// 或
@IpLimit(limitType = LimitType.WHITE_LIST, whiteList = {"${my.white.ip.list}","172.16.50.35"})
- 黑白名单IP规则实现多种模糊模式配置,支持IPv6
- 172.*.*.1
- 172.*.1
- 172.*
- *.21
- *
核心限流模式 - LimitType类
- DEFAULT - 走默认限流策略,不考虑黑白名单参数
- WHITE_LIST - 只考虑白名单策略,非白名单的请求全部回绝
- BLACK_LIST - 只考虑黑名单策略,非黑名单请求不做限流措施
- DEFAULT_WITH_WHITE_LIST - 在默认限流策略的基础上,白名单内的IP不做限流
- DEFAULT_WITH_BLACK_LIST - 在默认限流策略的基础上,直接403黑名单
- DEFAULT_WITH_WHITE_AND_BLACK_LIST - 在默认限流策略的基础上,直接403黑名单,再让白名单内的IP直接同行
快速开始
- 引入Ip-Limit依赖(已发布至Maven中央仓库)
<dependency>
<groupId>io.github.DDAaTaogroupId>
<artifactId>ip-limiterartifactId>
<version>1.0.3version>
dependency>
- 将 @EnableIpLimit 添加到 webApplication 类上,或其他可以被 Spring 扫描到的类上
- 将 @IpLimit 注解添加到想要做IP限流的方法(接口)上,根据需求动态调整参数
如果项目中没有引入guava、spring-context包,则需要手动引入,否则会报java.lang.NoSuchMethodError异常
从1.0.1开始默认引入,如果项目中已有相关依赖,可以考虑通过去除掉
最佳实践
一、自定义限流异常处理机制
/**
* 默认情况下,当请求超出限流限制时,会打印日志并抛出 IpLimitException 异常
* 用户可以通过统一异常拦截器捕获并自定义业务处理
* 后续考虑增加回调或钩子方法
* */
@Slf4j
@ControllerAdvice
public class BaseExceptionHandler {
@ExceptionHandler(IpLimitException.class)
@ResponseBody
public RestApiResult