5.1、處理器攔截器簡(jiǎn)介 Spring Web MVC的處理器攔截器（如無(wú)特殊說(shuō)明，下文所說(shuō)的攔截器即處理器攔截器）類似于Servlet開(kāi)發(fā)中的過(guò)濾器Filter，用于對(duì)處理器進(jìn)行預(yù)處理和后處理。
?
5.1.1、常見(jiàn)應(yīng)用場(chǎng)景 1、日志記錄：記錄請(qǐng)求信息的日志，以便進(jìn)行信息監(jiān)控、信息統(tǒng)計(jì)、計(jì)算PV（Page View）等。
2、權(quán)限檢查：如登錄檢測(cè)，進(jìn)入處理器檢測(cè)檢測(cè)是否登錄，如果沒(méi)有直接返回到登錄頁(yè)面；
3、性能監(jiān)控：有時(shí)候系統(tǒng)在某段時(shí)間莫名其妙的慢，可以通過(guò)攔截器在進(jìn)入處理器之前記錄開(kāi)始時(shí)間，在處理完后記錄結(jié)束時(shí)間，從而得到該請(qǐng)求的處理時(shí)間（如果有反向代理，如apache可以自動(dòng)記錄）；
4、通用行為：讀取cookie得到用戶信息并將用戶對(duì)象放入請(qǐng)求，從而方便后續(xù)流程使用，還有如提取Locale、Theme信息等，只要是多個(gè)處理器都需要的即可使用攔截器實(shí)現(xiàn)。
5、OpenSessionInView：如Hibernate，在進(jìn)入處理器打開(kāi)Session，在完成后關(guān)閉Session。
…………本質(zhì)也是AOP（面向切面編程），也就是說(shuō)符合橫切關(guān)注點(diǎn)的所有功能都可以放入攔截器實(shí)現(xiàn)。
5.1.2、攔截器接口 ?
java代碼： 查看復(fù)制到剪貼板打印
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;?? }??? 我們可能注意到攔截器一個(gè)有3個(gè)回調(diào)方法，而一般的過(guò)濾器Filter才兩個(gè)，這是怎么回事呢？馬上分析。
?
preHandle： 預(yù)處理回調(diào)方法，實(shí)現(xiàn)處理器的預(yù)處理（如登錄檢查），第三個(gè)參數(shù)為響應(yīng)的處理器（如我們上一章的Controller實(shí)現(xiàn)）；
?????返回值：true表示繼續(xù)流程（如調(diào)用下一個(gè)攔截器或處理器）；
?????????? ??false表示流程中斷（如登錄檢查失敗），不會(huì)繼續(xù)調(diào)用其他的攔截器或處理器，此時(shí)我們需要通過(guò)response來(lái)產(chǎn)生響應(yīng)；
postHandle： 后處理回調(diào)方法，實(shí)現(xiàn)處理器的后處理（但在渲染視圖之前），此時(shí)我們可以通過(guò)modelAndView（模型和視圖對(duì)象）對(duì)模型數(shù)據(jù)進(jìn)行處理或?qū)σ晥D進(jìn)行處理，modelAndView也可能為null。
afterCompletion： 整個(gè)請(qǐng)求處理完畢回調(diào)方法，即在視圖渲染完畢時(shí)回調(diào)，如性能監(jiān)控中我們可以在此記錄結(jié)束時(shí)間并輸出消耗時(shí)間，還可以進(jìn)行一些資源清理，類似于try-catch-finally中的finally，但僅調(diào)用處理器執(zhí)行鏈中preHandle返回true的攔截器的afterCompletion 。
?
5.1.3、攔截器適配器 有時(shí)候我們可能只需要實(shí)現(xiàn)三個(gè)回調(diào)方法中的某一個(gè)，如果實(shí)現(xiàn)HandlerInterceptor接口的話，三個(gè)方法必須實(shí)現(xiàn)，不管你需不需要，此時(shí)spring提供了一個(gè)HandlerInterceptorAdapter適配器（一種適配器設(shè)計(jì)模式的實(shí)現(xiàn)），允許我們只實(shí)現(xiàn)需要的回調(diào)方法。
?
java代碼： 查看復(fù)制到剪貼板打印
public ? abstract ? class ?HandlerInterceptorAdapter? implements ?HandlerInterceptor?{?? ??????? }?? 5.1.4、運(yùn)行流程圖 ?
圖5-1 正常流程
?
?
圖5-2 中斷流程
中斷流程中，比如是HandlerInterceptor2中斷的流程（preHandle返回false），此處僅調(diào)用它之前攔截器的preHandle返回true的afterCompletion方法。
?
接下來(lái)看一下DispatcherServlet內(nèi)部到底是如何工作的吧：
java代碼： 查看復(fù)制到剪貼板打印
?? ?? 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()))?{?? ?????????????? ????????????triggerAfterCompletion(mappedHandler,?interceptorIndex,?processedRequest,?response,?null );?? ????????????return ;?? ????????}?? ????????interceptorIndex?=?i;?? }?? }?? ?? mv?=?ha.handle(processedRequest,?response,?mappedHandler.getHandler());?? ?? 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);?? }?? ?? triggerAfterCompletion(mappedHandler,?interceptorIndex,?processedRequest,?response,?null );?? 注：以上是流程的簡(jiǎn)化代碼，中間省略了部分代碼，不完整。
?
java代碼： 查看復(fù)制到剪貼板打印
?? private ? void ?triggerAfterCompletion(HandlerExecutionChain?mappedHandler,? int ?interceptorIndex,?? ????????????HttpServletRequest?request,?HttpServletResponse?response,?Exception?ex)?throws ?Exception?{?? ?????????? ????????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);?? ????????????????????}?? ????????????????}?? ????????????}?? ????????}?? ????}?? ?
5.2、入門(mén) 具體內(nèi)容詳見(jiàn)工程springmvc-chapter5。
5.2.1、正常流程 （1、攔截器實(shí)現(xiàn)
?
java代碼： 查看復(fù)制到剪貼板打印
package ?cn.javass.chapter5.web.interceptor;?? ?? public ? class ?HandlerInterceptor1? extends ?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實(shí)現(xiàn)，HandlerInterceptor2同理 只是輸出內(nèi)容為“HandlerInterceptor2”。
（2、控制器
?
java代碼： 查看復(fù)制到剪貼板打印
package ?cn.javass.chapter5.web.controller;?? ?? 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
?
java代碼： 查看復(fù)制到剪貼板打印
<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" />?? ??? ?
java代碼： 查看復(fù)制到剪貼板打印
<bean? class = "org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping" >?? ????<property?name="interceptors" >?? ????????<list>?? ???????????<ref?bean="handlerInterceptor1" />?? ??????????<ref?bean="handlerInterceptor2" />?? ????????</list>?? ????</property>?? </bean>?? ?
?
interceptors：指定攔截器鏈，攔截器的執(zhí)行順序就是此處添加攔截器的順序；
?
（4、視圖頁(yè)面WEB-INF/jsp/test.jsp
?
java代碼： 查看復(fù)制到剪貼板打印
<%@?page?language= "java" ?contentType= "text/html;?charset=UTF-8" ?pageEncoding= "UTF-8" %>?? <%System.out.println("==========test.jsp" );%>?? test?page?? ?
在控制臺(tái)輸出 test.jsp
?
（5、啟動(dòng)服務(wù)器測(cè)試
輸入網(wǎng)址：http://localhost:9080/springmvc-chapter5/test
控制臺(tái)輸出：
?
java代碼： 查看復(fù)制到剪貼板打印
===========HandlerInterceptor1?preHandle?? ===========HandlerInterceptor2?preHandle?? ===========TestController?? ===========HandlerInterceptor2?postHandle?? ===========HandlerInterceptor1?postHandle?? ==========test.jsp?? ===========HandlerInterceptor2?afterCompletion?? ===========HandlerInterceptor1?afterCompletion?? ?
到此一個(gè)正常流程的演示完畢。和圖5-1一樣，接下來(lái)看一下中斷的流程。
5.2.2、中斷流程 （1、攔截器
HandlerInterceptor3和HandlerInterceptor4 與 之前的 HandlerInteceptor1和HandlerInterceptor2一樣，只是在HandlerInterceptor4的preHandle方法返回false：
?
java代碼： 查看復(fù)制到剪貼板打印
@Override ?? public ? boolean ?preHandle(HttpServletRequest?request,?HttpServletResponse?response,?Object?handler)? throws ?Exception?{?? ????System.out.println("===========HandlerInterceptor1?preHandle" );?? onse.getWriter().print("break" ); ?? ????return ? false ; ?? ?
（2、控制器
流程中斷不會(huì)執(zhí)行到控制器，使用之前的TestController控制器。
（3、Spring配置文件chapter5-servlet.xml
?
java代碼： 查看復(fù)制到剪貼板打印
<bean?id= "handlerInterceptor3" ??? class = "cn.javass.chapter5.web.interceptor.HandlerInterceptor3" />?? <bean?id="handlerInterceptor4" ??? class = "cn.javass.chapter5.web.interceptor.HandlerInterceptor4" />?? ??? ?
java代碼： 查看復(fù)制到剪貼板打印
<bean?id= "handlerInterceptor3" ??? class = "cn.javass.chapter5.web.interceptor.HandlerInterceptor3" />?? <bean?id="handlerInterceptor4" ??? class = "cn.javass.chapter5.web.interceptor.HandlerInterceptor4" />?? ??? ?
java代碼： 查看復(fù)制到剪貼板打印
<bean? class = "org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping" >?? ????<property?name="interceptors" >?? ????????<list>?? ???????????<ref?bean="handlerInterceptor3" />?? ??????????<ref?bean="handlerInterceptor4" />?? ????????</list>?? ????</property>?? </bean>?? ?
interceptors：指定攔截器鏈，攔截器的執(zhí)行順序就是此處添加攔截器的順序；
?
（4、視圖頁(yè)面
流程中斷，不會(huì)執(zhí)行到視圖渲染。
（5、啟動(dòng)服務(wù)器測(cè)試
輸入網(wǎng)址：http://localhost:9080/springmvc-chapter5/test
控制臺(tái)輸出：
?
java代碼： 查看復(fù)制到剪貼板打印
===========HandlerInterceptor3?preHandle?? ===========HandlerInterceptor4?preHandle?? ===========HandlerInterceptor3?afterCompletion?? ?
此處我們可以看到只有HandlerInterceptor3的afterCompletion執(zhí)行，否和圖5-2的中斷流程。
而且頁(yè)面上會(huì)顯示我們?cè)贖andlerInterceptor4 preHandle 直接寫(xiě)出的響應(yīng)“break”。
?
5.3、應(yīng)用 5.3.1、性能監(jiān)控 如記錄一下請(qǐng)求的處理時(shí)間，得到一些慢請(qǐng)求（如處理時(shí)間超過(guò)500毫秒），從而進(jìn)行性能改進(jìn)，一般的反向代理服務(wù)器如apache都具有這個(gè)功能，但此處我們演示一下使用攔截器怎么實(shí)現(xiàn)。
?
實(shí)現(xiàn)分析：
1、在進(jìn)入處理器之前記錄開(kāi)始時(shí)間，即在攔截器的preHandle記錄開(kāi)始時(shí)間；
2、在結(jié)束請(qǐng)求處理之后記錄結(jié)束時(shí)間，即在攔截器的afterCompletion記錄結(jié)束實(shí)現(xiàn)，并用結(jié)束時(shí)間-開(kāi)始時(shí)間得到這次請(qǐng)求的處理時(shí)間。
?
問(wèn)題：
我們的攔截器是單例，因此不管用戶請(qǐng)求多少次都只有一個(gè)攔截器實(shí)現(xiàn)，即線程不安全，那我們應(yīng)該怎么記錄時(shí)間呢？
解決方案是使用ThreadLocal，它是線程綁定的變量，提供線程局部變量（一個(gè)線程一個(gè)ThreadLocal，A線程的ThreadLocal只能看到A線程的ThreadLocal，不能看到B線程的ThreadLocal）。
?
代碼實(shí)現(xiàn)：
?
java代碼： 查看復(fù)制到剪貼板打印
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(); ?? ????????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 )?{ ?? ?????????????? ????????????System.out.println(?? String.format("%s?consume?%d?millis" ,?request.getRequestURI(),?consumeTime));?? ????????}?????????? ????}?? }?? ?
NamedThreadLocal：Spring提供的一個(gè)命名的ThreadLocal實(shí)現(xiàn)。
?
在測(cè)試時(shí)需要把stopWatchHandlerInterceptor放在攔截器鏈的第一個(gè)，這樣得到的時(shí)間才是比較準(zhǔn)確的。
?
5.3.2、登錄檢測(cè) 在訪問(wèn)某些資源時(shí)（如訂單頁(yè)面），需要用戶登錄后才能查看，因此需要進(jìn)行登錄檢測(cè)。
?
流程：
1、訪問(wèn)需要登錄的資源時(shí)，由攔截器重定向到登錄頁(yè)面；
2、如果訪問(wèn)的是登錄頁(yè)面，攔截器不應(yīng)該攔截；
3、用戶登錄成功后，往cookie/session添加登錄成功的標(biāo)識(shí)（如用戶編號(hào)）；
4、下次請(qǐng)求時(shí)，攔截器通過(guò)判斷cookie/session中是否有該標(biāo)識(shí)來(lái)決定繼續(xù)流程還是到登錄頁(yè)面；
5、在此攔截器還應(yīng)該允許游客訪問(wèn)的資源。
?
攔截器代碼如下所示：
?
java代碼： 查看復(fù)制到剪貼板打印
@Override ?? public ? boolean ?preHandle(HttpServletRequest?request,?HttpServletResponse?response,??? Object?handler)?throws ?Exception?{?? ?????? ????if (request.getServletPath().startsWith(loginUrl))?{?? ????????return ? true ;?? ????}?? ?????????? ?????? ?????????? ?????? ????if (request.getSession().getAttribute( "username" )?!=? null )?{?? ?????????? ????????return ? true ;?? ????}?? ?????????? ?????? ?????? ????response.sendRedirect(request.getContextPath()?+?loginUrl);?? ????return ? false ;?? }?? ?
提示：推薦能使用servlet規(guī)范中的過(guò)濾器Filter實(shí)現(xiàn)的功能就用Filter實(shí)現(xiàn)，因?yàn)镠andlerInteceptor只有在Spring Web MVC環(huán)境下才能使用，因此Filter是最通用的、最先應(yīng)該使用的。如登錄這種攔截器最好使用Filter來(lái)實(shí)現(xiàn)。
?
原創(chuàng)內(nèi)容，轉(zhuǎn)載請(qǐng)注明私塾在線【http://sishuok.com/forum/blogPost/list/5934.html#19650】
該帖子包含附件，回復(fù)帖子后即可下載附件。
相關(guān)筆記推薦 第四章 Controller接口控制器詳解（6）——跟著開(kāi)濤學(xué)SpringMVC 第四章 Controller接口控制器詳解（5）——跟著開(kāi)濤學(xué)SpringMVC 第四章 Controller接口控制器詳解（4）——跟著開(kāi)濤學(xué)SpringMVC 第四章 Controller接口控制器詳解（3）——跟著開(kāi)濤學(xué)SpringMVC 第四章 Controller接口控制器詳解（2）——跟著開(kāi)濤學(xué)SpringMVC 第四章 Controller接口控制器詳解（1）——跟著開(kāi)濤學(xué)SpringMVC 第三章 DispatcherServlet詳解 ——跟開(kāi)濤學(xué)SpringMVC 第二章 Spring MVC入門(mén) —— 跟開(kāi)濤學(xué)SpringMVC 第一章 Web MVC簡(jiǎn)介 —— 跟開(kāi)濤學(xué)SpringMVC
from:?http://sishuok.com/forum/blogPost/list/5934.html
總結(jié)
以上是生活随笔 為你收集整理的第五章 处理器拦截器详解——跟着开涛学SpringMVC 的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。
如果覺(jué)得生活随笔 網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔 推薦給好友。
