1. 程式人生 > >springmvc 防止表單重複提交

springmvc 防止表單重複提交

      在網上查看了很多關於springmvc防止表單重複提交的例子,將其中的3個整合在一起,才算是一個完整的例子。因專案中暫時還沒有這麼個需求,特備註下來,以防以後用到時還要大量的漫無目的的去尋找例子。

實現原理為SpringMvc攔截器+註解的方式實現防止重複提交

實現機制是使用token(隨機碼),簡單說下:

(a)進入下單頁,會生成一個token,同時存在兩個地方:session(或redis也可以)和頁面

(b)提交時,伺服器接收到頁面的token後,會和session中的token比較,相同則允許提交,同時刪除session中的token;

(c)如果重複提交,則session中已經沒有token(已被步驟b刪除),那麼校驗不通過,則不會真正提交.

先建立一個註解:

package com.dinfo.interceptor;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

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

    boolean save() default false;
    boolean remove() default false;

}

攔截器介面:

package com.dinfo.interceptor;

import java.lang.reflect.Method;
import java.util.UUID;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.log4j.Logger;
import org.springframework.web.method.HandlerMethod;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;


public class TokenInterceptor extends HandlerInterceptorAdapter {
    private static final Logger LOG = Logger.getLogger(Token.class);
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        if (handler instanceof HandlerMethod) {
            HandlerMethod handlerMethod = (HandlerMethod) handler;
            Method method = handlerMethod.getMethod();
            Token annotation = method.getAnnotation(Token.class);
            if (annotation != null) {
                boolean needSaveSession = annotation.save();
                if (needSaveSession) {
                    request.getSession(true).setAttribute("token", UUID.randomUUID().toString());
                }
                boolean needRemoveSession = annotation.remove();
                if (needRemoveSession) {
                    if (isRepeatSubmit(request)) {
                         LOG.warn("please don't repeat submit,url:"+ request.getServletPath());
                        return false;
                    }
                    request.getSession(true).removeAttribute("token");
                }
            }
            return true;
        } else {
            return super.preHandle(request, response, handler);
        }
    }

    private boolean isRepeatSubmit(HttpServletRequest request) {
        String serverToken = (String) request.getSession(true).getAttribute("token");
        if (serverToken == null) {
            return true;
        }
        String clinetToken = request.getParameter("token");
        if (clinetToken == null) {
            return true;
        }
        if (!serverToken.equals(clinetToken)) {
            return true;
        }
        return false;
    }

}

配置檔案如下:

<!-- 攔截器配置 -->
<mvc:interceptors>
        <!-- 配置Token攔截器,防止使用者重複提交資料 -->
        <mvc:interceptor>
            <mvc:mapping path="/**"/><!--這個地方時你要攔截得路徑 我這個意思是攔截所有得URL-->
            <bean class="com.dinfo.interceptor.TokenInterceptor"/><!--class檔案路徑改成你自己寫得攔截器路徑!! -->
        </mvc:interceptor>

</mvc:interceptors>

頁面表單中需要新增如下:<input type="hidden" name="token" value="${token}" />

在需要生成token(通常是要點選提交得那個頁面)得Controller中使用我們剛才自定義好得註解,貼程式碼:

@SuppressWarnings({ "unchecked", "finally", "rawtypes" })
    @RequestMapping("/SaveDataController/show")
    @Token(save=true)
    public String saveData(HttpServletRequest request,HttpServletResponse response,String task_id){
        
        Map map = new HashMap();
        System.out.println(task_id);
        try {
            map = saveDataService.queryByTaskId(task_id);
        } catch (Exception e) {
            e.printStackTrace();
            map.put("task_id", task_id);
            map.put("savetype", "");
            map.put("memoryCodes", "1");
            map.put("tablename", "");
            map.put("trowkey", "");
            map.put("columns", "");
            map.put("indextablename", "");
            map.put("irowkey", "");
            map.put("icolumns", "");
        } finally {
            request.setAttribute("map", map);
            return "savedata/index";
        }

    }

只要通過這個方法跳向得頁面都是隨機生成一個token,然後再真正再提交觸發得方法上加入@token(remove=true),貼程式碼:

@RequestMapping("/SaveDataController/saveData")
    @ResponseBody
    @Token(remove=true)
    public void saveData(HttpServletRequest request,HttpServletResponse response,
                         String tablename,String trowkey,String columns,
                         String indextablename,String irowkey,String icolumns,
                         String task_id,String savetype,String memoryCodes){
        System.out.println(task_id);
        saveDataService.saveData(task_id,savetype,memoryCodes,tablename, trowkey, columns, indextablename, irowkey, icolumns);

    }

上面的只能防止單頁面的重複提交,如果同時開啟兩個頁面同時進行提交,則第二次提交總是失敗,需要進行再次擴充套件,具體方法如下:

但是--

如果開啟兩個標籤頁,則這兩個頁面分別有一個token,並且是不同的(理論上是不同的),但是session中只有一份,

其中一個提交後,就會刪除session中的token,那麼另外一個頁面提交時session中的token已為空,那麼一定校驗不通過.

根本原因:

在同一時刻,session中只存了一份token,而頁面上可能有多個token(有n個頁籤,就會有n個不同的token).

既然找到了根本原因,那麼也就自然而然產生了解決方案.

思路:session中不能只儲存一份token,而是支援儲存多個token

具體技術方案:

(1)每次進入下單頁都會產生一個新的token,這個token都進入兩個資料流:

--(a)傳到頁面,key是repeattoken

前端頁面引用方式:

Html程式碼  
  1. <input type="hidden" name="repeattoken" value="${Session.repeattoken!}" >  

--(b)儲存到session(現在是增量,不會把原來的token替換掉)

(2)儲存到session中的key應該與頁面的key區分開來,使用"tokenpool"

優化之後的過濾器:

Java程式碼  收藏程式碼
  1. package com.chanjet.gov.filter;  
  2. import com.chanjet.gov.util.StringUtil;  
  3. import org.apache.log4j.Logger;  
  4. import org.springframework.web.method.HandlerMethod;  
  5. import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;  
  6. import javax.servlet.http.HttpServletRequest;  
  7. import javax.servlet.http.HttpServletResponse;  
  8. import javax.servlet.http.HttpSession;  
  9. import java.lang.reflect.Method;  
  10. import java.util.UUID;  
  11. /** 
  12.  *     防止下單頁重複提交 
  13.  */  
  14. public class RepeatTokenInterceptor  extends HandlerInterceptorAdapter {  
  15.     /*** 
  16.      * 用於前端頁面接收伺服器端的token 
  17.      */  
  18.     public static final String SESSION_KEY_REPEATTOKEN="repeattoken";  
  19.     /*** 
  20.      * 用於session儲存n個token 
  21.      */  
  22.     public static final String SESSION_KEY_REPEATTOKEN_POOL = "tokenpool";  
  23.     private static Logger log = Logger.getLogger(RepeatTokenInterceptor.class);  
  24.     private void addRepeatToken(HttpServletRequest request, HttpServletResponse response){  
  25.         HttpSession httpSession = request.getSession(true);  
  26.         String token = (String) httpSession.getAttribute(SESSION_KEY_REPEATTOKEN_POOL);  
  27.         System.out.println("addRepeatToken token:"+token);  
  28.         String createdToken = UUID.randomUUID().toString();  
  29.         httpSession.setAttribute(SESSION_KEY_REPEATTOKEN, createdToken);//給前端頁面用的  
  30.         if(StringUtil.isNullOrEmpty(token)){  
  31.             httpSession.setAttribute(SESSION_KEY_REPEATTOKEN_POOL, createdToken);  
  32.         }else{  
  33.             httpSession.setAttribute(SESSION_KEY_REPEATTOKEN_POOL, createdToken + "###" + token);  
  34.         }  
  35.     }  
  36.     private void removeRepeatToken(HttpServletRequest request, HttpServletResponse response){  
  37.         HttpSession httpSession = request.getSession(true);  
  38.         String token = (String) httpSession.getAttribute(SESSION_KEY_REPEATTOKEN_POOL);  
  39.         System.out.println("removeRepeatToken token:"+token);  
  40.         if(!StringUtil.isNullOrEmpty(token)){  
  41.             String clientToken = (String) request.getParameter(SESSION_KEY_REPEATTOKEN);  
  42.             System.out.println("removeRepeatToken serverToken:"+clientToken);  
  43.             if (clientToken == null) {  
  44.                 return;  
  45.             }  
  46.             token = token.replace(clientToken, "").replace("######""###");  
  47.             System.out.println("token:"+token);  
  48.             httpSession.setAttribute(SESSION_KEY_REPEATTOKEN_POOL, token);  
  49.         }  
  50.     }  
  51.     @Override  
  52.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {  
  53.         if (handler instanceof HandlerMethod) {  
  54.             HandlerMethod handlerMethod = (HandlerMethod) handler;  
  55.             Method method = handlerMethod.getMethod();  
  56.             RepeatSubmitToken annotation = method.getAnnotation(RepeatSubmitToken.class);  
  57.             if (annotation != null) {  
  58.                 boolean needSaveSession = annotation.save();  
  59.                 if (needSaveSession) {  
  60.                     addRepeatToken(request,response);  
  61.                 }  
  62.                 boolean needRemoveSession = annotation.remove();  
  63.                 if (needRemoveSession) {  
  64.                     if (isRepeatSubmit(request)) {  
  65.                         log.warn("please don't repeat submit,url:" + request.getServletPath());  
  66.                         response.sendRedirect("/warn.html?code=repeatSubmitOrder&orgId="+request.getParameter("orgId"));  
  67.                         return false;  
  68.                     }  
  69.                     removeRepeatToken(request,response);  
  70.                 }  
  71.             }  
  72.             return true;  
  73.         } else {  
  74.             return super.preHandle(request, response, handler);  
  75.         }  
  76.     }  
  77.     private boolean isRepeatSubmit(HttpServletRequest request) {  
  78.         //從池子裡面獲取token  
  79.         String serverToken = (String) request.getSession(true).getAttribute(SESSION_KEY_REPEATTOKEN_POOL);  
  80.         if (serverToken == null||"###".equals(serverToken)) {  
  81.             return true;  
  82.         }  
  83.         String clinetToken = request.getParameter(SESSION_KEY_REPEATTOKEN);//請求要素  
  84.         if (StringUtil.isNullOrEmpty(clinetToken)) {  
  85.             return true;  
  86.         }  
  87.         System.out.println("clinetToken:"+clinetToken);  
  88.         if (!serverToken.contains(clinetToken)) {  
  89.             return true;  
  90.         }  
  91.         return false;  
  92.     }  
  93. }