SpringMVC 中的Interceptor 攔截器

SpringMVC 中的Interceptor 攔截器

 

一. 使用場景

　　　　1、日誌記錄：記錄請求信息的日誌，以便進行信息監控、信息統計、計算PV（Page View）等。

　　　　2、權限檢查：如登錄檢測，進入處理器檢測檢測是否登錄，如果沒有直接返回到登錄頁面；

　　　　3、性能監控：有時候系統在某段時間莫名其妙的慢，可以通過攔截器在進入處理器之前記錄開始時間，在處理完後記錄結束時間，從而得到該請求的處理時間（如果有反向代理，如apache可以自動記錄）；

　　　　4、通用行爲：讀取cookie得到用戶信息並將用戶對象放入請求，從而方便後續流程使用，還有如提取Locale、Theme信息等，只要是多個處理器都需要的即可使用攔截器實現。

　　　　5、OpenSessionInView：如Hibernate，在進入處理器打開Session，在完成後關閉Session。

       本質也是AOP（面向切面編程），也就是說符合橫切關注點的所有功能都可以放入攔截器實現。

 

二. 攔截器接口

 

 public interface HandlerInterceptor {  
    boolean preHandle(  
            HttpServletRequest request, HttpServletResponse response,   
            Object handler)   
            throws Exception;  
  
    void postHandle(  
            HttpServletRequest request, HttpServletResponse response,   
            Object handler, ModelAndView modelAndView)   
            throws Exception;  
  
    void afterCompletion(  
            HttpServletRequest request, HttpServletResponse response,   
            Object handler, Exception ex)  
            throws Exception;  
    }

 

preHandle

HttpServletRequest request, HttpServletResponse response, Object handle

預處理回調方法，實現處理器的預處理（如登錄檢查），第三個參數爲響應的處理器；

該方法將在請求處理之前進行調用。SpringMVC 中的Interceptor 是鏈式的調用的，在一個應用中或者說是在一個請求中可以同時存在多個Interceptor 。每個Interceptor 的調用會依據它的聲明順序依次執行，而且最先執行的都是Interceptor 中的preHandle 方法，所以可以在這個方法中進行一些前置初始化操作或者是對當前請求的一個預處理，也可以在這個方法中進行一些判斷來決定請求是否要繼續進行下去。

該方法的返回值是布爾值Boolean 類型的，

當返回值爲false 時，表示請求結束，後續的Interceptor 和Controller 都不會再執行，此時我們需要通過response來產生響應；

當返回值爲true 時就會繼續調用下一個Interceptor 的preHandle 方法，如果已經是最後一個Interceptor 的時候就會是調用當前請求的Controller 方法。

 

postHandle

HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView

後處理回調方法，實現處理器的後處理（但在渲染視圖之前），此時我們可以通過modelAndView（模型和視圖對象）對模型數據進行處理或對視圖進行處理，modelAndView也可能爲null。顧名思義就是在當前請求進行處理之後，也就是Controller 方法調用之後執行，但是它會在DispatcherServlet 進行視圖返回渲染之前被調用，所以我們可以在這個方法中對Controller 處理之後的ModelAndView 對象進行操作。postHandle 方法被調用的方向跟preHandle 是相反的，也就是說先聲明的Interceptor 的postHandle 方法反而會後執行，這和Struts2 裏面的Interceptor 的執行過程有點類型。Struts2 裏面的Interceptor 的執行過程也是鏈式的，只是在Struts2 裏面需要手動調用ActionInvocation 的invoke 方法來觸發對下一個Interceptor 或者是Action 的調用，然後每一個Interceptor 中在invoke 方法調用之前的內容都是按照聲明順序執行的，而invoke 方法之後的內容就是反向的。

 

afterCompletion

HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex

整個請求處理完畢回調方法，即在視圖渲染完畢時回調，如性能監控中我們可以在此記錄結束時間並輸出消耗時間，還可以進行一些資源清理，類似於try-catch-finally中的finally，但僅調用處理器執行鏈中preHandle返回true的攔截器的afterCompletion。該方法也是需要當前對應的Interceptor 的preHandle 方法的返回值爲true 時纔會執行。該方法將在整個請求結束之後，也就是在DispatcherServlet 渲染了對應的視圖之後執行。這個方法的主要作用是用於進行資源清理工作的。

 

三. 自定義攔截器模擬一個用戶是否登錄實例。

1. 在beans.xml中加入

 <!-- èªå®ä¹æ¦æªå¨ -->
    <mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**">
            <bean class="com.haut.phonemanage.interceptor.LoginInterceptor"></bean>
        </mvc:mapping></mvc:interceptor>
    </mvc:interceptors>

2、LoginInterceptor

 public class LoginInterceptor implements HandlerInterceptor {

    @Override
    public void afterCompletion(HttpServletRequest request,
            HttpServletResponse response, Object handler, Exception exception)
            throws Exception {
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response,
            Object handler, ModelAndView view) throws Exception {
    }

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
            Object handler) throws Exception {
        final String ENC = "UTF-8";
        String fullPath = request.getRequestURI();
        String queryString = request.getQueryString();
        String contextPath = request.getContextPath();
        String controllerPath = fullPath.replace(contextPath, "");
        
        HttpSession session = request.getSession();
        Object account = session.getAttribute("account");
        
        if(queryString != null && !queryString.trim().equals("")) {
            queryString = "?" + queryString;
        }
        
        if(!controllerPath.startsWith("/passport") && account == null) {
            response.sendRedirect(contextPath + "/passport?path=" + URLEncoder.encode(contextPath + controllerPath + queryString, ENC));
        }
        return true;
    }
}