自定义注解 配合 拦截器 实现接口限流

转x33g5p2x  于2022-03-31 转载在 其他  
字(5.9k)|赞(0)|评价(0)|浏览(419)

自定义限流注解

先介绍一下 @Retention 和 @Target 这两个元注解
@Retention： 指定注解的生命周期（源码、class文件、运行时），其参考值见类的定义：java.lang.annotation.RetentionPolicy

  • RetentionPolicy.SOURCE :在编译阶段丢弃。这些注解在编译结束之后就不再有任何意义，所以它们不会写入字节码。@Override、@SuppressWarnings都属于这类注解。

  • RetentionPolicy.CLASS : 在类加载的时候丢弃。在字节码文件的处理中有用。注解默认使用这种方式。

  • RetentionPolicy.RUNTIME : 始终不会丢弃，运行期也保留该注解，因此可以使用反射机制读取该注解的信息。我们自定义的注解通常使用这种方式。
    @Target：指定注解使用的目标范围（类、方法、字段等），其参考值见类的定义：java.lang.annotation.ElementType

  • ElementType.CONSTRUCTOR ：用于描述构造器。

  • ElementType.FIELD ：成员变量、对象、属性（包括enum实例）。

  • ElementType.LOCAL_VARIABLE: 用于描述局部变量。

  • ElementType.METHOD ： 用于描述方法。

  • ElementType.PACKAGE ：用于描述包。

  • ElementType.PARAMETER ：用于描述参数。

  • ElementType.ANNOTATION_TYPE：用于描述参数

  • ElementType.TYPE ：用于描述类、接口(包括注解类型) 或enum声明。

自定义注解：

  1. import java.lang.annotation.ElementType;
  2. import java.lang.annotation.Retention;
  3. import java.lang.annotation.RetentionPolicy;
  4. import java.lang.annotation.Target;
  6. /**
  7.  * 自定义限流注解
  8.  */
  9. @Retention(RetentionPolicy.RUNTIME)
  10. @Target(ElementType.METHOD)
  11. public @interface AccessLimit {
  12.     // 限流的时间范围，默认值5
  13.     int second() default 5;
  14.     // 最大访问次数，默认值5
  15.     int maxCount() default 5;
  16. }

根据上面@Retention 和 @Target的介绍，
我们可以知道我们自定义的@AccessLimit注解的生命周期是运行时，注解使用的目标范围是加在方法上

使用该注解

在接口方法上添加该注解

  1. @RestController
  2. public class TestController {
  4.     @AccessLimit(second = 6, maxCount = 6)
  5.     @GetMapping("/accessLimit")
  6.     public String accessLimitTest() {
  7.         return "hello hello";
  8.     }
  9. }

拦截器拦截添加该注解的接口

计数器限流算法

计数器算法是限流算法里最简单也是最容易实现的一种算法。比如我们规定，对于A接口来说，我们1分钟的访问次数不能超过100个。那么我们可以这么做：在一开 始的时候，我们可以设置一个计数器counter，每当一个请求过来的时候，counter就加1，如果counter的值大于100并且该请求与第一个 请求的间隔时间还在1分钟之内，那么说明请求数过多；如果该请求与第一个请求的间隔时间大于1分钟，且counter的值还在限流范围内，那么就重置 counter，具体算法的示意图如下：

自定义拦截器

  1. import com.hkd.seckill.config.AccessLimit;
  2. import com.hkd.seckill.pojo.User;
  3. import com.hkd.seckill.service.UserService;
  4. import com.hkd.seckill.util.CookieUtil;
  5. import com.hkd.seckill.vo.RespBean;
  6. import com.hkd.seckill.vo.RespBeanEnum;
  7. import org.springframework.beans.factory.annotation.Autowired;
  8. import org.springframework.data.redis.core.RedisTemplate;
  9. import org.springframework.stereotype.Component;
  10. import org.springframework.util.StringUtils;
  11. import org.springframework.web.method.HandlerMethod;
  12. import org.springframework.web.servlet.HandlerInterceptor;
  14. import javax.servlet.http.HttpServletRequest;
  15. import javax.servlet.http.HttpServletResponse;
  16. import java.io.IOException;
  17. import java.io.PrintWriter;
  18. import java.util.concurrent.TimeUnit;
  20. /**
  21.  * 自定义拦截器 拦截 @AccessLimit 注解
  22.  */
  23. @Component
  24. public class AccessLimitInterceptor implements HandlerInterceptor {
  26.     @Autowired
  27.     private UserService userService;
  28.     @Autowired
  29.     private RedisTemplate redisTemplate;
  31.     /**
  32.      * 拦截 HandlerMethod 注解
  33.      * @param request
  34.      * @param response
  35.      * @param handler
  36.      * @return 该方法若返回 true 表示放行  返回false表示丢弃该请求
  37.      * @throws Exception
  38.      */
  39.     @Override
  40.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
  41.         if (handler instanceof HandlerMethod) {
  42.             HandlerMethod hm = (HandlerMethod) handler;
  43.             // 拿到AccessLimit这个注解的信息
  44.             AccessLimit accessLimit = hm.getMethodAnnotation(AccessLimit.class);
  45.             // 若没有加 @HandlerMethod 这个注解，则直接放行
  46.             if(accessLimit == null) {
  47.                 return true;
  48.             }
  49.             // 获取注解中限流的时间范围
  50.             int second = accessLimit.second();
  51.             // 获取注解中最大访问次数
  52.             int maxCount = accessLimit.maxCount();
  53.             // 获取当前请求的URL
  54.             String key = request.getRequestURI();
  56.             // 从cookie中获取sessionId
  57.             String ticket = CookieUtil.getCookieValue(request, "userTicket");
  58.             if (!StringUtils.hasLength(ticket)) {
  59.                 render(response, RespBeanEnum.SESSION_ERROR);
  60.                 return false;
  61.             }
  62.             // 从redis中获取用户信息
  63.             User user = userService.getUserByCookie(ticket, request, response);
  64.             if (user == null) {
  65.                 render(response, RespBeanEnum.SESSION_ERROR);
  66.                 return false;
  67.             }
  69.             key += ":" + user.getId();
  70.             // 限流算法  计数器法 在second秒内 某个用户对于某个地址访问的次数不能超过 maxCount
  71.             Integer count = (Integer)redisTemplate.opsForValue().get(key);
  72.             if(count == null) {
  73.                 // 以 url:userId 为key
  74.                 // 初始值1为value
  75.                 // 过期时间为second秒 存储到Redis中
  76.                 redisTemplate.opsForValue().set(key, 1, second, TimeUnit.SECONDS);
  77.             } else if (count < maxCount) {
  78.                 // 若未达到最大值 则累加
  79.                 redisTemplate.opsForValue().increment(key);
  80.             } else {    // 访问次数过多
  81.                 // 若超过最大值 则返回自定义的提示信息 如： {"code":500504,"message":"访问过快，请稍后再试","obj":null}
  82.                 render(response, RespBeanEnum.ACCESS_LIMIT_REAHCED);
  83.                 return false;
  84.             }
  85.         }
  87.         return true;
  88.     }
  89.     /**
  90.      * 渲染，构建返回对象
  91.      * @param response
  92.      * @param respBeanEnum
  93.      */
  94.     private void render(HttpServletResponse response, RespBeanEnum respBeanEnum) throws IOException {
  95.         response.setContentType("application/json");
  96.         response.setCharacterEncoding("UTF-8");
  98.         PrintWriter out = response.getWriter();
  99.         RespBean respBean = RespBean.error(respBeanEnum);
  100.         // 将数据以json字符串的方式返回
  101.         out.write(new ObjectMapper().writeValueAsString(respBean)); // 返回信息：{"code":500504,"message":"访问过快，请稍后再试","obj":null}
  102.         out.flush();
  103.         out.close();
  104.     }
  105. }

实现步骤：

  1. 自定义一个拦截器类 并 实现 HandlerInterceptor 接口
  2. 重写preHandle方法， 该方法在被拦截接口方法执行前执行
  3. AccessLimit accessLimit = hm.getMethodAnnotation(AccessLimit.class)获取接口方法的AccessLimit 注解，if(accessLimit == null){return true; }若没有添加该注解 则返回true，表示放行（我们只对加了@AccessLimit 的接口方法操作）
  4. 紧接着 获取注解中的maxCount、second的值，并获取接口的url地址、用户userId等信息
  5. 利用计数算法实现限流（配合Redis设置过期时间，原理简单）
    计数算法：生成一个计数器，每次请求计数器的值加1，若在一定时间范围内计数器的值达到阈值则进行限流操作
    实现代码：
  1. // 获取注解中限流的时间范围
  2. int second = accessLimit.second();
  3. // 获取注解中最大访问次数
  4. int maxCount = accessLimit.maxCount();
  5. // 获取当前请求的URL
  6. String key = request.getRequestURI();
  8. // 从cookie中获取sessionId
  9. // 获取用户信息
  10. .....
  12. key += ":" + user.getId();
  13. // 限流算法  计数器法 在second秒内 某个用户对于某个地址访问的次数不能超过 maxCount
  14. Integer count = (Integer)redisTemplate.opsForValue().get(key);
  15. if(count == null) {
  16.     // 以 url:userId 为key
  17.     // 初始值1为value
  18.     // 过期时间为second秒 存储到Redis中
  19.     redisTemplate.opsForValue().set(key, 1, second, TimeUnit.SECONDS);
  20. } else if (count < maxCount) {
  21.     // 若未达到最大值 则累加
  22.     redisTemplate.opsForValue().increment(key);
  23. } else {    // 访问次数过多
  24.     // 若超过最大值 则返回自定义的提示信息 如： {"code":500504,"message":"访问过快，请稍后再试","obj":null}
  25.     render(response, RespBeanEnum.ACCESS_LIMIT_REAHCED);
  26.     return false;
  27. }

将拦截器加入到MVC配置中

  1. /**
  2.  * MVC配置类
  3.  */
  4. @Configuration
  5. public class WebConfig implements WebMvcConfigurer {
  7. 	@Autowired
  8. 	private AccessLimitInterceptor accessLimitInterceptor;
  10. 	/**
  11. 	 * 添加拦截器
  12. 	 * @param registry
  13. 	 */
  14. 	@Override
  15. 	public void addInterceptors(InterceptorRegistry registry) {
  16. 		// 拦截 加@HandlerMethod的方法
  17. 		registry.addInterceptor(accessLimitInterceptor);
  18. 	}
  19. }

用例测试

正常访问：

6秒内请求超过6次：

若有不明白的，可以随时在评论区留言，希望能帮到你。

版权说明 : 本文为转载文章, 版权归原作者所有 版权申明

原文链接 : https://blog.csdn.net/qq_45464560/article/details/123815876

内容来源于网络，如有侵权，请联系作者删除！

Javaspringmvc

相关文章

    查看更多

    热门标签

    更多
    JavaquerypythonNode开发语言requestUtil数据库Table后端算法LoggerMessageElementParser

    最新文章

    更多
    • 蜀ICP备13028337号-1 大数据知识库 https://www.saoniuhuo.com © All rights reserved
    • 本站内容来源互联网,如果侵犯您的权益请联系我们删除, 联系方式：448109455@qq.com