pqcqaq/api-current-limiter-starter-boot3

💖SpringBoot💖 接口限流工具🥳（SpringBoot3）

安装👋：

• maven🤩：

  <dependency>
    <groupId>online.zust.qcqcqc.utils</groupId>
    <artifactId>api-current-limiter-starter-boot3</artifactId>
    <version>1.0.0</version>
  </dependency>

  🥰已经发布在**仓库：https://central.sonatype.com/artifact/online.zust.qcqcqc.utils/api-current-limiter-starter-boot3

• 上一个版本是：1.0.0

使用🤏：

1. 🫰在配置文件中启用

   limiter:
     enable: true
     type: redis

   这里的type支持多种类型，redis为默认实现之一，已经写好实现类😘

   • redis：使用redis进行限流控制。
   • 默认：使用ConcurrentHashMap进行限流控制。
   • 自定义：取消设置该选项可以使用自定义算法。

2. 🤞在接口上添加注解

       @CurrentLimit(limitNum = 20, seconds = 10, limitByUser = true, key = "LimitTest", msg = "请求过于频繁")
       @GetMapping("/test")
       public Result<String> test() {
           return Result.success(ProxyUtil.getBean(CurrentLimiterManager.class).getClass().getSimpleName());
       }

   1. 注解中的seconds为规定时间内访问。
   2. 这里的limitNum为规定时间内的访问次数限制。
   3. *limitByUser为是否根据登录信息进行限制。
      1. false：全局限流，对该接口的所有请求进行记录
      2. true：根据getUserKey方法获取用户信息（默认为ip），进行限流
   4. key为标识，可以为空，为空时默认取方法名。
   5. 还可以指定msg，也就是错误信息。

       @IntervalLimit(interval = 2000, limitByUser = true, key = "IntervalTest", msg = "请求过于频繁")
       @GetMapping("/test/3")
       public Result<String> test3() {
           return Result.success(ProxyUtil.getBean(IntervalLimiterManager.class).getClass().getSimpleName());
       }

   1. interval为间隔时间，单位毫秒
      • 这个注解用于实现对该接口的请求间隔限制（可用于防抖），默认值为100ms

       @ConcurrentLimit(limitNum = 20, limitByUser = true, key = "ConcurrentTest", msg = "请求过于频繁")
       @GetMapping("/test/4")
       public Result<String> test4() {
           return Result.success(ProxyUtil.getBean(ConcurrentLimiterManager.class).getClass().getSimpleName());
       }

   1. limitNum：限制最大并发数
      • 这个注解用于实现对该接口的最大并发数限制，默认值为10

   异常处理😟：

   • 在禁止访问时会抛出异常：ApiCurrentLimitException，可以自定义异常处理器进行处理。
   • 在尝试访问失败时会抛出异常：ErrorTryAccessException，此后请求会被拒绝。

   ---

   高级🤔

3. 其他配置项

   limiter:
     enable: true
     type: redis
     remote-info:
       use-proxy: true
       user-key: X-Forwarded-For
     global:
       enable: true
       limit-num: 100
       seconds: 60
       on-method: true

   • remote-info配置项内，指定获取远程ip的方法

     • use-proxy：是否启用了反向代理

       如果启用了反向代理，则后端不能直接获取到真实IP地址，需要指定请求头中真实ip的key

       • 默认值：false

     • user-key：在确认开启use-proxy的情况下，需要配置该项作为请求头中真实ip的key

       • 默认值：X-Forwarded-For

   • global配置项内，指定是否开启全局接口限流

     • limit-num表示限流数量
       • 默认值：100
     • seconds表示时间滑动窗口大小
       • 默认值：10s
     • on-method：
       • 默认值：true
       • true：配置为单个接口，效果类似全部接口加上@CurrentLimit注解
       • false：配置为后端服务限流，所有接口一起在该配置范围内进行限流

4. **（可选）**🤘自定义获取key生成方法

   /**
    * @author pqcmm
    */
   @Component
   public class MyLimiterConfig implements LimiterConfig {
       @Setter(onMethod_ = {@Autowired})
       private HttpServletRequest httpServletRequest;
   
       @Value("${limiter.remote-info.user-key:X-Forwarded-For}")
       private String headerKey;
       @Value("${limiter.remote-info.use-proxy:false}")
       private Boolean useProxy;
   
       @Override
       public String getUserKey() {
           // 如果已经登录，则使用用户名作为唯一标识
           User currentUser = ContextUtil.getCurrentUser();
           if (currentUser == null) {
               // 否则使用IP地址作为唯一标识
               if (useProxy) {
                   return httpServletRequest.getHeader(headerKey);
               } else {
                   return httpServletRequest.getRemoteAddr();
               }
           }
           return currentUser.getUsername();
       }
   }

   • 这只是一个示例，假设limitByUser = true，并且想对业务用户进行限流，则必须实现LimiterConfig中的getUserKey方法，否则只会使用客户端IP进行限流

5. **（可选）**🫵自定义限流算法

   1. 取消设置 limiter.type
   2. 编写LimitManager接口的子接口的实现类
      • 实现流量限制：CurrentLimiterManager
      • 实现并发限制：ConcurrentLimiterManager
      • 实现间隔限制：IntervalLimiterManager
      • 这些接口都有这样的方法boolean tryAccess(Limiter limiter);
        • 通过实现这个方法就可以实现对应的算法处理
        • 别忘了添加@Component注解来替换默认的组件
        • 以下是通过redis和map实现算法的示例代码：
        • 

6. 注解执行顺序

   ConcurrentLimitAspect >> IntervalLimitAspect >> CurrentLimitAspect >> GlobalLimitAspect
   

性能🙌

• 使用aop切面编程，在controller方法前切入，使用cglib代理生成动态代理类，对性能影响较小。
• 推荐使用redis（lua脚本保证原子性），性能更强

注意🙏

• 在自定义限流算法时，记得别忘了对并发请求的处理，避免实际限流值大于设定值。

展望☝️

• √ 请求间隔时间限制（防抖）√
• √ 对接口并发数进行限制 √
• √ 全局限流 √
• 使用漏桶算法和令牌桶算法，实现QPS限流
• 请求队列 缓流（削峰填谷）
• 拒绝策略
• 接口等待时间（？
• 支持SpringBoot3.0+ √

更新日志（boot3）

• 1.0.0 正式发布SpringBoot3版本

更新日志（boot2）

• 1.0.0 正式发布
• 1.0.1 修改了POM文件
• 1.0.2 移除lombok依赖
• 1.0.3 将原有计数逻辑改为时间滑动窗口
• 1.0.4 添加接口请求间隔注解(可以用来实现防抖)
• 1.0.5 将Redis脚本移到资源目录，修复了过度占用Redis缓存的问题
• 1.0.6 新功能：接口最大并发数控制
• 1.0.7 修复了部分bug，增加全局限流接口
• 1.0.8 将全局限流的aop改为Interceptor
• 1.1.0 使用全新的设计思路，将tryAccess职责抽象抬高，并延伸出更多实现类，降低各个功能耦合性