SpringBoot+AOP+Redis自定义注解实现防重复提交

missterzy

于 2024-06-21 17:30:00 发布

阅读量344

点赞数 8

分类专栏： JAVA框架缓存文章标签： spring boot redis 后端 AOP 自定义注解

本文链接：https://blog.csdn.net/weixin_53391173/article/details/139840555

版权

JAVA框架同时被 2 个专栏收录

76 篇文章 1 订阅

订阅专栏

缓存

16 篇文章 0 订阅

订阅专栏

1. 哪些因素会引起重复提交？

开发项目过程中可能会出现下面这些情况：

前端下单按钮重复点击导致订单创建多次
网速等原因造成页面卡顿，用户重复刷新提交请求
黑客或恶意用户使用Postman等http工具重复恶意提交表单

2. 重复提交会带来哪些问题？

重复提交带来的问题：

会导致数据重复提交，造成数据重复或者错乱，产生脏数据
接口的请求增加，消耗服务器负载，严重甚至会造成服务器宕机

3. 防重复提交你能想到几种方案？

1.前端JS防止多次点击
- 前端可以被绕过，比如使用Postmen工具
2.数据库或者其他存储增加唯一索引约束，比如注册的手机号唯一
- 但是有些业务是没有唯一性限制的

代码实现

采用自定义注解+AOP的方式，优雅的实现防止重复提交功能。

通过注解的方式指定接口的重复时间。
可以指定接口锁定日期和时间粒度。

引入Maven依赖

在pom.xml文件中dependencies标签里加入：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
    <version>2.7.9</version>
</dependency>
<!-- spring boot aop -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
    <version>2.4.8</version>
</dependency>
<!-- Spring boot redis -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
    <version>2.7.11</version>
</dependency>

配置Redis

spring:
  # Redis
  redis:
    # 数据库索引（默认为0）
    database: 0
    # 服务器地址
    host: 127.0.0.1
    # 服务器连接端口
    port: 6379
    # 服务器连接密码（默认为空）
    password: 123456

自定义注解：防重复提交

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.util.concurrent.TimeUnit;

/**
 * 防重复提交
 *
 * @author xy
 * @date 2024-06-05
 * @apiNote @Target(ElementType.METHOD) 作用到方法上
 * @apiNote @Retention(RetentionPolicy.RUNTIME) 只有虚拟机运行时有效
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface RepeatSubmit {
    /**
     * 锁定时间
     * @return 锁定时间，默认是3 TimeUnit 默认是秒
     */
    int lockedTime() default 3;

    /**
     * 时间单位（时分秒等）
     * @return 单位
     */
    TimeUnit timeUnit() default TimeUnit.SECONDS;
}

定义切面类

import com.example.demo.annotation.RepeatSubmit;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import org.springframework.web.context.request.RequestContextHolder;
import org.springframework.web.context.request.ServletRequestAttributes;

import javax.annotation.Resource;
import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;
import java.util.Objects;

/**
 * 防重复提交切面类
 * @author xy
 * @date 2024-06-05
 */
@Aspect
@Component
public class RepeatSubmitAspect {

    private Logger logger = LoggerFactory.getLogger(RepeatSubmitAspect.class);

    @Resource
    private RedisTemplate redisTemplate;

    /**
     * 切入点定义：指明要在什么样的条件下才能被触发
     * @Pointcut注解表达式, 通过特定的规则来筛选连接点, 就是Pointcut，选中那几个你想要的方法
     * @annotation：条件：当执行的方法上拥有指定的注解时生效
     */
    @Pointcut("@annotation(com.example.demo.annotation.RepeatSubmit)")
    public void pointCut() {
    }

    /**
     * 环绕通知，围绕着方法执行
     * @param pjp
     * @return
     */
    @Around("pointCut()")
    public Object around(ProceedingJoinPoint pjp) {
        try {
            ServletRequestAttributes attributes = (ServletRequestAttributes) RequestContextHolder.getRequestAttributes();
            String sessionId = Objects.requireNonNull(RequestContextHolder.getRequestAttributes()).getSessionId();
            assert attributes != null;
            MethodSignature signature = (MethodSignature) pjp.getSignature();
            // 被拦截的方法
            Method method = signature.getMethod();
            // 注解信息
            RepeatSubmit repeatSubmit = method.getAnnotation(RepeatSubmit.class);
            HttpServletRequest request = attributes.getRequest();
            String key = sessionId + "-" + request.getServletPath();
            // 如果缓存中有这个url视为重复提交
            if (redisTemplate.opsForValue().get(key) == null) {
                Object o = pjp.proceed();
                redisTemplate.opsForValue().set(key, request.getRequestURI());
                logger.info("请求的sessionId：" + key + "，请求URI：" + request.getRequestURI());
                redisTemplate.expire(key, repeatSubmit.lockedTime(), repeatSubmit.timeUnit());
                return o;
            } else {
                logger.error("重复提交");
                return "请勿短时间内重复操作";
            }
        } catch (Throwable e) {
            e.printStackTrace();
            logger.error("验证重复提交时出现未知异常!");
            return "验证重复提交时出现未知异常!";
        }
    }
}

创建测试接口

/**
 * 防重复提交测试接口
 *
 * @author xy
 * @date 2024-06-05
 */
@RestController
@RequestMapping(path = "/repeatSubmit")
public class TestController {

    @RequestMapping("/test")
    @RepeatSubmit(lockedTime = 5, timeUnit = TimeUnit.SECONDS)
    public String test() {
        return "提交成功";
    }
}

访问接口测试

/**
 * 防重复提交测试接口
 *
 * @author xy
 * @date 2024-06-05
 */
@RestController
@RequestMapping(path = "/repeatSubmit")
public class TestController {

    @RequestMapping("/test")
    @RepeatSubmit(lockedTime = 5, timeUnit = TimeUnit.SECONDS)
    public String test() {
        return "提交成功";
    }
}

访问接口测试

第一次访问：

2024-06-21 17:16:15.932  INFO 3392 --- [nio-8080-exec-8] c.e.demo.aspect.RepeatSubmitAspect  : 请求的sessionId：C26CD582FD3ACFF4B6C18EFCD39DD444，请求URI：/repeatSubmit/test
2024-06-21 17:16:17.044 ERROR 3392 --- [nio-8080-exec-9] c.e.demo.aspect.RepeatSubmitAspect  : 重复提交
2024-06-21 17:16:18.677 ERROR 3392 --- [io-8080-exec-10] c.e.demo.aspect.RepeatSubmitAspect  : 重复提交
2024-06-21 17:16:19.385 ERROR 3392 --- [nio-8080-exec-1] c.e.demo.aspect.RepeatSubmitAspect  : 重复提交
2024-06-21 17:16:19.937 ERROR 3392 --- [nio-8080-exec-2] c.e.demo.aspect.RepeatSubmitAspect  : 重复提交
2024-06-21 17:16:20.586 ERROR 3392 --- [nio-8080-exec-3] c.e.demo.aspect.RepeatSubmitAspect  : 重复提交
2024-06-21 17:16:21.162  INFO 3392 --- [nio-8080-exec-4] c.e.demo.aspect.RepeatSubmitAspect  : 请求的sessionId：C26CD582FD3ACFF4B6C18EFCD39DD444，请求URI：/repeatSubmit/test

连续快速访问：

控制台输出如下：

2024-06-21:17:15.932  INFO 3392 --- [nio-8080-exec-8] c.e.demo.aspect.RepeatSubmitAspect  : 请求的sessionId：C26CD582FD3ACFF4B6C18EFCD39DD444，请求URI：/repeatSubmit/test
2024-06-21:17:16:17.044 ERROR 3392 --- [nio-8080-exec-9] c.e.demo.aspect.RepeatSubmitAspect  : 重复提交
2024-06-21:17:16:18.677 ERROR 3392 --- [io-8080-exec-10] c.e.demo.aspect.RepeatSubmitAspect  : 重复提交
2024-06-21:17:16:19.385 ERROR 3392 --- [nio-8080-exec-1] c.e.demo.aspect.RepeatSubmitAspect  : 重复提交
2024-06-21:17:16:19.937 ERROR 3392 --- [nio-8080-exec-2] c.e.demo.aspect.RepeatSubmitAspect  : 重复提交
2024-06-21:17:16:20.586 ERROR 3392 --- [nio-8080-exec-3] c.e.demo.aspect.RepeatSubmitAspect  : 重复提交
2024-06-21:17:16:21.162  INFO 3392 --- [nio-8080-exec-4] c.e.demo.aspect.RepeatSubmitAspect  : 请求的sessionId：C26CD582FD3ACFF4B6C18EFCD39DD444，请求URI：/repeatSubmit/test

17:16:15.932第一次请求成功

请求失败N次...

5秒后，17:16:21.162第二次请求成功

missterzy

关注

8
点赞
踩
10

收藏

觉得还不错? 一键收藏
打赏
0
评论
SpringBoot+AOP+Redis自定义注解实现防重复提交

*** 防重复提交切面类*/@Aspect@Component@Resource/*** 切入点定义：指明要在什么样的条件下才能被触发* @Pointcut注解表达式, 通过特定的规则来筛选连接点, 就是Pointcut，选中那几个你想要的方法* @annotation：条件：当执行的方法上拥有指定的注解时生效*//*** 环绕通知，围绕着方法执行* @return*/try {= null;// 被拦截的方法// 注解信息。
复制链接

扫一扫