【轉】spring處理器攔截器詳解

轉自：http://jinnianshilongnian.iteye.com/blog/1670856

處理器攔截器簡介

Spring Web MVC的處理器攔截器（如無特殊說明，下文所說的攔截器即處理器攔截器）
類似于Servlet開發中的過濾器Filter，用于對處理器進行預處理和后處理。

一、常見應用場景

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

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

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

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

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

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

二、攔截器接口

package org.springframework.web.servlet;  
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;  
}

我們可能注意到攔截器一個有3個回調方法，而一般的過濾器Filter才兩個，這是怎么回事呢？馬上分析。

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

三、攔截器適配器

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

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

四、運行流程圖


圖5-1 正常流程


圖5-2 中斷流程
中斷流程中，比如是HandlerInterceptor2中斷的流程（preHandle返回false），此處僅調用它之前攔截器的preHandle返回true的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);  
                        }  
                    }  
                }  
            }  
        }

入門

具體內容詳見工程springmvc-chapter5。

一、正常流程

1、攔截器實現

    package cn.javass.chapter5.web.interceptor;  
    //省略import  
    public class HandlerInterceptor1 extends HandlerInterceptorAdapter {//此處一般繼承HandlerInterceptorAdapter適配器即可  
        @Override  
        public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {  
            System.out.println("===========HandlerInterceptor1 preHandle");  
            return true;  
        }  
        @Override  
        public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {  
            System.out.println("===========HandlerInterceptor1 postHandle");  
        }  
        @Override  
        public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {  
            System.out.println("===========HandlerInterceptor1 afterCompletion");  
        }  
    }

以上是HandlerInterceptor1實現，HandlerInterceptor2同理 只是輸出內容為“HandlerInterceptor2”。

2、控制器

    package cn.javass.chapter5.web.controller;  
    //省略import  
    public class TestController implements Controller {  
        @Override  
        public ModelAndView handleRequest(HttpServletRequest req, HttpServletResponse resp) throws Exception {  
            System.out.println("===========TestController");  
            return new ModelAndView("test");  
        }  
    }

3、Spring配置文件chapter5-servlet.xml

<bean name="/test" class="cn.javass.chapter5.web.controller.TestController"/>  
<bean id="handlerInterceptor1"   
class="cn.javass.chapter5.web.interceptor.HandlerInterceptor1"/>  
<bean id="handlerInterceptor2"   
class="cn.javass.chapter5.web.interceptor.HandlerInterceptor2"/>  

    <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">  
        <property name="interceptors">  
            <list>  
               <ref bean="handlerInterceptor1"/>  
              <ref bean="handlerInterceptor2"/>  
            </list>  
        </property>  
    </bean>

interceptors：指定攔截器鏈，攔截器的執行順序就是此處添加攔截器的順序；

4、視圖頁面WEB-INF/jsp/test.jsp

    <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>  
    <%System.out.println("==========test.jsp");%>  
    test page

在控制臺輸出 test.jsp

5、啟動服務器測試
輸入網址：http://localhost:9080/springmvc-chapter5/test
控制臺輸出：

===========HandlerInterceptor1 preHandle  
===========HandlerInterceptor2 preHandle  
===========TestController  
===========HandlerInterceptor2 postHandle  
===========HandlerInterceptor1 postHandle  
==========test.jsp  
===========HandlerInterceptor2 afterCompletion  
===========HandlerInterceptor1 afterCompletion

到此一個正常流程的演示完畢。和圖5-1一樣，接下來看一下中斷的流程。

二、中斷流程

1、攔截器
HandlerInterceptor3和HandlerInterceptor4 與 之前的 HandlerInteceptor1和HandlerInterceptor2一樣，只是在HandlerInterceptor4的preHandle方法返回false：

@Override  
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {  
    System.out.println("===========HandlerInterceptor1 preHandle");  
onse.getWriter().print("break");//流程中斷的話需要我們進行響應的處理  
    return false;//返回false表示流程中斷

2、控制器
流程中斷不會執行到控制器，使用之前的TestController控制器。
3、Spring配置文件chapter5-servlet.xml

<bean id="handlerInterceptor3"   
class="cn.javass.chapter5.web.interceptor.HandlerInterceptor3"/>  
<bean id="handlerInterceptor4"   
class="cn.javass.chapter5.web.interceptor.HandlerInterceptor4"/>  

<bean id="handlerInterceptor3"   
class="cn.javass.chapter5.web.interceptor.HandlerInterceptor3"/>  
<bean id="handlerInterceptor4"   
class="cn.javass.chapter5.web.interceptor.HandlerInterceptor4"/>  

    <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">  
        <property name="interceptors">  
            <list>  
               <ref bean="handlerInterceptor3"/>  
              <ref bean="handlerInterceptor4"/>  
            </list>  
        </property>  
    </bean>

interceptors：指定攔截器鏈，攔截器的執行順序就是此處添加攔截器的順序；

4、視圖頁面
流程中斷，不會執行到視圖渲染。

5、啟動服務器測試
輸入網址：http://localhost:9080/springmvc-chapter5/test
控制臺輸出：

===========HandlerInterceptor3 preHandle  
===========HandlerInterceptor4 preHandle  
===========HandlerInterceptor3 afterCompletion

此處我們可以看到只有HandlerInterceptor3的afterCompletion執行，否和圖5-2的中斷流程。
而且頁面上會顯示我們在HandlerInterceptor4 preHandle 直接寫出的響應“break”。

應用

一、性能監控

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

實現分析：
1、在進入處理器之前記錄開始時間，即在攔截器的preHandle記錄開始時間；
2、在結束請求處理之后記錄結束時間，即在攔截器的afterCompletion記錄結束實現，并用結束時間-開始時間得到這次請求的處理時間。

問題：
我們的攔截器是單例，因此不管用戶請求多少次都只有一個攔截器實現，即線程不安全，那我們應該怎么記錄時間呢？
解決方案是使用ThreadLocal，它是線程綁定的變量，提供線程局部變量（一個線程一個ThreadLocal，A線程的ThreadLocal只能看到A線程的ThreadLocal，不能看到B線程的ThreadLocal）。

代碼實現：

    package cn.javass.chapter5.web.interceptor;  
    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放在攔截器鏈的第一個，這樣得到的時間才是比較準確的。

二、登錄檢測

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

流程：
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來實現。

最后編輯于 ：
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明：文章內容（如有圖片或視頻亦包括在內）由作者上傳并發布，文章內容僅代表作者本人觀點，簡書系信息發布平臺，僅提供信息存儲服務。

推薦閱讀更多精彩內容

  • Spring Cloud為開發人員提供了快速構建分布式系統中一些常見模式的工具（例如配置管理，服務發現，斷路器，智...
    卡卡羅2017閱讀 134,991評論 19贊 139
  • 姓名: 李小娜 [嵌牛導讀]: SpringMVC 中的Interceptor 攔截器也是相當重要和相當有用的，...
    n184閱讀 3,204評論 0贊 4
  • 1. 認識攔截器 Spring MVC的攔截器（Interceptor）不是Filter，同樣可以實現請求的預處理...
    郭尋撫閱讀 19,780評論 1贊 16
  • 1 斜陽照在小A身上，小A如同女神一般，高貴而婉約，而身后的影子卻拉得老長、老長。 左前方那束干枯的花，在淡藍色花...
    YI點閱讀 506評論 0贊 3
  • 我想我應該是個沒有藝術天份外加后天沒努力過的姑娘，甚至有時候想畫畫筆都不敢下，今天，總算是邁出了第一步，從簡單的簡...
    xp摩羯閱讀 212評論 0贊 0