若依框架----源码分析(@RateLimiter)

本文涉及的产品
Redis 开源版,标准版 2GB
推荐场景:
搭建游戏排行榜
云数据库 Tair(兼容Redis),内存型 2GB
简介: 若依框架----源码分析(@RateLimiter)

若依作为最近非常火的脚手架,分析它的源码,不仅可以更好的使用它,在出错时及时定位,也可以在需要个性化功能时轻车熟路的修改它以满足我们自己的需求,同时也可以学习人家解决问题的思路,提升自己的技术水平


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


版本说明


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


主要思想


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


具体步骤


1. 注解


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

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface RateLimiter 
{
    // 限流key
    public String key() default Constants.RATE_LIMIT_KEY;
    // 限流时间,单位秒
    public int time() default 60;
    // 限流次数
    public int count() default 100;
     // 限流类型
    public LimitType limitType() default LimitType.DEFAULT;
}


一个作用在方法上的注解,有四个属性


  • key:存储在redis里用到的key
  • time:限流时间,相当于redis里的有效期
  • count:限流次数
  • limitType: 限流类型,点开枚举发现有默认和IP两种限流方式,这两种方式的实现只是存储在redis里的key不同


2. 切面


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

@Aspect
@Component
public class RateLimiterAspect 
{
    private static final Logger log = LoggerFactory.getLogger(RateLimiterAspect.class);
    private RedisTemplate<Object, Object> redisTemplate;
    private RedisScript<Long> limitScript;
    @Autowired
    public void setRedisTemplate1(RedisTemplate<Object, Object> redisTemplate)
    {
        this.redisTemplate = redisTemplate;
    }
    @Autowired
    public void setLimitScript(RedisScript<Long> limitScript)
    {
        this.limitScript = limitScript;
    }
    @Before("@annotation(rateLimiter)")
    public void doBefore(JoinPoint point, RateLimiter rateLimiter) throws Throwable
    {
        String key = rateLimiter.key();
        int time = rateLimiter.time();
        int count = rateLimiter.count();
        String combineKey = getCombineKey(rateLimiter, point);
        List<Object> keys = Collections.singletonList(combineKey);
        try
        {
            // 调用lua脚本,传入三个参数
            Long number = redisTemplate.execute(limitScript, keys, count, time);
            if (StringUtils.isNull(number) || number.intValue() > count)
            {
                throw new ServiceException("访问过于频繁,请稍候再试");
            }
            log.info("限制请求'{}',当前请求'{}',缓存key'{}'", count, number.intValue(), key);
        }
        catch (ServiceException e)
        {
            throw e;
        }
        catch (Exception e)
        {
            throw new RuntimeException("服务器限流异常,请稍候再试");
        }
    }
    public String getCombineKey(RateLimiter rateLimiter, JoinPoint point)
    {
        // 获取注解中的key值
        StringBuffer stringBuffer = new StringBuffer(rateLimiter.key());
        // 判断限流类型,如果是IP限流,就在key后添加上IP(若依自己写了一个获取ip的方法类,大家可以自行查看)
        if (rateLimiter.limitType() == LimitType.IP)
        {
            stringBuffer.append(IpUtils.getIpAddr(ServletUtils.getRequest())).append("-");
        }
        // 获取方法
        MethodSignature signature = (MethodSignature) point.getSignature();
        Method method = signature.getMethod();
        // 获取类
        Class<?> targetClass = method.getDeclaringClass();
        // key中添加方法名-类名
        stringBuffer.append(targetClass.getName()).append("-").append(method.getName());
        return stringBuffer.toString();
    }
}


简单说明一下这个切面类:


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


3. lua脚本


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

@Configuration
@EnableCaching
public class RedisConfig extends CachingConfigurerSupport
{
    ……
    @Bean
    public DefaultRedisScript<Long> limitScript()
    {
        // 泛型是返回值的类型
        DefaultRedisScript<Long> redisScript = new DefaultRedisScript<>();
        // 设置脚本
        redisScript.setScriptText(limitScriptText());
        // 设置返回值类型
        redisScript.setResultType(Long.class);
        return redisScript;
    }
    /**
     * 限流脚本
     */
    private String limitScriptText()
    {
        return "local key = KEYS[1]\n" +
                "local count = tonumber(ARGV[1])\n" +
                "local time = tonumber(ARGV[2])\n" +
                "local current = redis.call('get', key);\n" +
                "if current and tonumber(current) > count then\n" +
                "    return tonumber(current);\n" +
                "end\n" +
                "current = redis.call('incr', key)\n" +
                "if tonumber(current) == 1 then\n" +
                "    redis.call('expire', key, time)\n" +
                "end\n" +
                "return tonumber(current);";
    }
}


我们主要看下lua脚本:


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


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


总结


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

相关实践学习
基于Redis实现在线游戏积分排行榜
本场景将介绍如何基于Redis数据库实现在线游戏中的游戏玩家积分排行榜功能。
云数据库 Redis 版使用教程
云数据库Redis版是兼容Redis协议标准的、提供持久化的内存数据库服务,基于高可靠双机热备架构及可无缝扩展的集群架构,满足高读写性能场景及容量需弹性变配的业务需求。 产品详情:https://www.aliyun.com/product/kvstore &nbsp; &nbsp; ------------------------------------------------------------------------- 阿里云数据库体验:数据库上云实战 开发者云会免费提供一台带自建MySQL的源数据库&nbsp;ECS 实例和一台目标数据库&nbsp;RDS实例。跟着指引,您可以一步步实现将ECS自建数据库迁移到目标数据库RDS。 点击下方链接,领取免费ECS&amp;RDS资源,30分钟完成数据库上云实战!https://developer.aliyun.com/adc/scenario/51eefbd1894e42f6bb9acacadd3f9121?spm=a2c6h.13788135.J_3257954370.9.4ba85f24utseFl
目录
相关文章
|
6月前
|
存储 Java 数据库
若依框架----源码分析(@Log)
若依框架----源码分析(@Log)
1282 1
|
6月前
|
Java Spring
Spring5源码(37)-SpringAop代理调用过程(一)
Spring5源码(37)-SpringAop代理调用过程(一)
41 0
|
3月前
|
Java 开发者 Spring
【SpringBoot 异步魔法】@Async 注解:揭秘 SpringBoot 中异步方法的终极奥秘!
【8月更文挑战第25天】异步编程对于提升软件应用的性能至关重要,尤其是在高并发环境下。Spring Boot 通过 `@Async` 注解简化了异步方法的实现。本文详细介绍了 `@Async` 的基本用法及配置步骤,并提供了示例代码展示如何在 Spring Boot 项目中创建与管理异步任务,包括自定义线程池、使用 `CompletableFuture` 处理结果及异常情况,帮助开发者更好地理解和运用这一关键特性。
147 1
|
3月前
|
XML Java 测试技术
Spring5入门到实战------17、Spring5新功能 --Nullable注解和函数式注册对象。整合JUnit5单元测试框架
这篇文章介绍了Spring5框架的三个新特性:支持@Nullable注解以明确方法返回、参数和属性值可以为空;引入函数式风格的GenericApplicationContext进行对象注册和管理;以及如何整合JUnit5进行单元测试,同时讨论了JUnit4与JUnit5的整合方法,并提出了关于配置文件加载的疑问。
Spring5入门到实战------17、Spring5新功能 --Nullable注解和函数式注册对象。整合JUnit5单元测试框架
|
2月前
|
前端开发 Java Spring
springboot自定义拦截器的简单使用和一个小例子
本文介绍了如何在Spring Boot中创建和使用自定义拦截器,通过一个登录验证的示例,演示了拦截器在MVC流程中的preHandle、postHandle和afterCompletion三个环节的作用,并说明了如何在Spring Boot配置类中注册拦截器。
|
4月前
|
前端开发 Java 应用服务中间件
SpringBoot异步接口怎么实现?
### 前言 Servlet 3.0以前,每个HTTP请求由单一线程全程处理;3.0版本引入异步处理,允许提前释放容器线程,提升系统吞吐量。
|
5月前
|
Java Spring 容器
Spring5系列学习文章分享---第六篇(框架新功能系列+整合日志+ @Nullable注解 + JUnit5整合)
Spring5系列学习文章分享---第六篇(框架新功能系列+整合日志+ @Nullable注解 + JUnit5整合)
37 0
|
6月前
|
监控 Java
【十一】springboot整合异步调用并获取返回值
【十一】springboot整合异步调用并获取返回值
135 0
|
6月前
|
存储 Java Spring
SpringBoot2 | 条件注解 @ConditionalOnBean 原理源码分析(七)
SpringBoot2 | 条件注解 @ConditionalOnBean 原理源码分析(七)
69 0
|
Java Spring 容器
【框架源码】SpringBoot核心源码解读之启动类源码分析
【框架源码】SpringBoot核心源码解读之启动类源码分析
【框架源码】SpringBoot核心源码解读之启动类源码分析