From 6fde4fb4ef9d0d425e9ddfd1d279110ebc68eae9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E7=96=AF=E7=8B=82=E7=9A=84=E7=8B=AE=E5=AD=90li?= <15040126243@163.com> Date: Sun, 26 Feb 2023 20:46:58 +0800 Subject: [PATCH] =?UTF-8?q?update=20=E4=BC=98=E5=8C=96=20=E9=99=90?= =?UTF-8?q?=E6=B5=81=E6=B3=A8=E8=A7=A3=20key=20=E6=94=AF=E6=8C=81=20spel?= =?UTF-8?q?=20=E8=A1=A8=E8=BE=BE=E5=BC=8F,=20message=20=E6=94=AF=E6=8C=81?= =?UTF-8?q?=E8=87=AA=E5=AE=9A=E4=B9=89=E5=86=85=E5=AE=B9=E4=B8=8E=E5=9B=BD?= =?UTF-8?q?=E9=99=85=E5=8C=96?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../ratelimiter/annotation/RateLimiter.java | 11 ++- .../aspectj/RateLimiterAspect.java | 85 ++++++++++++++++--- 2 files changed, 79 insertions(+), 17 deletions(-) diff --git a/ruoyi-common/ruoyi-common-ratelimiter/src/main/java/com/ruoyi/common/ratelimiter/annotation/RateLimiter.java b/ruoyi-common/ruoyi-common-ratelimiter/src/main/java/com/ruoyi/common/ratelimiter/annotation/RateLimiter.java index 9fe9b0aa0..87a946b14 100644 --- a/ruoyi-common/ruoyi-common-ratelimiter/src/main/java/com/ruoyi/common/ratelimiter/annotation/RateLimiter.java +++ b/ruoyi-common/ruoyi-common-ratelimiter/src/main/java/com/ruoyi/common/ratelimiter/annotation/RateLimiter.java @@ -1,6 +1,5 @@ package com.ruoyi.common.ratelimiter.annotation; -import com.ruoyi.common.core.constant.GlobalConstants; import com.ruoyi.common.ratelimiter.enums.LimitType; import java.lang.annotation.*; @@ -15,9 +14,10 @@ import java.lang.annotation.*; @Documented public @interface RateLimiter { /** - * 限流key + * 限流key,支持使用Spring el表达式来动态获取方法上的参数值 + * 格式类似于 #code.id #{#code} */ - String key() default GlobalConstants.RATE_LIMIT_KEY; + String key() default ""; /** * 限流时间,单位秒 @@ -33,4 +33,9 @@ public @interface RateLimiter { * 限流类型 */ LimitType limitType() default LimitType.DEFAULT; + + /** + * 提示消息 支持国际化 格式为 {code} + */ + String message() default "{rate.limiter.message}"; } diff --git a/ruoyi-common/ruoyi-common-ratelimiter/src/main/java/com/ruoyi/common/ratelimiter/aspectj/RateLimiterAspect.java b/ruoyi-common/ruoyi-common-ratelimiter/src/main/java/com/ruoyi/common/ratelimiter/aspectj/RateLimiterAspect.java index b313aaae3..73e7369bf 100644 --- a/ruoyi-common/ruoyi-common-ratelimiter/src/main/java/com/ruoyi/common/ratelimiter/aspectj/RateLimiterAspect.java +++ b/ruoyi-common/ruoyi-common-ratelimiter/src/main/java/com/ruoyi/common/ratelimiter/aspectj/RateLimiterAspect.java @@ -1,8 +1,11 @@ package com.ruoyi.common.ratelimiter.aspectj; +import cn.hutool.core.util.ArrayUtil; +import com.ruoyi.common.core.constant.GlobalConstants; import com.ruoyi.common.core.exception.ServiceException; import com.ruoyi.common.core.utils.MessageUtils; import com.ruoyi.common.core.utils.ServletUtils; +import com.ruoyi.common.core.utils.StringUtils; import com.ruoyi.common.ratelimiter.annotation.RateLimiter; import com.ruoyi.common.ratelimiter.enums.LimitType; import com.ruoyi.common.redis.utils.RedisUtils; @@ -12,6 +15,15 @@ import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Before; import org.aspectj.lang.reflect.MethodSignature; import org.redisson.api.RateType; +import org.springframework.core.DefaultParameterNameDiscoverer; +import org.springframework.core.ParameterNameDiscoverer; +import org.springframework.expression.EvaluationContext; +import org.springframework.expression.ExpressionParser; +import org.springframework.expression.ParserContext; +import org.springframework.expression.common.TemplateParserContext; +import org.springframework.expression.spel.standard.SpelExpressionParser; +import org.springframework.expression.spel.support.StandardEvaluationContext; +import org.springframework.stereotype.Component; import java.lang.reflect.Method; @@ -22,8 +34,26 @@ import java.lang.reflect.Method; */ @Slf4j @Aspect +@Component public class RateLimiterAspect { + /** + * 定义spel表达式解析器 + */ + private final ExpressionParser parser = new SpelExpressionParser(); + /** + * 定义spel解析模版 + */ + private final ParserContext parserContext = new TemplateParserContext(); + /** + * 定义spel上下文对象进行解析 + */ + private final EvaluationContext context = new StandardEvaluationContext(); + /** + * 方法参数解析器 + */ + private final ParameterNameDiscoverer pnd = new DefaultParameterNameDiscoverer(); + @Before("@annotation(rateLimiter)") public void doBefore(JoinPoint point, RateLimiter rateLimiter) throws Throwable { int time = rateLimiter.time(); @@ -36,29 +66,56 @@ public class RateLimiterAspect { } long number = RedisUtils.rateLimiter(combineKey, rateType, count, time); if (number == -1) { - throw new ServiceException(MessageUtils.message("rate.limiter.message")); + String message = rateLimiter.message(); + if (StringUtils.startsWith(message, "{") && StringUtils.endsWith(message, "}")) { + message = MessageUtils.message(StringUtils.substring(message, 1, message.length() - 1)); + } + throw new ServiceException(message); } log.info("限制令牌 => {}, 剩余令牌 => {}, 缓存key => '{}'", count, number, combineKey); - } catch (ServiceException e) { - throw e; } catch (Exception e) { - throw new RuntimeException("服务器限流异常，请稍候再试"); + if (e instanceof ServiceException) { + throw e; + } else { + throw new RuntimeException("服务器限流异常，请稍候再试"); + } } } public String getCombineKey(RateLimiter rateLimiter, JoinPoint point) { - StringBuilder stringBuffer = new StringBuilder(rateLimiter.key()); - if (rateLimiter.limitType() == LimitType.IP) { - // 获取请求ip - stringBuffer.append(ServletUtils.getClientIP()).append("-"); - } else if (rateLimiter.limitType() == LimitType.CLUSTER) { - // 获取客户端实例id - stringBuffer.append(RedisUtils.getClient().getId()).append("-"); - } + String key = rateLimiter.key(); + // 获取方法(通过方法签名来获取) MethodSignature signature = (MethodSignature) point.getSignature(); Method method = signature.getMethod(); Class targetClass = method.getDeclaringClass(); - stringBuffer.append(targetClass.getName()).append("-").append(method.getName()); - return stringBuffer.toString(); + // 判断是否是spel格式 + if (StringUtils.containsAny(key, "#")) { + // 获取参数值 + Object[] args = point.getArgs(); + // 获取方法上参数的名称 + String[] parameterNames = pnd.getParameterNames(method); + if (ArrayUtil.isEmpty(parameterNames)) { + throw new ServiceException("限流key解析异常!请联系管理员!"); + } + for (int i = 0; i < parameterNames.length; i++) { + context.setVariable(parameterNames[i], args[i]); + } + // 解析返回给key + try { + key = parser.parseExpression(key, parserContext).getValue(context, String.class) + ":"; + } catch (Exception e) { + throw new ServiceException("限流key解析异常!请联系管理员!"); + } + } + StringBuilder stringBuffer = new StringBuilder(GlobalConstants.RATE_LIMIT_KEY); + stringBuffer.append(ServletUtils.getRequest().getRequestURI()).append(":"); + if (rateLimiter.limitType() == LimitType.IP) { + // 获取请求ip + stringBuffer.append(ServletUtils.getClientIP()).append(":"); + } else if (rateLimiter.limitType() == LimitType.CLUSTER) { + // 获取客户端实例id + stringBuffer.append(RedisUtils.getClient().getId()).append(":"); + } + return stringBuffer.append(key).toString(); } }