devbox
我家自动化
这个屌丝很懒，什么也没留下！
关注作者
热门标签
热门文章
当前位置:   article > 正文

【229期】Spring Boot 使用令牌桶算法+拦截器+自定义注解+自定义异常实现简单的限流...

作者：我家自动化 | 2024-04-08 01:46:19

赞

踩

自定义注解实现令牌桶算法

点击上方“Java精选”，选择“设为星标”

别问别人为什么，多问自己凭什么！

下方有惊喜，留言必回，有问必答！

每天 08:15 更新文章，每天进步一点点...

令牌桶

在高并发的情况下，限流是后端常用的手段之一，可以对系统限流、接口限流、用户限流等，本文就使用令牌桶算法+拦截器+自定义注解+自定义异常实现限流的demo。

令牌桶思想

大小固定的令牌桶可自行以恒定的速率源源不断地产生令牌。如果令牌不被消耗，或者被消耗的速度小于产生的速度，令牌就会不断地增多，直到把桶填满。

后面再产生的令牌就会从桶中溢出。最后桶中可以保存的最大令牌数永远不会超过桶的大小。然后每个访问的用户都会从中取走一块令牌，取到了令牌才能访问，如果没取到令牌即代表已达到访问上限，将被限流不允许访问

限流demo实现思路

  • 创建令牌桶类

  • 项目启动初始化令牌桶，并设置定时器，定时向桶内放入令牌

  • 自定义限流注解，在需要限流的接口上打上注解

  • 配置令牌桶拦截器，对所有路径进行拦截，对无限流注解的接口直接放行，对有限流注解的做取令牌处理，取到令牌即放行，没取到令牌即抛出自定义异常

  • 自定义异常并使用AOP做全局异常处理

创建令牌类

这里为了防止并发问题在生成令牌和取令牌的方法上加了synchronized

BucketUtil如下

  1. public class BucketUtil {
  2.  
  3.     //默认容量10
  4.     static final int DEFAULT_MAX_COUNT = 10;
  5.     // 默认增长速率为1
  6.     static final int DEFAULT_CREATE_RATE = 1;
  7.     // 使用HashMap存放令牌桶，这里默认为10个令牌桶
  8.     public static  HashMap<String, BucketUtil> buckets = new HashMap(10);
  9.  
  10.     //自定义容量，一旦创建不可改变
  11.     final int maxCount;
  12.     //自定义增长速率1s几个令牌
  13.     int createRate;
  14.     //当前令牌数
  15.     int size=0;
  16.  
  17.  
  18.  
  19.     // 默认令牌桶的容量及增长速率
  20.     public BucketUtil() {
  21.         maxCount = DEFAULT_MAX_COUNT;
  22.         createRate = DEFAULT_CREATE_RATE;
  23.     }
  24.     // 自定义令牌桶容量及增长速率
  25.     public BucketUtil(int maxCount, int createRate) {
  26.         this.maxCount = maxCount;
  27.         this.createRate = createRate;
  28.     }
  29.  
  30.     public int getSize() {
  31.         return size;
  32.     }
  33.  
  34.     public boolean isFull() {
  35.         return size == maxCount;
  36.     }
  37.  
  38.     //根据速率自增生成一个令牌
  39.     public synchronized void incrTokens() {
  40.         for (int i = 0; i < createRate; i++)
  41.         {
  42.             if (isFull())
  43.                 return;
  44.             size++;
  45.         }
  46.     }
  47.  
  48.     // 取一个令牌
  49.     public synchronized boolean getToken() {
  50.         if (size > 0)
  51.             size--;
  52.         else
  53.             return false;
  54.         return true;
  55.     }
  56.  
  57.     @Override
  58.     public boolean equals(Object obj) {
  59.         if (obj == null)
  60.             return false;
  61.         BucketUtil bucket = (BucketUtil) obj;
  62.         if (bucket.size != size || bucket.createRate != createRate || bucket.maxCount != maxCount)
  63.             return false;
  64.         return true;
  65.     }
  66.  
  67.     @Override
  68.     public int hashCode() {
  69.         return Objects.hash(maxCount, size, createRate);
  70.     }
  71.  
  72. }

初始化令牌桶

在启动类上初始化并生成定时器

推荐下自己几个月熬夜整理的面试资料大全：

https://gitee.com/yoodb/eboo‍ks

  1. @EnableScheduling
  2. @SpringBootApplication
  3. public class DemoApplication {
  4.  
  5.  public static void main(String[] args) {
  6.   SpringApplication.run(DemoApplication.class, args);
  7.   // 为了方便测试这里定义1容量  1增长速率
  8.   BucketUtil bucketUtil = new BucketUtil(1,1);
  9.   // 生成名为：bucket的令牌桶
  10.   BucketUtil.buckets.put("bucket",bucketUtil);
  11.  }
  12.  @Scheduled(fixedRate = 1000)// 定时1s
  13.  public void timer() {
  14.   if (BucketUtil.buckets.containsKey("bucket")){
  15.    //名为：bucket的令牌桶 开始不断生成令牌
  16.    BucketUtil.buckets.get("bucket").incrTokens();
  17.   }
  18.  }
  19. }

自定义注解以及异常

BucketAnnotation注解

  1. @Target({ElementType.METHOD})// METHOD代表是用在方法上
  2. @Retention(RetentionPolicy.RUNTIME)
  3. public @interface BucketAnnotation {
  4. }

APIException 异常

  1. public class APIException extends RuntimeException {
  2.     private static final long serialVersionUID = 1L;
  3.     private String msg;
  4.     public APIException(String msg) {
  5.         super(msg);
  6.         this.msg = msg;
  7.     }
  8. }

配置拦截器

BucketInterceptor拦截器如下

  1. /**
  2.  * 令牌桶拦截器
  3.  */
  4. public class BucketInterceptor implements HandlerInterceptor {
  5.  
  6.     // 预处理回调方法，在接口调用之前使用  true代表放行  false代表不放行
  7.     @Override
  8.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) {
  9.         if (!(handler instanceof HandlerMethod)) {
  10.             return true;
  11.         }
  12.  
  13.         HandlerMethod handlerMethod = (HandlerMethod) handler;
  14.         Method method = handlerMethod.getMethod();
  15.  
  16.         BucketAnnotation methodAnnotation = method.getAnnotation(BucketAnnotation.class);
  17.         if (methodAnnotation!=null){
  18.          // 在名为：bucket的令牌桶里取令牌 取到即放行 未取到即抛出异常
  19.             if(BucketUtil.buckets.get("bucket").getToken()){
  20.                 return true;
  21.             }
  22.             else{
  23.              // 抛出自定义异常
  24.                 throw new APIException("不好意思，您被限流了");
  25.             }
  26.         }else {
  27.             return true;
  28.         }
  29.     }
  30.     // 接口调用之后，返回之前 使用
  31.     @Override
  32.     public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
  33.     }
  34.  
  35.     // 整个请求完成后，在视图渲染前使用
  36.     @Override
  37.     public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
  38.     }
  39. }

将拦截器注入

  1. @Configuration
  2. public class WebMvcConfg implements WebMvcConfigurer {
  3.  
  4.     @Override
  5.     public void addInterceptors(InterceptorRegistry registry) {
  6.         // 令牌桶拦截器 添加拦截器并选择拦截路径
  7.         registry.addInterceptor(bucketInterceptor()).addPathPatterns("/**");
  8.     }
  9.     @Bean
  10.     public BucketInterceptor bucketInterceptor() {
  11.         return new BucketInterceptor();
  12.     }
  13. }

AOP全局异常处理

  1. @RestControllerAdvice
  2. public class WebExceptionControl {
  3.     @ExceptionHandler(APIException.class)
  4.     public E3Result APIExceptionHandler(APIException e) {
  5.         return E3Result.build(400,e.getMessage());
  6.     }
  7. }

测试

在我们需要限流的接口上打上自定义注解，如下

  1. @BucketAnnotation
  2. @RequestMapping(value = "/bucket")
  3. public  E3Result bucket(){
  4.     return E3Result.ok("访问成功");
  5. }

关于E3Result只是一个封装好的返回类，这里就不贴出来了，大家有的替换成自己的，没有的可以直接用String型测试

推荐下自己做的 Spring boot 的实战项目：

https://gitee.com/yoodb/jing-xuan

上面为了方便测试，令牌桶的容量设置成了1，所以这是取到令牌成功的

147dfd80d33bae9cc01aeb5a912087ee.png

这是没取到令牌被限流的

0369ecb95bd9b45a3b4da3a12309df32.png

总结

上面的限流只是一个demo还有很多不足的地方，如：

  • 分布式环境下不适用

  • 令牌桶可以有多个，不同的接口采用不同令牌桶的时候，拦截器无法分开限流

  • 一次请求消耗一个令牌，可以被恶意消耗

改进方法：

  • 令牌桶实现采用redis集群存取

  • 注解添加value参数，可以给对应接口打上对应的令牌桶参数，拦截器需对注解参数校验，实现多个接口多个令牌桶的限流

  • 对用户IP校验限制次数，防止恶意攻击

实际项目限流会更加严谨，上述只是提供了一个思路以及演示demo，不喜勿喷谢谢。

版权声明：本文为CSDN博主「Colins~」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。

https://blog.csdn.net/weixin_44102992/article/details/106492691

公众号“Java精选”所发表内容注明来源的，版权归原出处所有（无法查证版权的或者未注明出处的均来自网络，系转载，转载的目的在于传递更多信息，版权属于原作者。如有侵权，请联系，笔者会第一时间删除处理！

------ THE END ------

c25cbe2d12ae54d27e9cc0e9a12cd0ef.png精品资料，超赞福利！d1c7d9df390441a9e298f1c8a0e1e153.png

>Java精选面试题<
3000+ 道面试题在线刷，最新、最全 Java 面试题！

b4bf00a2b25371412b354edc38da5378.png

a8e8fa5a6520d0c5db7d289f6790c62c.png

期往精选  点击标题可跳转

【221期】扔掉工具类，Mybatis 一个简单配置搞定数据加密解密！

【222期】一个适用于 Spring Boot 项目的轻量级 HTTP 客户端框架

【223期】面试官问：什么是 YAML？和 Spring Boot 有什么关系？

【224期】Java 字符串拼接五种方法的性能比较分析，从执行100次到90万次？

【225期】为什么数据库连接池不采用 IO 多路复用？

【226期】面试问我，HashMap 的默认初始容量是多少，我该怎么说？

【227期】面试官：MySQL 数据查询太多会 OOM 吗？

【228期】面试官：跨库多表存在大量数据依赖问题，有哪些解决方案？

fa373f94bcbd3695d29dd9bbfa092a60.png技术交流群！bbec1f6efe87e0e68186fd8e81ead894.png

最近有很多人问，有没有读者&异性交流群，你懂的！想知道如何加入。加入方式很简单，有兴趣的同学，只需要点击下方卡片，回复“加群”，即可免费加入交流群！

文章有帮助的话，在看，转发吧！

声明：本文内容由网友自发贡献，不代表【wpsshop博客】立场，版权归原作者所有，本站不承担相应法律责任。如您发现有侵权的内容，请联系我们。转载请注明出处：https://www.wpsshop.cn/w/我家自动化/article/detail/382102
推荐阅读
相关标签

Copyright © 2003-2013 www.wpsshop.cn 版权所有，并保留所有权利。

  

闽ICP备14008679号