使用Redis和lua脚本的方式实现接口限流

不念不忘少年蓝@ 2023-10-11 14:57 12阅读 0赞

### 注解使用说明 ###

**@Limit注解**

我们自己自定义的限流方式思想为自定义一个注解，在写个注解中配置限流的一些信息，然后在接口方法上标注@Limit注解，通过对该注解的AOP功能可达到限流目的。

@Target(ElementType.METHOD)
    @Retention(RetentionPolicy.RUNTIME)
    public @interface Limit {
        
    
        // 资源名称，用于描述接口功能
        String name() default "";
    
        // 资源 key
        String key() default "";
    
        // key prefix
        String prefix() default "";
    
        // 时间的，单位秒
        int period();
    
        // 限制访问次数
        int count();
    
        // 限制类型
        LimitType limitType() default LimitType.CUSTOMER;
    
    }

*  key和perfix这两个属性主要用于在redis中做key用
 *  period和count的意思是在period时间内如果访问count次，则以后的请求被拒绝，如果period=1，count=2，则意味着如果在1秒内超过2次请求，则直接抛出异常。不再执行方法。

**编写测试接口**

@RestController
    @RequestMapping("/eladmin/test")
    public class TestLimitRest {
        
    
        @Limit(name = "限流接口测试",key = "index",prefix = "rest",period = 1,count = 2)
        @GetMapping("limit")
        public String index(){
        
            return "index";
        }
    
    }

*  这个接口表示在一秒之内访问超过两次请求则拒绝。

**编写Limit注解的AOP**

@Aspect
    @Component
    public class LimitAspect {
        
    
        private final RedisTemplate<Object,Object> redisTemplate;
        private static final Logger logger = LoggerFactory.getLogger(LimitAspect.class);
    
        public LimitAspect(RedisTemplate<Object,Object> redisTemplate) {
        
            this.redisTemplate = redisTemplate;
        }
    
        @Pointcut("@annotation(me.zhengjie.annotation.Limit)")
        public void pointcut() {
        
        }
    
        @Around("pointcut()")
        public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        
            HttpServletRequest request = RequestHolder.getHttpServletRequest();
            MethodSignature signature = (MethodSignature) joinPoint.getSignature();
            Method signatureMethod = signature.getMethod();
            Limit limit = signatureMethod.getAnnotation(Limit.class);
            LimitType limitType = limit.limitType();
            String key = limit.key();
            if (StringUtils.isEmpty(key)) {
        
                if (limitType == LimitType.IP) {
        
                    key = StringUtils.getIp(request);
                } else {
        
                    key = signatureMethod.getName();
                }
            }
    
            ImmutableList<Object> keys = ImmutableList.of(StringUtils.join(limit.prefix(), "_", key, "_", request.getRequestURI().replaceAll("/","_")));
    
            String luaScript = buildLuaScript();
            RedisScript<Number> redisScript = new DefaultRedisScript<>(luaScript, Number.class);
            Number count = redisTemplate.execute(redisScript, keys, limit.count(), limit.period());
            if (null != count && count.intValue() <= limit.count()) {
        
                logger.info("第{}次访问key为 {}，描述为 [{}] 的接口", count, keys, limit.name());
                return joinPoint.proceed();
            } else {
        
                throw new BadRequestException("访问次数受限制");
            }
        }
    
        /**
         * 限流脚本
         */
        private String buildLuaScript() {
        
            return "local c" +
                    "\nc = redis.call('get',KEYS[1])" +
                    "\nif c and tonumber(c) > tonumber(ARGV[1]) then" +
                    "\nreturn c;" +
                    "\nend" +
                    "\nc = redis.call('incr',KEYS[1])" +
                    "\nif tonumber(c) == 1 then" +
                    "\nredis.call('expire',KEYS[1],ARGV[2])" +
                    "\nend" +
                    "\nreturn c;";
        }
    }

**测试接口**

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2_size_16_color_FFFFFF_t_70_pic_center]  
发现确实抛出了异常，并被ControllerAdvice捕获了。

### Debug方式运行 ###

*  获取方法的签名，以及方法体上的Limit信息  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2_size_16_color_FFFFFF_t_70_pic_center 1]
 *  keys是？

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2_size_16_color_FFFFFF_t_70_pic_center 2]通过debug发现，ImmutableList.of(StringUtils.join(limit.prefix(), “*", key, "*”, request.getRequestURI().replaceAll("/","\_")));这个方法的作用就是将我们在Limti注解中定义的前缀和key拼接上我们的请求URI。用拼接后的key来作为我们redis中的key。

*  执行lua脚本  
    ![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2_size_16_color_FFFFFF_t_70_pic_center 3]  
    我们看到确实是以这个key来作为redis中的key的。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2_size_16_color_FFFFFF_t_70_pic_center 4]  
count的值为1，则表示这是该key在过期时间内的第一次访问。

![在这里插入图片描述][20201027162747172.png_pic_center]

这个if判断了如果这个count小于等于我们指定的次数，则即可放行。否则抛出异常。

*  为了更好的debug我们将period修改为100，也就是100s内访问超过2次，直接抛出异常。

第一次访问会创建这个key，并设置过期时间  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2_size_16_color_FFFFFF_t_70_pic_center 5]

第一次访问日志打印  
![在这里插入图片描述][20201027163038499.png_pic_center]第二次访问日志打印  
![在这里插入图片描述][20201027163113407.png_pic_center]第三次访问，count值为3，符合条件，抛出异常。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2_size_16_color_FFFFFF_t_70_pic_center 6]

### lua脚本执行过程总结 ###

*  1.当一个接口配置好@Limit注解以后，我们就以period=5，count=2来举例，在这个接口第一次访问的时候，我们会根据方法以及uri生成一个key。
 *  2.判断这个key在redis中是否存在，如果不存在则创建并设置过期时间，且让这个key自增。第一次自增为1.
 *  3.redis返回这个自增值，也就是代码中的count，并判断这个count是否小于等于redis中自增后的值，如果小于，则放行，否则抛出异常。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2_size_16_color_FFFFFF_t_70_pic_center]: https://img-blog.csdnimg.cn/20201027161450705.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2_size_16_color_FFFFFF_t_70_pic_center 1]: https://img-blog.csdnimg.cn/2020102716193661.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2_size_16_color_FFFFFF_t_70_pic_center 2]: https://img-blog.csdnimg.cn/2020102716205575.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2_size_16_color_FFFFFF_t_70_pic_center 3]: https://img-blog.csdnimg.cn/20201027162548750.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2_size_16_color_FFFFFF_t_70_pic_center 4]: https://img-blog.csdnimg.cn/20201027162648544.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2,size_16,color_FFFFFF,t_70#pic_center
[20201027162747172.png_pic_center]: https://img-blog.csdnimg.cn/20201027162747172.png#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2_size_16_color_FFFFFF_t_70_pic_center 5]: https://img-blog.csdnimg.cn/20201027163022609.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2,size_16,color_FFFFFF,t_70#pic_center
[20201027163038499.png_pic_center]: https://img-blog.csdnimg.cn/20201027163038499.png#pic_center
[20201027163113407.png_pic_center]: https://img-blog.csdnimg.cn/20201027163113407.png#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2_size_16_color_FFFFFF_t_70_pic_center 6]: https://img-blog.csdnimg.cn/20201027163200895.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzQzNzUwNjU2,size_16,color_FFFFFF,t_70#pic_center