Java后台防止客户端重复请求、提交表单

前言

在Web / App项目中，有一些请求或操作会对数据产生影响（比如新增、删除、修改），针对这类请求一般都需要做一些保护，以防止用户有意或无意的重复发起这样的请求导致的数据错乱。

常见处理方案

1.客户端

　　例如表单提交后将提交按钮设为disable 等等方法...

2.服务端

　　前端的限制仅能解决少部分问题，且不够彻底，后端自有的防重复处理措施必不可少，义不容辞。

　　在此提供一个我在项目中用到的方案。简单来说就是判断请求url和数据是否和上一次相同。

方法步骤

1.主要逻辑：

　　给所有的url加一个拦截器，每次请求将url存入session，下次请求验证url数据是否相同，相同则拒绝访问。

　　当然，我在此基础上做了一些优化，比如：

　　　　使用session有局限性，用户量大了以后服务器会撑不住，在此我使用了redis来替换。

　　　　加入了token令牌机制。

2.实现步骤：

• 2.1自定义一个注解

• /**
   * @Title: SameUrlData
   * @Description: 自定义注解防止表单重复提交
   * @Auther: xhq
   * @Version: 1.0
   * @create 2019/3/26 10:43
   */
  @Inherited
  @Target(ElementType.METHOD)
  @Retention(RetentionPolicy.RUNTIME)
  @Documented
  public @interface SameUrlData {
  
  }

• 2.2自定义拦截器类
  • 检查此接口调用的方法是否使用了SameUrlData注解，若没有使用，表示此接口不需要校验；
  • 若使用了注解，获取请求url+参数，并去除一直在变化的参数(比如时间戳timeStamp和签名sign)
  • 检查参数中是否有token参数（token代表不同的用户的唯一标识），没有直接放行
  • 有token参数，将token+url作为redis的key，url+参数作为value存入redis，并设定自动销毁时间
  • （此处如果项目中没有redis，可参照我的另外一篇博客可解决：https://www.cnblogs.com/xhq1024/p/11115755.html）
  • 再次访问进行验证是否重复请求　　

• import com.alibaba.fastjson.JSONObject;
  import com.tuohang.hydra.framework.common.spring.SpringKit;
  import com.tuohang.hydra.toolkit.basis.string.StringKit;
  import org.slf4j.Logger;
  import org.slf4j.LoggerFactory;
  import org.springframework.data.redis.core.StringRedisTemplate;
  import org.springframework.stereotype.Component;
  import org.springframework.web.method.HandlerMethod;
  import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
  
  import javax.servlet.http.HttpServletRequest;
  import javax.servlet.http.HttpServletResponse;
  import java.lang.reflect.Method;
  import java.util.HashMap;
  import java.util.Iterator;
  import java.util.Map;
  import java.util.concurrent.TimeUnit;
  
  /**
   * @Title: 防止用户重复提交数据拦截器
   * @Description: 将用户访问的url和参数结合token存入redis，每次访问进行验证是否重复请求接口
   * @Auther: xhq
   * @Version: 1.0
   * @create 2019/3/26 10:35
   */
  @Component
  public class SameUrlDataInterceptor extends HandlerInterceptorAdapter {
  
      private static Logger LOG = LoggerFactory.getLogger(SameUrlDataInterceptor.class);
  
      /**
       * 是否阻止提交,fasle阻止,true放行
       * @return
       */
      @Override
      public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
          if (handler instanceof HandlerMethod) {
              HandlerMethod handlerMethod = (HandlerMethod) handler;
              Method method = handlerMethod.getMethod();
              SameUrlData annotation = method.getAnnotation(SameUrlData.class);
              if (annotation != null) {
                  if(repeatDataValidator(request)){
                      //请求数据相同
                      LOG.warn("please don't repeat submit,url:"+ request.getServletPath());
                      JSONObject result = new JSONObject();
                      result.put("statusCode","500");
                      result.put("message","请勿重复请求");
                      response.setCharacterEncoding("UTF-8");
                      response.setContentType("application/json; charset=utf-8");
                      response.getWriter().write(result.toString());
                      response.getWriter().close();
  //                    拦截之后跳转页面
  //                    String formRequest = request.getRequestURI();
  //                    request.setAttribute("myurl", formRequest);
  //                    request.getRequestDispatcher("/WebRoot/common/error/jsp/error_message.jsp").forward(request, response);
                      return false;
                  }else {//如果不是重复相同数据
                      return true;
                  }
              }
              return true;
          } else {
              return super.preHandle(request, response, handler);
          }
      }
      /**
       * 验证同一个url数据是否相同提交,相同返回true
       * @param httpServletRequest
       * @return
       */
      public boolean repeatDataValidator(HttpServletRequest httpServletRequest){
          //获取请求参数map
          Map<String, String[]> parameterMap = httpServletRequest.getParameterMap();
          Iterator<Map.Entry<String, String[]>> it = parameterMap.entrySet().iterator();
          String token = "";
          Map<String, String[]> parameterMapNew = new HashMap<>();
          while(it.hasNext()){
              Map.Entry<String, String[]> entry = it.next();
              if(!entry.getKey().equals("timeStamp") && !entry.getKey().equals("sign")){
                  //去除sign和timeStamp这两个参数，因为这两个参数一直在变化
                  parameterMapNew.put(entry.getKey(), entry.getValue());
                  if(entry.getKey().equals("token")) {
                      token = entry.getValue()[0];
                  }
              }
          }
          if (StringKit.isBlank(token)){
              //如果没有token，直接放行
              return false;
          }
          //过滤过后的请求内容
          String params = JSONObject.toJSONString(parameterMapNew);
  
          System.out.println("params==========="+params);
  
          String url = httpServletRequest.getRequestURI();
          Map<String,String> map = new HashMap<>();
          //key为接口，value为参数
          map.put(url, params);
          String nowUrlParams = map.toString();
  
          StringRedisTemplate smsRedisTemplate = SpringKit.getBean(StringRedisTemplate.class);
          String redisKey = token + url;
          String preUrlParams = smsRedisTemplate.opsForValue().get(redisKey);
          if(preUrlParams == null){
              //如果上一个数据为null,表示还没有访问页面
              //存放并且设置有效期，2秒
              smsRedisTemplate.opsForValue().set(redisKey, nowUrlParams, 2, TimeUnit.SECONDS);
              return false;
          }else{//否则，已经访问过页面
              if(preUrlParams.equals(nowUrlParams)){
                  //如果上次url+数据和本次url+数据相同，则表示重复添加数据
                  return true;
              }else{//如果上次 url+数据 和本次url加数据不同，则不是重复提交
                  smsRedisTemplate.opsForValue().set(redisKey, nowUrlParams, 1, TimeUnit.SECONDS);
                  return false;
              }
          }
      }
  }

• 2.3注册拦截器
  

  @Configuration
  public class WebMvcConfigExt extends WebMvcConfig {
  
      /**
       * 防止重复提交拦截器
       */
      @Autowired
      private SameUrlDataInterceptor sameUrlDataInterceptor;
  
      @Override
      public void addInterceptors(InterceptorRegistry registry) {
          // 避开静态资源
          List<String> resourcePaths = defineResourcePaths();
          registry.addInterceptor(sameUrlDataInterceptor).addPathPatterns("/**").excludePathPatterns(resourcePaths);// 重复请求
      }
  
      /**
       * 自定义静态资源路径
       * 
       * @return
       */
      @Override
      public List<String> defineResourcePaths() {
          List<String> patterns = new ArrayList<>();
          patterns.add("/assets/**");
          patterns.add("/upload/**");
          patterns.add("/static/**");
          patterns.add("/common/**");
          patterns.add("/error");
          return patterns;
      }
  }

• 在相应方法上加@SameUrlData注解

  @SameUrlData
  @ResponseBody
  @RequestMapping(value = "/saveOrUpdate")
  public String saveOrUpdate(){
  }