Spring MVC學習(五)-------處理器攔截器詳解

5.一、處理器攔截器簡介

Spring Web MVC的處理器攔截器（如無特殊說明，下文所說的攔截器即處理器攔截器）

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

 

5.1.一、常見應用場景

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

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

三、性能監控：有時候系統在某段時間莫名其妙的慢，能夠經過攔截器在進入處理器以前記錄開始時間，在處理完後記錄結束時間，從而獲得該請求的處理時間（若是有反向代理，如apache能夠自動記錄）；

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

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

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

5.1.二、攔截器接口

 

java代碼：

 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。

 

5.1.三、攔截器適配器

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

 

java代碼：

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

5.1.四、運行流程圖

 

圖5-1 正常流程

 

 

圖5-2 中斷流程

中斷流程中，好比是HandlerInterceptor2中斷的流程（preHandle返回false），此處僅調用它以前攔截器的preHandle返回true的afterCompletion方法。

 

接下來看一下DispatcherServlet內部究竟是如何工做的吧：




java代碼：

 //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);

注：以上是流程的簡化代碼，中間省略了部分代碼，不完整。

 

java代碼：

 // 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);
                     }
                 }
             }
         }
     }

 

5.2、入門

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

5.2.一、正常流程

（一、攔截器實現

 

java代碼：

 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」。

（二、控制器

 

java代碼：

 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");
     }
 }

 

（三、Spring配置文件chapter5-servlet.xml

 

java代碼：

 <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代碼：

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

 

 

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

 

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

 

java代碼：

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

 

在控制檯輸出 test.jsp

 

（五、啓動服務器測試

輸入網址：http://localhost:9080/springmvc-chapter5/test

控制檯輸出：

 

java代碼：

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

 

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

5.2.二、中斷流程

（一、攔截器

HandlerInterceptor3和HandlerInterceptor4 與 以前的 HandlerInteceptor1和HandlerInterceptor2同樣，只是在HandlerInterceptor4的preHandle方法返回false：

 

java代碼：

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

 

（二、控制器

流程中斷不會執行到控制器，使用以前的TestController控制器。

（三、Spring配置文件chapter5-servlet.xml

 

java代碼：

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

 

java代碼：

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

 

java代碼：

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

 

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

 

（四、視圖頁面

流程中斷，不會執行到視圖渲染。

（五、啓動服務器測試

輸入網址：http://localhost:9080/springmvc-chapter5/test

控制檯輸出：

 

java代碼：

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

 

此處咱們能夠看到只有HandlerInterceptor3的afterCompletion執行，否和圖5-2的中斷流程。

並且頁面上會顯示咱們在HandlerInterceptor4 preHandle 直接寫出的響應「break」。

 

5.三、應用

5.3.一、性能監控

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

 

實現分析：

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

二、在結束請求處理以後記錄結束時間，即在攔截器的afterCompletion記錄結束實現，並用結束時間-開始時間獲得此次請求的處理時間。

 

問題：

咱們的攔截器是單例，所以無論用戶請求多少次都只有一個攔截器實現，即線程不安全，那咱們應該怎麼記錄時間呢？

解決方案是使用ThreadLocal，它是線程綁定的變量，提供線程局部變量（一個線程一個ThreadLocal，A線程的ThreadLocal只能看到A線程的ThreadLocal，不能看到B線程的ThreadLocal）。

 

代碼實現：

 

java代碼：

 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) {//此處認爲處理時間超過500毫秒的請求爲慢請求
             //TODO 記錄到日誌文件
             System.out.println(
 String.format("%s consume %d millis", request.getRequestURI(), consumeTime));
         }
     }
 }

 

NamedThreadLocal：Spring提供的一個命名的ThreadLocal實現。

 

在測試時須要把stopWatchHandlerInterceptor放在攔截器鏈的第一個，這樣獲得的時間纔是比較準確的。

 

5.3.二、登陸檢測

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

 

流程：

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

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

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

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

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

 

攔截器代碼以下所示：

 

java代碼：

 @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來實現。