防重复提交实现方案

在WEB系统操作中，往往会出现用户连续重复点击一个按钮导致重复提交，后台程序的同一个接口代码往往上一个请求还没执行完，下一个请求就到达了，而这两个请求又是请求和操作的同一条数据，就会出现业务上的逻辑错误，往往结果不可预料；

要解决重复提交带来的问题的解决方案有多种，不如网上有很多介绍怎么通过前端页面控制来解决重复提交，当然还有其他方式，这里我采用了通过后台程序代码利用redis做分布式锁的方式来防止重复提交，其思路就是在进入一个后端接口执行前先获取一个分布式锁，如果获取成功则上锁，然后执行业务代码，执行完成后再释放分布式锁；如果获取锁失败则可以认为是重复提交的请求，可以将此请求丢弃掉，其流程图如下：

这里有几个关键点：

1）分布式锁：实现分布式锁的方式也有很多种，这里采用redis来实现；

2）注解方式实现：如果在每个接口的前后都加上一堆防止重复提交的代码无疑是非常糟糕的，代码冗余繁琐不说，而且非常不利于代码的扩展和维护，所以如果能通过一个自定义注解实现防重复提交的控制，只在需要控制重复提交的接口上加上这个注解，这样的代码无疑是非常清爽和好维护的；

另外在实现注解时一般可以使用AOP技术和拦截器技术来实现，但是我个人更喜欢用拦截器来实现，这里我就以拦截器的方式来实现；下面给出关键代码：

1、注解的定义：

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface NoRepeatSubmit {
}

2、拦截器的实现：

private static final RedisCacheUtils redis = RedisCacheUtils.getInstance(RedisConfigEnum.USER_REPEATSUBMIT_LOCK);

@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    HandlerMethod handlerMethod = (HandlerMethod) handler;
    Class<?> clazz = handlerMethod.getBeanType();
    Method method = handlerMethod.getMethod();
    if (method.isAnnotationPresent(NoRepeatSubmit.class)) {
        /** 获取token */
        String token = getToken(request, clazz.getName(), method.getName());
        if (StringUtils.isBlank(token)) {
            //token未能获取到，则按照默认处理，并记录日志
            LOGGER.error("{}.{} 未获取到token", clazz.getName(), method.getName());
            return true;
        }

        LOGGER.info("请求URL：{}", request.getRequestURL());
        if (!lockToken(token)) {
            //重复提交，丢弃处理并记录日志
            LOGGER.error("{}.{} 重复提交", clazz.getName(), method.getName());
            return false;
        }
    }

    return true;
}

@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    HandlerMethod handlerMethod = (HandlerMethod) handler;
    Class<?> clazz = handlerMethod.getBeanType();
    Method method = handlerMethod.getMethod();
    if (method.isAnnotationPresent(NoRepeatSubmit.class)) {
        String token = getToken(request, clazz.getName(), method.getName());
        if (StringUtils.isNotBlank(token)) {
            LOGGER.info("请求URL处理完成：{}", request.getRequestURL());
            unLockToken(token);
        }
    }
}

/**
 * 从request中读取出token
 *
 * @param request
 * @return
 */
private String getToken(HttpServletRequest request, String className, String methodName) {
    if (request.getCookies() != null) {
        for (Cookie cookie: request.getCookies()) {
            if (StringUtils.equalsIgnoreCase(cookie.getName(), TOKEN_KEY)) {
                String cookieToken = cookie.getValue();

                return String.format("%s.%s.%s", className, methodName, cookieToken);
            }
        }
    }

    return null;
}

/**
 * 给token上锁
 *
 * @param token
 */
private boolean lockToken(String token) {
    return redis.setIfAbsent(token, System.currentTimeMillis() + token);
}

/**
 * 释放token上的锁
 *
 * @param token
 */
private void unLockToken(String token) {
    redis.delete(token);
}

3、在web.xml中定义拦截器：

<mvc:interceptors>    
    <bean class="*.*.*.common.Interceptor.RepeatSubmitInterceptor" />
</mvc:interceptors>

4、在接口方法上添加注解：

@RequestMapping(value = "/test.do_",method = {RequestMethod.POST})
@ResponseBody
@NoRepeatSubmit
public Result<JSONObject> testFunc(){
    //......业务代码实现.......
}