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"; } } }