【新增】新增 UserIdempotentKeyResolver 解析器，支持用户级别的幂等

YunaiV
1 parent 321f71de
Showing 8 changed files with 83 additions and 7 deletions
yudao-framework/yudao-spring-boot-starter-protection/pom.xml
yudao-framework/yudao-spring-boot-starter-protection/src/main/java/cn/iocoder/yudao/framework/idempotent/config/YudaoIdempotentConfiguration.java
yudao-framework/yudao-spring-boot-starter-protection/src/main/java/cn/iocoder/yudao/framework/idempotent/core/annotation/Idempotent.java
yudao-framework/yudao-spring-boot-starter-protection/src/main/java/cn/iocoder/yudao/framework/idempotent/core/aop/IdempotentAspect.java
yudao-framework/yudao-spring-boot-starter-protection/src/main/java/cn/iocoder/yudao/framework/idempotent/core/keyresolver/impl/DefaultIdempotentKeyResolver.java
yudao-framework/yudao-spring-boot-starter-protection/src/main/java/cn/iocoder/yudao/framework/idempotent/core/keyresolver/impl/UserIdempotentKeyResolver.java
yudao-framework/yudao-spring-boot-starter-protection/src/main/java/cn/iocoder/yudao/framework/idempotent/core/redis/IdempotentRedisDAO.java
yudao-module-system/yudao-module-system-biz/src/main/java/cn/iocoder/yudao/module/system/controller/admin/user/UserController.http
@@ -16,6 +16,13 @@
     <url>https://github.com/YunaiV/ruoyi-vue-pro</url>
  
     <dependencies>
+        <!-- Web 相关 -->
+        <dependency>
+            <groupId>cn.iocoder.boot</groupId>
+            <artifactId>yudao-spring-boot-starter-web</artifactId>
+            <scope>provided</scope> <!-- 设置为 provided，只有 OncePerRequestFilter 使用到 -->
+        </dependency>
+
         <!-- DB 相关 -->
         <dependency>
             <groupId>cn.iocoder.boot</groupId>
@@ -4,6 +4,7 @@ import cn.iocoder.yudao.framework.idempotent.core.aop.IdempotentAspect;
 import cn.iocoder.yudao.framework.idempotent.core.keyresolver.impl.DefaultIdempotentKeyResolver;
 import cn.iocoder.yudao.framework.idempotent.core.keyresolver.impl.ExpressionIdempotentKeyResolver;
 import cn.iocoder.yudao.framework.idempotent.core.keyresolver.IdempotentKeyResolver;
+import cn.iocoder.yudao.framework.idempotent.core.keyresolver.impl.UserIdempotentKeyResolver;
 import cn.iocoder.yudao.framework.idempotent.core.redis.IdempotentRedisDAO;
 import org.springframework.boot.autoconfigure.AutoConfiguration;
 import cn.iocoder.yudao.framework.redis.config.YudaoRedisAutoConfiguration;
@@ -33,6 +34,11 @@ public class YudaoIdempotentConfiguration {
     }
  
     @Bean
+    public UserIdempotentKeyResolver userIdempotentKeyResolver() {
+        return new UserIdempotentKeyResolver();
+    }
+
+    @Bean
     public ExpressionIdempotentKeyResolver expressionIdempotentKeyResolver() {
         return new ExpressionIdempotentKeyResolver();
     }
@@ -2,6 +2,8 @@ package cn.iocoder.yudao.framework.idempotent.core.annotation;
  
 import cn.iocoder.yudao.framework.idempotent.core.keyresolver.impl.DefaultIdempotentKeyResolver;
 import cn.iocoder.yudao.framework.idempotent.core.keyresolver.IdempotentKeyResolver;
+import cn.iocoder.yudao.framework.idempotent.core.keyresolver.impl.ExpressionIdempotentKeyResolver;
+import cn.iocoder.yudao.framework.idempotent.core.keyresolver.impl.UserIdempotentKeyResolver;
  
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
@@ -36,6 +38,10 @@ public @interface Idempotent {
  
     /**
      * 使用的 Key 解析器
+     *
+     * @see DefaultIdempotentKeyResolver 全局级别
+     * @see UserIdempotentKeyResolver 用户级别
+     * @see ExpressionIdempotentKeyResolver 自定义表达式，通过 {@link #keyArg()} 计算
      */
     Class<? extends IdempotentKeyResolver> keyResolver() default DefaultIdempotentKeyResolver.class;
     /**
@@ -43,4 +49,15 @@ public @interface Idempotent {
      */
     String keyArg() default "";
  
+    /**
+     * 删除 Key，当发生异常时候
+     *
+     * 问题：为什么发生异常时，需要删除 Key 呢？
+     * 回答：发生异常时，说明业务发生错误，此时需要删除 Key，避免下次请求无法正常执行。
+     *
+     * 问题：为什么不搞 deleteWhenSuccess 执行成功时，需要删除 Key 呢？
+     * 回答：这种情况下，本质上是分布式锁，推荐使用 @Lock4j 注解
+     */
+    boolean deleteKeyWhenException() default true;
+
 }
@@ -2,14 +2,14 @@ package cn.iocoder.yudao.framework.idempotent.core.aop;
  
 import cn.iocoder.yudao.framework.common.exception.ServiceException;
 import cn.iocoder.yudao.framework.common.exception.enums.GlobalErrorCodeConstants;
+import cn.iocoder.yudao.framework.common.util.collection.CollectionUtils;
 import cn.iocoder.yudao.framework.idempotent.core.annotation.Idempotent;
 import cn.iocoder.yudao.framework.idempotent.core.keyresolver.IdempotentKeyResolver;
 import cn.iocoder.yudao.framework.idempotent.core.redis.IdempotentRedisDAO;
-import cn.iocoder.yudao.framework.common.util.collection.CollectionUtils;
 import lombok.extern.slf4j.Slf4j;
-import org.aspectj.lang.JoinPoint;
+import org.aspectj.lang.ProceedingJoinPoint;
+import org.aspectj.lang.annotation.Around;
 import org.aspectj.lang.annotation.Aspect;
-import org.aspectj.lang.annotation.Before;
 import org.springframework.util.Assert;
  
 import java.util.List;
@@ -36,21 +36,33 @@ public class IdempotentAspect {
         this.idempotentRedisDAO = idempotentRedisDAO;
     }
  
-    @Before("@annotation(idempotent)")
-    public void beforePointCut(JoinPoint joinPoint, Idempotent idempotent) {
+    @Around(value = "@annotation(idempotent)")
+    public Object beforePointCut(ProceedingJoinPoint joinPoint, Idempotent idempotent) throws Throwable {
         // 获得 IdempotentKeyResolver
         IdempotentKeyResolver keyResolver = keyResolvers.get(idempotent.keyResolver());
         Assert.notNull(keyResolver, "找不到对应的 IdempotentKeyResolver");
         // 解析 Key
         String key = keyResolver.resolver(joinPoint, idempotent);
  
-        // 锁定 Key。
+        // 1. 锁定 Key
         boolean success = idempotentRedisDAO.setIfAbsent(key, idempotent.timeout(), idempotent.timeUnit());
         // 锁定失败，抛出异常
         if (!success) {
             log.info("[beforePointCut][方法({}) 参数({}) 存在重复请求]", joinPoint.getSignature().toString(), joinPoint.getArgs());
             throw new ServiceException(GlobalErrorCodeConstants.REPEATED_REQUESTS.getCode(), idempotent.message());
         }
+
+        // 2. 执行逻辑
+        try {
+            return joinPoint.proceed();
+        } catch (Throwable throwable) {
+            // 3. 异常时，删除 Key
+            // 参考美团 GTIS 思路：https://tech.meituan.com/2016/09/29/distributed-system-mutually-exclusive-idempotence-cerberus-gtis.html
+            if (idempotent.deleteKeyWhenException()) {
+                idempotentRedisDAO.delete(key);
+            }
+            throw throwable;
+        }
     }
  
 }
@@ -7,7 +7,7 @@ import cn.iocoder.yudao.framework.idempotent.core.keyresolver.IdempotentKeyResol
 import org.aspectj.lang.JoinPoint;
  
 /**
- * 默认幂等 Key 解析器，使用方法名 + 方法参数，组装成一个 Key
+ * 默认（全局级别）幂等 Key 解析器，使用方法名 + 方法参数，组装成一个 Key
  *
  * 为了避免 Key 过长，使用 MD5 进行“压缩”
  *
+package cn.iocoder.yudao.framework.idempotent.core.keyresolver.impl;
+
+import cn.hutool.core.util.StrUtil;
+import cn.hutool.crypto.SecureUtil;
+import cn.iocoder.yudao.framework.idempotent.core.annotation.Idempotent;
+import cn.iocoder.yudao.framework.idempotent.core.keyresolver.IdempotentKeyResolver;
+import cn.iocoder.yudao.framework.web.core.util.WebFrameworkUtils;
+import org.aspectj.lang.JoinPoint;
+
+/**
+ * 用户级别的幂等 Key 解析器，使用方法名 + 方法参数 + userId + userType，组装成一个 Key
+ *
+ * 为了避免 Key 过长，使用 MD5 进行“压缩”
+ *
+ * @author 芋道源码
+ */
+public class UserIdempotentKeyResolver implements IdempotentKeyResolver {
+
+    @Override
+    public String resolver(JoinPoint joinPoint, Idempotent idempotent) {
+        String methodName = joinPoint.getSignature().toString();
+        String argsStr = StrUtil.join(",", joinPoint.getArgs());
+        Long userId = WebFrameworkUtils.getLoginUserId();
+        Integer userType = WebFrameworkUtils.getLoginUserType();
+        return SecureUtil.md5(methodName + argsStr + userId + userType);
+    }
+
+}
@@ -29,6 +29,11 @@ public class IdempotentRedisDAO {
         return redisTemplate.opsForValue().setIfAbsent(redisKey, "", timeout, timeUnit);
     }
  
+    public void delete(String key) {
+        String redisKey = formatKey(key);
+        redisTemplate.delete(redisKey);
+    }
+
     private static String formatKey(String key) {
         return String.format(IDEMPOTENT, key);
     }
 ### 请求 /system/user/page 接口 => 没有权限
 GET {{baseUrl}}/system/user/page?pageNo=1&pageSize=10
 Authorization: Bearer {{token}}
+#Authorization: Bearer test100
 tenant-id: {{adminTenentId}}