springMVC源碼分析--HandlerInterceptor攔截器（一）

對SpringMVC有所了解的人肯定接觸過HandlerInterceptor攔截器，HandlerInterceptor接口給我們提供了3個方法：

（1）preHandle: 在執行controller處理之前執行，傳回值為boolean ,傳回值為true時接着執行postHandle和afterCompletion，如果我們傳回false則中斷執行

（2）postHandle:在執行controller的處理後，在ModelAndView處理前執行

（3）afterCompletion ：在DispatchServlet執行完ModelAndView之後執行

源碼如下：

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源碼分析--國際化實作Session和Cookie（二）​​中

LanguageInterceptor的詳細實作。

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

SpringMVC還提供了

HandlerInterceptorAdapter 其是抽象類，也是HandlerInterceptor的子類，在實作了HandlerInterceptor的三個函數後還增加了一個函數。

（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;

}