SpringBoot项目中防止表单重复提交的两种方法(自定义注解解决API接口幂等设计和重定向)

本文涉及的产品
云数据库 Redis 版,社区版 2GB
推荐场景:
搭建游戏排行榜
简介: SpringBoot项目中防止表单重复提交的两种方法(自定义注解解决API接口幂等设计和重定向)

1,什么是幂等?

用户对于同一操作发起的一次请求或者多次请求的结果是一致的。

2,场景

比如添加用户的接口,在提交时由于网络波动或其他原因没有及时响应,用户可能会误以为没有点到提交按钮,会再次进行提交或连续点击提交按钮,这就会导致同一用户在数据库中保存了好几条,这当然是不符合我们预期的。

3,实现原理:

  • 自定义防止重复提交标记(@RepeatSubmit)。
  • 对需要防止重复提交的Congtroller里的mapping方法加上该注解。
  • 新增Aspect切入点,为@RepeatSubmitAspect加入切入点。
  • 每次提交表单时,Aspect都会保存当前key到reids(须设置过期时间)。
  • 重复提交时Aspect会判断当前redis是否有该key,若有则拦截。

3,AOP拦截

@Aspect
@Component
public class NoRepeatAspect {
    @Resource
    private RedisTemplate<String, Object> redisTemplate;
    @Pointcut("@annotation(com.sunline.project.aop.NoRepeat) || @within(com.sunline.project.aop.NoRepeat)")
    public void pointCut(){}
    @Around("pointCut()")
    private Object around(ProceedingJoinPoint point) {
        try {
            // 获取当前用户的token
            Subject currStaff = SecurityUtils.getSubject();
            UserVo user = (UserVo) currStaff.getPrincipal();
            
            String token = user.getToken();
            StaticLog.info("检测是否重复提交");
            StaticLog.info("point:{}", point);
            // 获取当前请求的方法名
            MethodSignature signature = (MethodSignature) point.getSignature();
            Method method = signature.getMethod();
            String name = method.getName();
            StaticLog.info("token:{},======methodName:{}", token, name);
            if (redisTemplate.hasKey(token+name)) {
                StaticLog.error("监测到重复提交>>>>>>>>>>");
                return ResponseData.fail(ResponseCode.FAIL_CODE, "请勿重复提交");
            }
            // 获取注解
            NoRepeat annotation = method.getAnnotation(NoRepeat.class);
            Long timeout = annotation.timeOut();
            // 此处我用token和请求方法名为key存入redis中,有效期为timeout 时间, 也可以使用ip地址做为key
            redisTemplate.opsForValue().set(token+name, token+name, timeout, TimeUnit.SECONDS);
            return point.proceed();
        } catch (Throwable throwable) {
            StaticLog.error("=====>>>>>>操作失败:{}", throwable);
            return ResponseData.fail(ResponseCode.FAIL_CODE, "操作失败");
        }
    }
}

4,加注解

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface NoRepeat {
    // 默认失效时间
    long timeOut() default 10;
}

5,测试:

@NoRepeat(timeOut = 5)

timeOut默认时间为10s

@NoRepeat(timeOut = 5)
    @GetMapping(value = "/test")
    @ApiOperation(value = "测试幂等注解")
    @SysLogs("测试幂等注解")
    @ApiImplicitParam(paramType = "header", name = "Authorization", value = "身份认证Token")
    public ResponseData<T> testIdempotent() {
        try {
            System.err.println(new Date());
            return ResponseData.ok(ResponseCode.SUCCESS_CODE, "操作成功");
        } catch (Exception e) {
            StaticLog.error("操作失败:{}", e);
            return ResponseData.ok(ResponseCode.FAIL_CODE, "操作失败");
        }
    }

6,重定向方法

  • 问题提出:
    造成表单重复提交的原因是当我们刷新浏览器的时候,浏览器会发送上一次提交的请求。由于上一次提交的请求方式为post,刷新浏览器就会重新发送这个post请求,造成表单重复提交。
  • 解决办法:

将请求当前页面的方式由请求转发改为重定向到当前页面即可。

  • 举例:

编写一个处理登录请求的controller,登录成功就转到dashboard.html,登录失败则跳转到登录页面login.html重新登录。

注:dashboard.html和login.htm都是templates包下的。

@Controller
public class LoginController {
    @PostMapping("/user/login")
    public String login(@RequestParam("username") String username,
                        @RequestParam("password") String password,
                        Map<String,Object> map
    ){
        if (StringUtils.isEmpty(username) && "123456".equals(password)){
            return "dashboard";
        }else {
            map.put("msg","用户名或密码错误");
            return "login";
        }
    }
}

上边这段代码是不正确的,会造成表单重复提交。

当我们输入正确账号密码时就会return “dashboard”;就会经过视图解析器转发到了dashboard.html页面,这样当我们浏览器中刷新是就会造成重复提交。

所以我们不能return “dashboard”,而要重定向到dashboard.html。

注意:重定向到templates包下的资源要经过视图解析器处理,而重定向默认是不会经过视图解析器的,所以我们要先编写一个视图映射。

编写视图映射:

@Configuration
public class MyMvcConfig implements WebMvcConfigurer{
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        registry.addViewController("/main.html").setViewName("dashboard");
    }
}

将转发修改为重定向:代码标红位置

@Controller
public class LoginController {
    @PostMapping("/user/login")
    public String login(@RequestParam("username") String username,
                        @RequestParam("password") String password,
                        Map<String,Object> map
    ){
        if (!StringUtils.isEmpty(username) && "123456".equals(password)){
            return "redirect:/main.html";
        }else {
            map.put("msg","用户名或密码错误");
            return "login";
        }
    }
}
相关实践学习
基于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
目录
相关文章
|
9天前
|
Java API 微服务
【Spring Boot系列】通过OpenAPI规范构建微服务服务接口
【4月更文挑战第5天】通过OpenAPI接口构建Spring Boot服务RestAPI接口
|
19天前
|
缓存 前端开发 API
API接口封装系列
API(Application Programming Interface)接口封装是将系统内部的功能封装成可复用的程序接口并向外部提供,以便其他系统调用和使用这些功能,通过这种方式实现系统之间的通信和协作。下面将介绍API接口封装的一些关键步骤和注意事项。
|
26天前
|
监控 前端开发 JavaScript
实战篇:商品API接口在跨平台销售中的有效运用与案例解析
随着电子商务的蓬勃发展,企业为了扩大市场覆盖面,经常需要在多个在线平台上展示和销售产品。然而,手工管理多个平台的库存、价格、商品描述等信息既耗时又容易出错。商品API接口在这一背景下显得尤为重要,它能够帮助企业在不同的销售平台之间实现商品信息的高效同步和管理。本文将通过具体的淘宝API接口使用案例,展示如何在跨平台销售中有效利用商品API接口,以及如何通过代码实现数据的统一管理。
|
26天前
|
NoSQL Java Redis
SpringBoot集成Redis解决表单重复提交接口幂等(亲测可用)
SpringBoot集成Redis解决表单重复提交接口幂等(亲测可用)
300 0
|
26天前
|
Java API Spring
SpringBoot项目调用HTTP接口5种方式你了解多少?
SpringBoot项目调用HTTP接口5种方式你了解多少?
80 2
|
3天前
|
缓存 Java Sentinel
Springboot 中使用 Redisson+AOP+自定义注解 实现访问限流与黑名单拦截
Springboot 中使用 Redisson+AOP+自定义注解 实现访问限流与黑名单拦截
|
2天前
|
前端开发 Java 测试技术
IDEA 版 API 接口神器来了,一键生成文档,贼香!
IDEA 版 API 接口神器来了,一键生成文档,贼香!
8 0
|
3天前
|
存储 缓存 NoSQL
Springboot中使用redisson + 自定义注解优雅的实现消息的发布订阅
Springboot中使用redisson + 自定义注解优雅的实现消息的发布订阅
|
3天前
|
API 开发者
邮件API接口使用的方法和步骤
AOKSEND指南:了解和使用邮件API接口,包括选择适合的接口(如AOKSEND、Mailgun、SMTP),获取访问权限,配置发件人、收件人及邮件内容,调用接口发送邮件,并处理返回结果,以高效集成邮件功能。
|
4天前
|
Java Maven Kotlin
[AIGC] 请你写一遍博客介绍 “使用idea+kotinlin+springboot+maven 结合开发一个简单的接口“,输出markdown格式,用中文回答,请尽可能详细
[AIGC] 请你写一遍博客介绍 “使用idea+kotinlin+springboot+maven 结合开发一个简单的接口“,输出markdown格式,用中文回答,请尽可能详细