SpringMVC處理器攔截器詳解
處理器攔截器簡介
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程式碼: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.3、攔截器介面卡
有時候我們可能只需要實現三個回撥方法中的某一個,如果實現
HandlerInterceptor介面的話,三個方法必須實現,不管你需不需要,此時spring提供了一個HandlerInterceptorAdapter介面卡(一種介面卡設計模式的實現),允許我們只實現需要的回撥方法。
java程式碼:Java程式碼
- public abstract class HandlerInterceptorAdapter implements HandlerInterceptor {
- //省略程式碼 此處所以三個回撥方法都是空實現,preHandle返回true。
- }
5.1.4、執行流程圖
圖5-1 正常流程
圖5-2 中斷流程
中斷流程中,比如是HandlerInterceptor2中斷的流程(preHandle返回false),此處僅呼叫它之前攔截器的preHandle返回true的afterCompletion方法。
接下來看一下DispatcherServlet內部到底是如何工作的吧:
java程式碼:Java程式碼
- //doDispatch方法
- //1、處理器攔截器的預處理(正序執行)
- 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.1、失敗時觸發afterCompletion的呼叫
- triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);
- return;
- }
- interceptorIndex = i;//1.2、記錄當前預處理成功的索引
- }
- }
- //2、處理器介面卡呼叫我們的處理器
- mv = ha.handle(processedRequest, response, mappedHandler.getHandler());
- //當我們返回null或沒有返回邏輯檢視名時的預設檢視名翻譯(詳解4.15.5 RequestToViewNameTranslator)
- if (mv != null && !mv.hasView()) {
- mv.setViewName(getDefaultViewName(request));
- }
- //3、處理器攔截器的後處理(逆序)
- if (interceptors != null) {
- for (int i = interceptors.length - 1; i >= 0; i--) {
- HandlerInterceptor interceptor = interceptors[i];
- interceptor.postHandle(processedRequest, response, mappedHandler.getHandler(), mv);
- }
- }
- //4、檢視的渲染
- if (mv != null && !mv.wasCleared()) {
- render(mv, processedRequest, response);
- if (errorView) {
- WebUtils.clearErrorRequestAttributes(request);
- }
- //5、觸發整個請求處理完畢回撥方法afterCompletion
- triggerAfterCompletion(mappedHandler, interceptorIndex, processedRequest, response, null);
注:以上是流程的簡化程式碼,中間省略了部分程式碼,不完整。
java程式碼:Java程式碼
- // triggerAfterCompletion方法
- private void triggerAfterCompletion(HandlerExecutionChain mappedHandler, int interceptorIndex,
- HttpServletRequest request, HttpServletResponse response, Exception ex) throws Exception {
- // 5、觸發整個請求處理完畢回撥方法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.1、正常流程
(1、攔截器實現
java程式碼: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”。
(2、控制器
java程式碼: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");
- }
- }
(3、Spring配置檔案chapter5-servlet.xml
java程式碼: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程式碼:Java程式碼
- <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">
- <property name="interceptors">
- <list>
- <ref bean="handlerInterceptor1"/>
- <ref bean="handlerInterceptor2"/>
- </list>
- </property>
- </bean>
interceptors:指定攔截器鏈,攔截器的執行順序就是此處新增攔截器的順序;
(4、檢視頁面WEB-INF/jsp/test.jsp
java程式碼:Java程式碼
- <%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>
- <%System.out.println("==========test.jsp");%>
- test page
在控制檯輸出 test.jsp
(5、啟動伺服器測試
輸入網址:http://localhost:9080/springmvc-chapter5/test
控制檯輸出:
java程式碼:Java程式碼
- ===========HandlerInterceptor1 preHandle
- ===========HandlerInterceptor2 preHandle
- ===========TestController
- ===========HandlerInterceptor2 postHandle
- ===========HandlerInterceptor1 postHandle
- ==========test.jsp
- ===========HandlerInterceptor2 afterCompletion
- ===========HandlerInterceptor1 afterCompletion
到此一個正常流程的演示完畢。和圖5-1一樣,接下來看一下中斷的流程。
5.2.2、中斷流程
(1、攔截器
HandlerInterceptor3和HandlerInterceptor4 與 之前的 HandlerInteceptor1和HandlerInterceptor2一樣,只是在HandlerInterceptor4的preHandle方法返回false:
java程式碼: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表示流程中斷
(2、控制器
流程中斷不會執行到控制器,使用之前的TestController控制器。
(3、Spring配置檔案chapter5-servlet.xml
java程式碼:Java程式碼
- <bean id="handlerInterceptor3"
- class="cn.javass.chapter5.web.interceptor.HandlerInterceptor3"/>
- <bean id="handlerInterceptor4"
- class="cn.javass.chapter5.web.interceptor.HandlerInterceptor4"/>
java程式碼:Java程式碼
- <bean id="handlerInterceptor3"
- class="cn.javass.chapter5.web.interceptor.HandlerInterceptor3"/>
- <bean id="handlerInterceptor4"
- class="cn.javass.chapter5.web.interceptor.HandlerInterceptor4"/>
java程式碼:Java程式碼
- <bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping">
- <property name="interceptors">
- <list>
- <ref bean="handlerInterceptor3"/>
- <ref bean="handlerInterceptor4"/>
- </list>
- </property>
- </bean>
interceptors:指定攔截器鏈,攔截器的執行順序就是此處新增攔截器的順序;
(4、檢視頁面
流程中斷,不會執行到檢視渲染。
(5、啟動伺服器測試
輸入網址:http://localhost:9080/springmvc-chapter5/test
控制檯輸出:
java程式碼:Java程式碼
- ===========HandlerInterceptor3 preHandle
- ===========HandlerInterceptor4 preHandle
- ===========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程式碼: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();//1、開始時間
- startTimeThreadLocal.set(beginTime);//執行緒繫結變數(該資料只有當前請求的執行緒可見)
- return true;//繼續流程
- }
- @Override
- public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
- Object handler, Exception ex) throws Exception {
- long endTime = System.currentTimeMillis();//2、結束時間
- long beginTime = startTimeThreadLocal.get();//得到執行緒繫結的區域性變數(開始時間)
- long consumeTime = endTime - beginTime;//3、消耗的時間
- if(consumeTime > 500) {//此處認為處理時間超過500毫秒的請求為慢請求
- //TODO 記錄到日誌檔案
- System.out.println(
- String.format("%s consume %d millis", request.getRequestURI(), consumeTime));
- }
- }
- }
NamedThreadLocal:Spring提供的一個命名的ThreadLocal實現。
在測試時需要把stopWatchHandlerInterceptor放在攔截器鏈的第一個,這樣得到的時間才是比較準確的。
5.3.2、登入檢測
在訪問某些資源時(如訂單頁面),需要使用者登入後才能檢視,因此需要進行登入檢測。
流程:
1、訪問需要登入的資源時,由攔截器重定向到登入頁面;
2、如果訪問的是登入頁面,攔截器不應該攔截;
3、使用者登入成功後,往cookie/session新增登入成功的標識(如使用者編號);
4、下次請求時,攔截器通過判斷cookie/session中是否有該標識來決定繼續流程還是到登入頁面;
5、在此攔截器還應該允許遊客訪問的資源。
攔截器程式碼如下所示:
java程式碼:Java程式碼
- @Override
- public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
- Object handler) throws Exception {
- //1、請求到登入頁面 放行
- if(request.getServletPath().startsWith(loginUrl)) {
- return true;
- }
- //2、TODO 比如退出、首頁等頁面無需登入,即此處要放行 允許遊客的請求
- //3、如果使用者已經登入 放行
- if(request.getSession().getAttribute("username") != null) {
- //更好的實現方式的使用cookie
- return true;
- }
- //4、非法請求 即這些請求需要登入後才能訪問
- //重定向到登入頁面
- response.sendRedirect(request.getContextPath() + loginUrl);
- return false;
- }
提示:推薦能使用servlet規範中的過濾器Filter實現的功能就用Filter實現,因為HandlerInteceptor只有在Spring Web MVC環境下才能使用,因此Filter是最通用的、最先應該使用的。如登入這種攔截器最好使用Filter來實現