车熟路的修改它以满足我们自己的需求同时也可以学习人家解决问题的思路提升自己的技术水平

若依提供了很多实用且不花哨的注解本文记录了其中的一个注解RateLimiter--限流注解的实现步骤

版本说明

以下源码内容是基于RuoYi-Vue-3.8.2版本即前后端分离版本

主要思想

标注了RateLimiter注解的方法在执行前调用lua脚本把一段时间内的访问次数存入redis并返回判断返回值是否大于设定的阈值大于则抛出异常由全局异常处理器处理

具体步骤

我们先来看一看RateLimiter注解在src/main/java/com/ruoyi/common/annotation包下

Retention(RetentionPolicy.RUNTIME)

Documented

key存储在redis里用到的keytime限流时间相当于redis里的有效期count限流次数limitType:

限流类型点开枚举发现有默认和IP两种限流方式这两种方式的实现只是存储在redis里的key不同

我们来看一看RateLimiter这个注解的切面RateLimiterAspect.java在src/main/java/com/ruoyi/framework/aspectj包里

Aspect

LoggerFactory.getLogger(RateLimiterAspect.class);private

RedisTemplateObject,

setRedisTemplate1(RedisTemplateObject,

Object

redisTemplate){this.redisTemplate

void

limitScript;}Before(annotation(rateLimiter))public

void

Collections.singletonList(combineKey);try{//

调用lua脚本传入三个参数Long

redisTemplate.execute(limitScript,

keys,

ServiceException(访问过于频繁请稍候再试);}log.info(限制请求{},当前请求{},缓存key{},

count,

RuntimeException(服务器限流异常请稍候再试);}}public

String

StringBuffer(rateLimiter.key());//

判断限流类型如果是IP限流就在key后添加上IP若依自己写了一个获取ip的方法类大家可以自行查看if

LimitType.IP){stringBuffer.append(IpUtils.getIpAddr(ServletUtils.getRequest())).append(-);}//

获取方法MethodSignature

key中添加方法名-类名stringBuffer.append(targetClass.getName()).append(-).append(method.getName());return

简单说明一下这个切面类

使用了set的方式注入了RedisTemplate和RedisScriptRedisTemplate大家都很熟悉RedisScript是用于加载和执行lua脚本的定义了一个前置通知废话限流肯定是前置通过getCombineKey方法获取应该存入redis中的keygetCombineKey方法每一步我都做了注解将key、time、count作为参数传入lua脚本执行脚本判断返回值为空或者或者返回值大于设定的count抛出异常由全局异常处理器处理方法不再往下执行达到了限流的效果

lua脚本

最后我们来看一看若依是怎么写lua脚本的在脚本在redis的配置类RedisConfig.java里该类在src/main/java/com/ruoyi/framework/config包下

Configuration

泛型是返回值的类型DefaultRedisScriptLong

redisScript

设置脚本redisScript.setScriptText(limitScriptText());//

设置返回值类型redisScript.setResultType(Long.class);return

redisScript;}/***

接收3个变量key阈值count过期时间time调用get(key)方法获取key中的值current如果这个key存在并且current大于count返回current调用redis的自增函数赋值给current当current1时即第一次访问该接口调用redis的设置过期时间函数给当前key设置过期时间返回current

使用lua脚本可以在并发的情况下更好的满足原子性只是我不太明白若依为什么不把脚本文件单独拿出来写在resources文件夹下这样阅读和维护都会更加方便。

总之这就是若依限流注解的全部内容

标注了RateLimiter注解的方法在执行方法前调用lua脚本把自己的类名方法名当做key传入判断返回值是否大于设定的阈值大于则抛出异常不再向下执行异常由全局异常处理器处理。