springMVC原始碼分析--HandlerInterceptor攔截器(一)
阿新 • • 發佈:2019-01-09
對SpringMVC有所瞭解的人肯定接觸過HandlerInterceptor攔截器,HandlerInterceptor介面給我們提供了3個方法:
(1)preHandle: 在執行controller處理之前執行,返回值為boolean ,返回值為true時接著執行postHandle和afterCompletion,如果我們返回false則中斷執行(2)postHandle:在執行controller的處理後,在ModelAndView處理前執行(3)afterCompletion :在DispatchServlet執行完ModelAndView之後執行原始碼如下:簡單實現一個攔截器,幾乎並沒有做任何實現,可以看之前寫的部落格springMVC原始碼分析--國際化實現Session和Cookie(二)中LanguageInterceptor的詳細實現。public interface HandlerInterceptor { /** * preHandle方法是進行處理器攔截用的,顧名思義,該方法將在Controller處理之前進行呼叫,SpringMVC中的Interceptor攔截器是鏈式的,可以同時存在 * 多個Interceptor,然後SpringMVC會根據宣告的前後順序一個接一個的執行,而且所有的Interceptor中的preHandle方法都會在 * Controller方法呼叫之前呼叫。SpringMVC的這種Interceptor鏈式結構也是可以進行中斷的,這種中斷方式是令preHandle的返 * 回值為false,當preHandle的返回值為false的時候整個請求就結束了。 */ boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception; /** * 這個方法只會在當前這個Interceptor的preHandle方法返回值為true的時候才會執行。postHandle是進行處理器攔截用的,它的執行時間是在處理器進行處理之 * 後,也就是在Controller的方法呼叫之後執行,但是它會在DispatcherServlet進行檢視的渲染之前執行,也就是說在這個方法中你可以對ModelAndView進行操 * 作。這個方法的鏈式結構跟正常訪問的方向是相反的,也就是說先宣告的Interceptor攔截器該方法反而會後呼叫,這跟Struts2裡面的攔截器的執行過程有點像, * 只是Struts2裡面的intercept方法中要手動的呼叫ActionInvocation的invoke方法,Struts2中呼叫ActionInvocation的invoke方法就是呼叫下一個Interceptor * 或者是呼叫action,然後要在Interceptor之前呼叫的內容都寫在呼叫invoke之前,要在Interceptor之後呼叫的內容都寫在呼叫invoke方法之後。 */ void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception; /** * 該方法也是需要當前對應的Interceptor的preHandle方法的返回值為true時才會執行。該方法將在整個請求完成之後,也就是DispatcherServlet渲染了檢視執行, * 這個方法的主要作用是用於清理資源的,當然這個方法也只能在當前這個Interceptor的preHandle方法的返回值為true時才會執行。 */ void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception; }
SpringMVC還提供了HandlerInterceptorAdapter 其是抽象類,也是HandlerInterceptor的子類,在實現了HandlerInterceptor的三個函式後還增加了一個函式。public class MyInterceptor implements HandlerInterceptor { /** * @Title: preHandle * @Description: 在執行controller之前執行 * @param request * @param response * @param handler * @return * @throws Exception */ public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { return true; } /** * @Title: postHandle * @Description: 在執行完controller之後,ModelAndView渲染之前開始執行 * @param request * @param response * @param handler * @param modelAndView * @throws Exception */ public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception { } /** * @Title: afterCompletion * @Description: 該方法將在整個請求完成之後,也就是DispatcherServlet渲染了檢視後執行 * @param request * @param response * @param handler * @param ex * @throws Exception */ public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception { } }
(1)preHandle: 在執行controller處理之前執行,返回值為boolean ,返回值為true時接著執行postHandle和afterCompletion,如果我們返回false則中斷執行
(2)postHandle:在執行controller的處理後,在ModelAndView處理前執行
(3)afterCompletion :在DispatchServlet執行完ModelAndView之後執行
(4)afterConcurrentHandlingStarted:這個方法會在Controller方法非同步執行時開始執行,而Interceptor的postHandle方法則是需要等到Controller的非同步執行完才能執行,只要繼承這個類並實現其方法就可以了。
public abstract class HandlerInterceptorAdapter implements AsyncHandlerInterceptor {
/**
* This implementation always returns {@code 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 {
}
/**
* This implementation is empty.
*/
@Override
public void afterConcurrentHandlingStarted(
HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
}
}
AsyncHandlerInterceptor也是一個介面,提供了afterConcurrentHandlingStarted方法定義public interface AsyncHandlerInterceptor extends HandlerInterceptor {
/**
* Called instead of {@code postHandle} and {@code afterCompletion}, when
* the a handler is being executed concurrently.
* <p>Implementations may use the provided request and response but should
* avoid modifying them in ways that would conflict with the concurrent
* execution of the handler. A typical use of this method would be to
* clean up thread-local variables.
*
* @param request the current request
* @param response the current response
* @param handler the handler (or {@link HandlerMethod}) that started async
* execution, for type and/or instance examination
* @throws Exception in case of errors
*/
void afterConcurrentHandlingStarted(
HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception;
}