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

時間 2019-12-13

標籤處理器攔截 handlerinterceptor 詳解简体版

原文原文鏈接

簡介

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

應用場景

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

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

　　五、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類：cookie

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 {
    }

}

運行流程圖

　　運行流程總結以下：session

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

　　二、會先按照順序執行全部攔截器的preHandle方法，一直遇到return false爲止，好比第二個preHandle方法是return false，則第三個以及之後全部攔截器都不會執行。若都是return true，則按順序加載完preHandle方法。app

　　三、而後執行主方法（本身的controller接口），若中間拋出異常，則跟return false效果一致，不會繼續執行postHandle，只會倒序執行afterCompletion方法。

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

DispatcherServlet內部工做機制

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

// triggerAfterCompletion方法  
private void triggerAfterCompletion(HandlerExecutionChain mappedHandler, int interceptorIndex,  
            HttpServletRequest request, HttpServletResponse response, Exception ex) throws Exception {  
        // 五、觸發整個請求處理完畢回調方法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和本身主程序代碼都將被略過。

應用

　　一、性能監測

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

　　實現分析：

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

　　二、在結束請求處理以後記錄結束時間，即在攔截器的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();//一、開始時間  
        startTimeThreadLocal.set(beginTime);//線程綁定變量（該數據只有當前請求的線程可見）  
        return true;//繼續流程  
    }  
      
    @Override  
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response,   
Object handler, Exception ex) throws Exception {  
        long endTime = System.currentTimeMillis();//二、結束時間  
        long beginTime = startTimeThreadLocal.get();//獲得線程綁定的局部變量（開始時間）  
        long consumeTime = endTime - beginTime;//三、消耗的時間  
        if(consumeTime > 500) {//此處認爲處理時間超過500毫秒的請求爲慢請求  
            //TODO 記錄到日誌文件  
            System.out.println(  
String.format("%s consume %d millis", request.getRequestURI(), consumeTime));  
        }          
    }  
}

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

　　二、登錄檢測

　　在訪問某些資源時（如訂單頁面），須要用戶登陸後才能查看，所以須要進行登陸檢測。流程：

　　一、訪問須要登陸的資源時，由攔截器重定向到登陸頁面；

　　二、若是訪問的是登陸頁面，攔截器不該該攔截；

　　三、用戶登陸成功後，往cookie/session添加登陸成功的標識（如用戶編號）；

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

　　五、在此攔截器還應該容許遊客訪問的資源。

　　代碼實現：

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

　　提示：推薦能使用servlet規範中的過濾器Filter實現的功能就用Filter實現，由於HandlerInteceptor只有在Spring Web MVC環境下才能使用，所以Filter是最通用的、最早應該使用的。如登陸這種攔截器最好使用Filter來實現。

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。