From 6fde4fb4ef9d0d425e9ddfd1d279110ebc68eae9 Mon Sep 17 00:00:00 2001
From: 疯狂的狮子li <15040126243@163.com>
Date: 星期日, 26 二月 2023 20:46:58 +0800
Subject: [PATCH] update 优化 限流注解 key 支持 spel 表达式, message 支持自定义内容与国际化
---
ruoyi-common/ruoyi-common-ratelimiter/src/main/java/com/ruoyi/common/ratelimiter/aspectj/RateLimiterAspect.java | 85 +++++++++++++++++++++++++++++++++++-------
ruoyi-common/ruoyi-common-ratelimiter/src/main/java/com/ruoyi/common/ratelimiter/annotation/RateLimiter.java | 11 ++++-
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 9fe9b0a..87a946b 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 @@
@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 @@
* 闄愭祦绫诲瀷
*/
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 b313aaa..73e7369 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.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,7 +34,25 @@
*/
@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 {
@@ -36,29 +66,56 @@
}
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) {
- // 鑾峰彇瀹㈡埛绔疄渚媔d
- 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();
+ // 鍒ゆ柇鏄惁鏄痵pel鏍煎紡
+ 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]);
+ }
+ // 瑙ｆ瀽杩斿洖缁檏ey
+ 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) {
+ // 鑾峰彇瀹㈡埛绔疄渚媔d
+ stringBuffer.append(RedisUtils.getClient().getId()).append(":");
+ }
+ return stringBuffer.append(key).toString();
}
}
--
Gitblit v1.9.3