第五章 處理器攔截器詳解——跟着開濤學SpringMVC

時間  2021-01-20 標籤 處理器 攔截器 詳解 SpringMVC

5.1、處理器攔截器簡介

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

 

5.1.1、常見應用場景

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

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

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

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

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

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

5.1.2、攔截器接口

 

java代碼：
查看 複製到剪貼板 打印
  1. package org.springframework.web.servlet;  
  2. public interface HandlerInterceptor {  
  3.     boolean preHandle(  
  4.             HttpServletRequest request, HttpServletResponse response,   
  5.             Object handler)   
  6.             throws Exception;  
  7.   
  8.     void postHandle(  
  9.             HttpServletRequest request, HttpServletResponse response,   
  10.             Object handler, ModelAndView modelAndView)   
  11.             throws Exception;  
  12.   
  13.     void afterCompletion(  
  14.             HttpServletRequest request, HttpServletResponse response,   
  15.             Object handler, Exception ex)  
  16.             throws Exception;  
  17. }   

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

 

preHandle：預處理回調方法，實現處理器的預處理（如登錄檢查），第三個參數爲響應的處理器（如我們上一章的Controller實現）；

     返回值：true表示繼續流程（如調用下一個攔截器或處理器）；

             false表示流程中斷（如登錄檢查失敗），不會繼續調用其他的攔截器或處理器，此時我們需要通過response來產生響應；

postHandle：後處理回調方法，實現處理器的後處理（但在渲染視圖之前），此時我們可以通過modelAndView（模型和視圖對象）對模型數據進行處理或對視圖進行處理，modelAndView也可能爲null。

afterCompletion：整個請求處理完畢回調方法，即在視圖渲染完畢時回調，如性能監控中我們可以在此記錄結束時間並輸出消耗時間，還可以進行一些資源清理，類似於try-catch-finally中的finally，但僅調用處理器執行鏈中preHandle返回true的攔截器的afterCompletion。

 

5.1.3、攔截器適配器

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

 

java代碼：
查看 複製到剪貼板 打印
  1. public abstract class HandlerInterceptorAdapter implements HandlerInterceptor {  
  2.      //省略代碼 此處所以三個回調方法都是空實現，preHandle返回true。  
  3. }  

5.1.4、運行流程圖

 

圖5-1 正常流程

 

 

圖5-2 中斷流程

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

 

接下來看一下DispatcherServlet內部到底是如何工作的吧：


java代碼：
查看 複製到剪貼板 打印
  1. //doDispatch方法  
  2. //1、處理器攔截器的預處理（正序執行）  
  3. HandlerInterceptor[] interceptors = mappedHandler.getInterceptors();  
  4. if (interceptors != null) {  
  5.     for (int i = 0; i < interceptors.length; i++) {  
  6.     HandlerInterceptor interceptor = interceptors[i];  
  7.         if (!interceptor.preHandle(processedRequest, response, mappedHandler.getHandler())) {  
  8.             //1.1、失敗時觸發afterCompletion的調用  
  9.             triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);  
  10.             return;  
  11.         }  
  12.         interceptorIndex = i;//1.2、記錄當前預處理成功的索引  
  13. }  
  14. }  
  15. //2、處理器適配器調用我們的處理器  
  16. mv = ha.handle(processedRequest, response, mappedHandler.getHandler());  
  17. //當我們返回null或沒有返回邏輯視圖名時的默認視圖名翻譯（詳解4.15.5 RequestToViewNameTranslator）  
  18. if (mv != null && !mv.hasView()) {  
  19.     mv.setViewName(getDefaultViewName(request));  
  20. }  
  21. //3、處理器攔截器的後處理（逆序）  
  22. if (interceptors != null) {  
  23. for (int i = interceptors.length - 1; i >= 0; i--) {  
  24.       HandlerInterceptor interceptor = interceptors[i];  
  25.       interceptor.postHandle(processedRequest, response, mappedHandler.getHandler(), mv);  
  26. }  
  27. }  
  28. //4、視圖的渲染  
  29. if (mv != null && !mv.wasCleared()) {  
  30. render(mv, processedRequest, response);  
  31.     if (errorView) {  
  32.         WebUtils.clearErrorRequestAttributes(request);  
  33. }  
  34. //5、觸發整個請求處理完畢回調方法afterCompletion  
  35. triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);  

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

 

java代碼：
查看 複製到剪貼板 打印
  1. // triggerAfterCompletion方法  
  2. private void triggerAfterCompletion(HandlerExecutionChain mappedHandler, int interceptorIndex,  
  3.             HttpServletRequest request, HttpServletResponse response, Exception ex) throws Exception {  
  4.         // 5、觸發整個請求處理完畢回調方法afterCompletion （逆序從1.2中的預處理成功的索引處的攔截器執行）  
  5.         if (mappedHandler != null) {  
  6.             HandlerInterceptor[] interceptors = mappedHandler.getInterceptors();  
  7.             if (interceptors != null) {  
  8.                 for (int i = interceptorIndex; i >= 0; i--) {  
  9.                     HandlerInterceptor interceptor = interceptors[i];  
  10.                     try {  
  11.                         interceptor.afterCompletion(request, response, mappedHandler.getHandler(), ex);  
  12.                     }  
  13.                     catch (Throwable ex2) {  
  14.                         logger.error("HandlerInterceptor.afterCompletion threw exception", ex2);  
  15.                     }  
  16.                 }  
  17.             }  
  18.         }  
  19.     }  

 

5.2、入門

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

5.2.1、正常流程

（1、攔截器實現

 

java代碼：
查看 複製到剪貼板 打印
  1. package cn.javass.chapter5.web.interceptor;  
  2. //省略import  
  3. public class HandlerInterceptor1 extends HandlerInterceptorAdapter {//此處一般繼承HandlerInterceptorAdapter適配器即可  
  4.     @Override  
  5.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {  
  6.         System.out.println("===========HandlerInterceptor1 preHandle");  
  7.         return true;  
  8.     }  
  9.     @Override  
  10.     public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {  
  11.         System.out.println("===========HandlerInterceptor1 postHandle");  
  12.     }  
  13.     @Override  
  14.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {  
  15.         System.out.println("===========HandlerInterceptor1 afterCompletion");  
  16.     }  
  17. }  

 

以上是HandlerInterceptor1實現，HandlerInterceptor2同理 只是輸出內容爲「HandlerInterceptor2」。

（2、控制器

 

java代碼：
查看 複製到剪貼板 打印
  1. package cn.javass.chapter5.web.controller;  
  2. //省略import  
  3. public class TestController implements Controller {  
  4.     @Override  
  5.     public ModelAndView handleRequest(HttpServletRequest req, HttpServletResponse resp) throws Exception {  
  6.         System.out.println("===========TestController");  
  7.         return new ModelAndView("test");  
  8.     }  
  9. }  

 

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

 

java代碼：
查看 複製到剪貼板 打印
  1. <bean name="/test" class="cn.javass.chapter5.web.controller.TestController"/>  
  2. <bean id="handlerInterceptor1"   
  3. class="cn.javass.chapter5.web.interceptor.HandlerInterceptor1"/>  
  4. <bean id="handlerInterceptor2"   
  5. class="cn.javass.chapter5.web.interceptor.HandlerInterceptor2"/>  
  6.    

 

java代碼：
查看 複製到剪貼板 打印
  1. <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">  
  2.     <property name="interceptors">  
  3.         <list>  
  4.            <ref bean="handlerInterceptor1"/>  
  5.           <ref bean="handlerInterceptor2"/>  
  6.         </list>  
  7.     </property>  
  8. </bean>  

 

 

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

 

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

 

java代碼：
查看 複製到剪貼板 打印
  1. <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>  
  2. <%System.out.println("==========test.jsp");%>  
  3. test page  

 

在控制檯輸出 test.jsp

 

（5、啓動服務器測試

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

控制檯輸出：

 

java代碼：
查看 複製到剪貼板 打印
  1. ===========HandlerInterceptor1 preHandle  
  2. ===========HandlerInterceptor2 preHandle  
  3. ===========TestController  
  4. ===========HandlerInterceptor2 postHandle  
  5. ===========HandlerInterceptor1 postHandle  
  6. ==========test.jsp  
  7. ===========HandlerInterceptor2 afterCompletion  
  8. ===========HandlerInterceptor1 afterCompletion  

 

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

5.2.2、中斷流程

（1、攔截器

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

 

java代碼：
查看 複製到剪貼板 打印
  1. @Override  
  2. public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {  
  3.     System.out.println("===========HandlerInterceptor1 preHandle");  
  4. onse.getWriter().print("break");//流程中斷的話需要我們進行響應的處理  
  5.     return false;//返回false表示流程中斷      

 

（2、控制器

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

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

 

java代碼：
查看 複製到剪貼板 打印
  1. <bean id="handlerInterceptor3"   
  2. class="cn.javass.chapter5.web.interceptor.HandlerInterceptor3"/>  
  3. <bean id="handlerInterceptor4"   
  4. class="cn.javass.chapter5.web.interceptor.HandlerInterceptor4"/>  
  5.    

 

java代碼：
查看 複製到剪貼板 打印
  1. <bean id="handlerInterceptor3"   
  2. class="cn.javass.chapter5.web.interceptor.HandlerInterceptor3"/>  
  3. <bean id="handlerInterceptor4"   
  4. class="cn.javass.chapter5.web.interceptor.HandlerInterceptor4"/>  
  5.    

 

java代碼：
查看 複製到剪貼板 打印
  1. <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">  
  2.     <property name="interceptors">  
  3.         <list>  
  4.            <ref bean="handlerInterceptor3"/>  
  5.           <ref bean="handlerInterceptor4"/>  
  6.         </list>  
  7.     </property>  
  8. </bean>  

 

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

 

（4、視圖頁面

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

（5、啓動服務器測試

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

控制檯輸出：

 

java代碼：
查看 複製到剪貼板 打印
  1. ===========HandlerInterceptor3 preHandle  
  2. ===========HandlerInterceptor4 preHandle  
  3. ===========HandlerInterceptor3 afterCompletion  

 

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

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

 

5.3、應用

5.3.1、性能監控

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

 

實現分析：

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

2、在結束請求處理之後記錄結束時間，即在攔截器的afterCompletion記錄結束實現，並用結束時間-開始時間得到這次請求的處理時間。

 

問題：

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

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

 

代碼實現：

 

java代碼：
查看 複製到剪貼板 打印
  1. package cn.javass.chapter5.web.interceptor;  
  2. public class StopWatchHandlerInterceptor extends HandlerInterceptorAdapter {  
  3.     private NamedThreadLocal<Long>  startTimeThreadLocal =   
  4. new NamedThreadLocal<Long>("StopWatch-StartTime");  
  5.     @Override  
  6.     public boolean preHandle(HttpServletRequest request, HttpServletResponse response,   
  7. Object handler) throws Exception {  
  8.         long beginTime = System.currentTimeMillis();//1、開始時間  
  9.         startTimeThreadLocal.set(beginTime);//線程綁定變量（該數據只有當前請求的線程可見）  
  10.         return true;//繼續流程  
  11.     }  
  12.       
  13.     @Override  
  14.     public void afterCompletion(HttpServletRequest request, HttpServletResponse response,   
  15. Object handler, Exception ex) throws Exception {  
  16.         long endTime = System.currentTimeMillis();//2、結束時間  
  17.         long beginTime = startTimeThreadLocal.get();//得到線程綁定的局部變量（開始時間）  
  18.         long consumeTime = endTime - beginTime;//3、消耗的時間  
  19.         if(consumeTime > 500) {//此處認爲處理時間超過500毫秒的請求爲慢請求  
  20.             //TODO 記錄到日誌文件  
  21.             System.out.println(  
  22. String.format("%s consume %d millis", request.getRequestURI(), consumeTime));  
  23.         }          
  24.     }  
  25. }  

 

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

 

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

 

5.3.2、登錄檢測

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

 

流程：

1、訪問需要登錄的資源時，由攔截器重定向到登錄頁面；

2、如果訪問的是登錄頁面，攔截器不應該攔截；

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

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

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

 

攔截器代碼如下所示：

 

java代碼：
查看 複製到剪貼板 打印
  1. @Override  
  2. public boolean preHandle(HttpServletRequest request, HttpServletResponse response,   
  3. Object handler) throws Exception {  
  4.     //1、請求到登錄頁面 放行  
  5.     if(request.getServletPath().startsWith(loginUrl)) {  
  6.         return true;  
  7.     }  
  8.           
  9.     //2、TODO 比如退出、首頁等頁面無需登錄，即此處要放行 允許遊客的請求  
  10.           
  11.     //3、如果用戶已經登錄 放行    
  12.     if(request.getSession().getAttribute("username") != null) {  
  13.         //更好的實現方式的使用cookie  
  14.         return true;  
  15.     }  
  16.           
  17.     //4、非法請求 即這些請求需要登錄後才能訪問  
  18.     //重定向到登錄頁面  
  19.     response.sendRedirect(request.getContextPath() + loginUrl);  
  20.     return false;  
  21. }  

 

提示：推薦能使用servlet規範中的過濾器Filter實現的功能就用Filter實現，因爲HandlerInteceptor只有在Spring Web MVC環境下才能使用，因此Filter是最通用的、最先應該使用的。如登錄這種攔截器最好使用Filter來實現。

 



私塾在線學習網原創內容（http://sishuok.com）

原創內容，轉載請註明私塾在線【http://sishuok.com/forum/blogPost/list/5934.html#19650】

該帖子包含附件，回覆帖子後即可下載附件。
联系我们 沪ICP备2021010478号-7