處理器攔截器（HandlerInterceptor）詳解(轉)

簡介

SpringWebMVC的處理器攔截器，類似於Servlet開發中的過濾器Filter，用於處理器進行預處理和后處理。

應用場景

　　1、日志記錄，可以記錄請求信息的日志，以便進行信息監控、信息統計、計算PV（Page View）等等。
　　2、權限檢查：如登陸檢測，進入處理器檢測是否登陸，如果沒有直接返回到登陸頁面。
　　3、性能監控：有時候系統在某段時間莫名其妙的慢，可以通過攔截器在進入處理器之前記錄開始時間，在處理完后記錄結束時間，從而得到該請求的處理時間（如果有反向代理，如apache可以自動記錄）；

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

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

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


　　HandlerInterceptor：

public interface HandlerInterceptor {

   /**
     * 預處理回調方法，實現處理器的預處理（如檢查登陸），第三個參數為響應的處理器，自定義Controller
     * 返回值：true表示繼續流程（如調用下一個攔截器或處理器）；
　　　*       false表示流程中斷（如登錄檢查失敗），不會繼續調用其他的攔截器或處理器，此時我們需要通過response來產生響應；
   */
    boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception;
   /**
     * 后處理回調方法，實現處理器的后處理（但在渲染視圖之前），此時我們可以通過modelAndView（模型和視圖對象）對模型數據進行處理或對視圖進行處理，modelAndView也可能為null。
   */
    void postHandle(
            HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
            throws Exception;
   /**
    * 整個請求處理完畢回調方法，即在視圖渲染完畢時回調，如性能監控中我們可以在此記錄結束時間並輸出消耗時間，還可以進行一些資源清理，類似於try-catch-finally中的finall
　　 * 但僅調用處理器執行鏈中preHandle返回true的攔截器的afterCompletion。
   */
    void afterCompletion(
            HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception;
}

　　攔截器適配器HandlerInterceptorAdapter
　　有時候我們可能只需要實現三個回調方法中的某一個，如果實現HandlerInterceptor接口的話，三個方法必須實現，不管你需不需要，此時spring提供了一個HandlerInterceptorAdapter適配器（種適配器設計模式的實現），允許我們只實現需要的回調方法。

public abstract class HandlerInterceptorAdapter implements HandlerInterceptor {  
     //省略代碼 此處所以三個回調方法都是空實現，preHandle返回true。  
}  

　　HandlerInterceptorAdapter類：

public abstract class HandlerInterceptorAdapter implements AsyncHandlerInterceptor {

    //默認是true
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {

        return true;
    }
    //This implementation is empty.
    @Override
    public void postHandle(
            HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)
            throws Exception {
    }
    //This implementation is empty.
    @Override
    public void afterCompletion(
            HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
    }
    //不是HandlerInterceptor的接口實現，是AsyncHandlerInterceptor的，AsyncHandlerInterceptor實現了HandlerInterceptor
    @Override
    public void afterConcurrentHandlingStarted(
            HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
    }

}

運行流程圖

　　　　　　

　　　　　　

 

　　運行流程總結如下：

　　1、攔截器執行順序是按照Spring配置文件中定義的順序而定的。

　　2、會先按照順序執行所有攔截器的preHandle方法，一直遇到return false為止，比如第二個preHandle方法是return false，則第三個以及以后所有攔截器都不會執行。若都是return true，則按順序加載完preHandle方法。

　　3、然后執行主方法（自己的controller接口），若中間拋出異常，則跟return false效果一致，不會繼續執行postHandle，只會倒序執行afterCompletion方法。

　　4、在主方法執行完業務邏輯（頁面還未渲染數據）時，按倒序執行postHandle方法。若第三個攔截器的preHandle方法return false，則會執行第二個和第一個的postHandle方法和afterCompletion（postHandle都執行完才會執行這個，也就是頁面渲染完數據后，執行after進行清理工作）方法。（postHandle和afterCompletion都是倒序執行）

DispatcherServlet內部工作機制

//doDispatch方法  
//1、處理器攔截器的預處理（正序執行）  
HandlerInterceptor[] interceptors = mappedHandler.getInterceptors();  
if (interceptors != null) {  
    for (int i = 0; i < interceptors.length; i++) {  
    HandlerInterceptor interceptor = interceptors[i];  
        if (!interceptor.preHandle(processedRequest, response, mappedHandler.getHandler())) {  
            //1.1、失敗時觸發afterCompletion的調用 
            triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null); return;  
        }  
        interceptorIndex = i;//1.2、記錄當前預處理成功的索引  
}  
}  
//2、處理器適配器調用我們的處理器  
mv = ha.handle(processedRequest, response, mappedHandler.getHandler());  
//當我們返回null或沒有返回邏輯視圖名時的默認視圖名翻譯（詳解4.15.5 RequestToViewNameTranslator）  
if (mv != null && !mv.hasView()) {  
    mv.setViewName(getDefaultViewName(request));  
}  
//3、處理器攔截器的后處理（逆序）  
if (interceptors != null) {  
for (int i = interceptors.length - 1; i >= 0; i--) {  
      HandlerInterceptor interceptor = interceptors[i];  
      interceptor.postHandle(processedRequest, response, mappedHandler.getHandler(), mv);  
}  
}  
//4、視圖的渲染  
if (mv != null && !mv.wasCleared()) {  
render(mv, processedRequest, response);  
    if (errorView) {  
        WebUtils.clearErrorRequestAttributes(request);  
}  
//5、觸發整個請求處理完畢回調方法afterCompletion  
triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);  

// triggerAfterCompletion方法  
private void triggerAfterCompletion(HandlerExecutionChain mappedHandler, int interceptorIndex,  
            HttpServletRequest request, HttpServletResponse response, Exception ex) throws Exception {  
        // 5、觸發整個請求處理完畢回調方法afterCompletion （逆序從1.2中的預處理成功的索引處的攔截器執行）  
        if (mappedHandler != null) {  
            HandlerInterceptor[] interceptors = mappedHandler.getInterceptors();  
            if (interceptors != null) {  
                for (int i = interceptorIndex; i >= 0; i--) {  
                    HandlerInterceptor interceptor = interceptors[i];  
                    try {  
                        interceptor.afterCompletion(request, response, mappedHandler.getHandler(), ex);  
                    }  
                    catch (Throwable ex2) {  
                        logger.error("HandlerInterceptor.afterCompletion threw exception", ex2);  
                    }  
                }  
            }  
        }  
    }  

應用示例

　　Intercepter：

public class SyslogInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        System.out.println("==========================================pre1================================================");
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        System.out.println("==========================================post1================================================");
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        System.out.println("==========================================after1================================================");
    }
}

public class SyslogInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
            throws Exception {
        System.out.println("==========================================pre2================================================");
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
            ModelAndView modelAndView) throws Exception {
        System.out.println("==========================================post2================================================");
    }
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)
            throws Exception {
        System.out.println("==========================================after2================================================");
    }
}

　　... ...，然后是配置文件

<mvc:interceptors>
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="com.bshf.recipe.demo.syslog.SyslogInterceptor" />
        </mvc:interceptor>
        
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="com.bshf.recipe.demo.syslog.SyslogInterceptor2" />
        </mvc:interceptor>
        
        <mvc:interceptor>
            <mvc:mapping path="/**"/>
            <bean class="com.bshf.recipe.demo.syslog.SyslogInterceptor3" />
        </mvc:interceptor>
</mvc:interceptors>

　　<mvc:mapping path="/**"/>需要攔截的路徑，這里匹配所有。這里的配置順序將是攔截器執行順序（post和after是倒序的）。

==========================================pre1================================================
==========================================pre2================================================
==========================================pre3================================================
==========================================post3================================================
==========================================post2================================================
==========================================post1================================================
==========================================after3================================================
==========================================after2================================================
==========================================after1================================================

　　將SyslogInterceptor3的preHandle方法返回false。其他不變，再看輸出結果：

==========================================pre1================================================
==========================================pre2================================================
==========================================pre3================================================
==========================================after2================================================
==========================================after1================================================

　　發現沒有了post，post方法一個都沒有輸出。不僅如此，你的主程序代碼（xxx.controller的一個接口）都不會被執行，所以只要遇到return false，則直接進行after清理工作，post和自己主程序代碼都將被略過。

應用

　　1、性能監測

　　如記錄一下請求的處理時間，得到一些慢請求（如處理時間超過500毫秒），從而進行性能改進，一般的反向代理服務器如apache都具有這個功能，但此處我們演示一下使用攔截器怎么實現。

　　實現分析：

　　1、在進入處理器之前記錄開始時間，即在攔截器的preHandle記錄開始時間；

　　2、在結束請求處理之后記錄結束時間，即在攔截器的afterCompletion記錄結束實現，並用結束時間-開始時間得到這次請求的處理時間。

　　問題：

　　我們的攔截器是單例，因此不管用戶請求多少次都只有一個攔截器實現，即線程不安全，那我們應該怎么記錄時間呢？

　　解決方案是使用ThreadLocal，它是線程綁定的變量，提供線程局部變量（一個線程一個ThreadLocal，A線程的ThreadLocal只能看到A線程的ThreadLocal，不能看到B線程的ThreadLocal）。

　　代碼實現：

public class StopWatchHandlerInterceptor extends HandlerInterceptorAdapter {  
    private NamedThreadLocal<Long>  startTimeThreadLocal =   
new NamedThreadLocal<Long>("StopWatch-StartTime");  
    @Override  
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response,   
Object handler) throws Exception {  
        long beginTime = System.currentTimeMillis();//1、開始時間  
        startTimeThreadLocal.set(beginTime);//線程綁定變量（該數據只有當前請求的線程可見）  
        return true;//繼續流程  
    }  
      
    @Override  
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response,   
Object handler, Exception ex) throws Exception {  
        long endTime = System.currentTimeMillis();//2、結束時間  
        long beginTime = startTimeThreadLocal.get();//得到線程綁定的局部變量（開始時間）  
        long consumeTime = endTime - beginTime;//3、消耗的時間  
        if(consumeTime > 500) {//此處認為處理時間超過500毫秒的請求為慢請求  
            //TODO 記錄到日志文件  
            System.out.println(  
String.format("%s consume %d millis", request.getRequestURI(), consumeTime));  
        }          
    }  
}  

　　NamedThreadLocal：Spring提供的一個命名的ThreadLocal實現。在測試時需要把stopWatchHandlerInterceptor放在攔截器鏈的第一個，這樣得到的時間才是比較准確的。

　　2、登陸檢測

　　在訪問某些資源時（如訂單頁面），需要用戶登錄后才能查看，因此需要進行登錄檢測。流程：

　　1、訪問需要登錄的資源時，由攔截器重定向到登錄頁面；

　　2、如果訪問的是登錄頁面，攔截器不應該攔截；

　　3、用戶登錄成功后，往cookie/session添加登錄成功的標識（如用戶編號）；

　　4、下次請求時，攔截器通過判斷cookie/session中是否有該標識來決定繼續流程還是到登錄頁面；

　　5、在此攔截器還應該允許游客訪問的資源。

　　代碼實現：

@Override  
public boolean preHandle(HttpServletRequest request, HttpServletResponse response,   
Object handler) throws Exception {  
    //1、請求到登錄頁面 放行  
    if(request.getServletPath().startsWith(loginUrl)) {  
        return true;  
    }  
          
    //2、TODO 比如退出、首頁等頁面無需登錄，即此處要放行 允許游客的請求  
          
    //3、如果用戶已經登錄 放行    
    if(request.getSession().getAttribute("username") != null) {  
        //更好的實現方式的使用cookie  
        return true;  
    }  
          
    //4、非法請求 即這些請求需要登錄后才能訪問  
    //重定向到登錄頁面  
    response.sendRedirect(request.getContextPath() + loginUrl);  
    return false;  
}  

　　提示：推薦能使用servlet規范中的過濾器Filter實現的功能就用Filter實現，因為HandlerInteceptor只有在Spring Web MVC環境下才能使用，因此Filter是最通用的、最先應該使用的。如登錄這種攔截器最好使用Filter來實現。