SpringMVC中使用Interceptor攔截器

          SpringMVC 中的Interceptor 攔截器也是相當重要和相當有用的，它的主要作用是攔截用戶的請求并進行相應的處理。比如通過它來進行權限驗證，或者是來判斷用戶是否登陸，或者是像12306 那樣子判斷當前時間是否是購票時間。

   一、定義Interceptor實現類

   SpringMVC 中的Interceptor 攔截請求是通過HandlerInterceptor 來實現的。在SpringMVC 中定義一個Interceptor 非常簡單，主要有兩種方式，第一種方式是要定義的Interceptor類要實現了Spring 的HandlerInterceptor 接口，或者是這個類繼承實現了HandlerInterceptor 接口的類，比如Spring 已經提供的實現了HandlerInterceptor 接口的抽象類HandlerInterceptorAdapter ；第二種方式是實現Spring的WebRequestInterceptor接口，或者是繼承實現了WebRequestInterceptor的類。

   （一）實現HandlerInterceptor接口

   HandlerInterceptor 接口中定義了三個方法，我們就是通過這三個方法來對用戶的請求進行攔截處理的。

   （1 ）preHandle (HttpServletRequest request, HttpServletResponse response, Object handle) 方法，顧名思義，該方法將在請求處理之前進行調用。SpringMVC 中的Interceptor 是鏈式的調用的，在一個應用中或者說是在一個請求中可以同時存在多個Interceptor 。每個Interceptor 的調用會依據它的聲明順序依次執行，而且最先執行的都是Interceptor 中的preHandle 方法，所以可以在這個方法中進行一些前置初始化操作或者是對當前請求的一個預處理，也可以在這個方法中進行一些判斷來決定請求是否要繼續進行下去。該方法的返回值是布爾值Boolean 類型的，當它返回為false 時，表示請求結束，后續的Interceptor 和Controller 都不會再執行；當返回值為true 時就會繼續調用下一個Interceptor 的preHandle 方法，如果已經是最后一個Interceptor 的時候就會是調用當前請求的Controller 方法。

   （2 ）postHandle (HttpServletRequest request, HttpServletResponse response, Object handle, ModelAndView modelAndView) 方法，由preHandle 方法的解釋我們知道這個方法包括后面要說到的afterCompletion 方法都只能是在當前所屬的Interceptor 的preHandle 方法的返回值為true 時才能被調用。postHandle 方法，顧名思義就是在當前請求進行處理之后，也就是Controller 方法調用之后執行，但是它會在DispatcherServlet 進行視圖返回渲染之前被調用，所以我們可以在這個方法中對Controller 處理之后的ModelAndView 對象進行操作。postHandle 方法被調用的方向跟preHandle 是相反的，也就是說先聲明的Interceptor 的postHandle 方法反而會后執行，這和Struts2 里面的Interceptor 的執行過程有點類型。Struts2 里面的Interceptor 的執行過程也是鏈式的，只是在Struts2 里面需要手動調用ActionInvocation 的invoke 方法來觸發對下一個Interceptor 或者是Action 的調用，然后每一個Interceptor 中在invoke 方法調用之前的內容都是按照聲明順序執行的，而invoke 方法之后的內容就是反向的。

   （3 ）afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handle, Exception ex) 方法，該方法也是需要當前對應的Interceptor 的preHandle 方法的返回值為true 時才會執行。顧名思義，該方法將在整個請求結束之后，也就是在DispatcherServlet 渲染了對應的視圖之后執行。這個方法的主要作用是用于進行資源清理工作的。

下面是一個簡單的代碼說明：

Java代碼  

1. import javax.servlet.http.HttpServletRequest;  
2. import javax.servlet.http.HttpServletResponse;  
3.   
4. import org.springframework.web.servlet.HandlerInterceptor;  
5. import org.springframework.web.servlet.ModelAndView;  
6.   
7. public class SpringMVCInterceptor implements HandlerInterceptor {  
8.   
9.   
10.     /** 
11.      * preHandle方法是進行處理器攔截用的，顧名思義，該方法將在Controller處理之前進行調用，SpringMVC中的Interceptor攔截器是鏈式的，可以同時存在 
12.      * 多個Interceptor，然后SpringMVC會根據聲明的前后順序一個接一個的執行，而且所有的Interceptor中的preHandle方法都會在 
13.      * Controller方法調用之前調用。SpringMVC的這種Interceptor鏈式結構也是可以進行中斷的，這種中斷方式是令preHandle的返 
14.      * 回值為false，當preHandle的返回值為false的時候整個請求就結束了。 
15.      */  
16.     @Override  
17.     public boolean preHandle(HttpServletRequest request,  
18.             HttpServletResponse response, Object handler) throws Exception {  
19.         // TODO Auto-generated method stub  
20.         return false;  
21.     }  
22.       
23.     /** 
24.      * 這個方法只會在當前這個Interceptor的preHandle方法返回值為true的時候才會執行。postHandle是進行處理器攔截用的，它的執行時間是在處理器進行處理之 
25.      * 后，也就是在Controller的方法調用之后執行，但是它會在DispatcherServlet進行視圖的渲染之前執行，也就是說在這個方法中你可以對ModelAndView進行操 
26.      * 作。這個方法的鏈式結構跟正常訪問的方向是相反的，也就是說先聲明的Interceptor攔截器該方法反而會后調用，這跟Struts2里面的攔截器的執行過程有點像， 
27.      * 只是Struts2里面的intercept方法中要手動的調用ActionInvocation的invoke方法，Struts2中調用ActionInvocation的invoke方法就是調用下一個Interceptor 
28.      * 或者是調用action，然后要在Interceptor之前調用的內容都寫在調用invoke之前，要在Interceptor之后調用的內容都寫在調用invoke方法之后。 
29.      */  
30.     @Override  
31.     public void postHandle(HttpServletRequest request,  
32.             HttpServletResponse response, Object handler,  
33.             ModelAndView modelAndView) throws Exception {  
34.         // TODO Auto-generated method stub  
35.           
36.     }  
37.   
38.     /** 
39.      * 該方法也是需要當前對應的Interceptor的preHandle方法的返回值為true時才會執行。該方法將在整個請求完成之后，也就是DispatcherServlet渲染了視圖執行， 
40.      * 這個方法的主要作用是用于清理資源的，當然這個方法也只能在當前這個Interceptor的preHandle方法的返回值為true時才會執行。 
41.      */  
42.     @Override  
43.     public void afterCompletion(HttpServletRequest request,  
44.             HttpServletResponse response, Object handler, Exception ex)  
45.     throws Exception {  
46.         // TODO Auto-generated method stub  
47.           
48.     }  
49.       
50. }  

   （二）實現WebRequestInterceptor 接口

  WebRequestInterceptor 中也定義了三個方法，我們也是通過這三個方法來實現攔截的。這三個方法都傳遞了同一個參數WebRequest ，那么這個WebRequest 是什么呢？這個WebRequest 是Spring 定義的一個接口，它里面的方法定義都基本跟HttpServletRequest 一樣，在WebRequestInterceptor 中對WebRequest 進行的所有操作都將同步到HttpServletRequest 中，然后在當前請求中一直傳遞。

   （1 ）preHandle(WebRequest request) 方法。該方法將在請求處理之前進行調用，也就是說會在Controller 方法調用之前被調用。這個方法跟HandlerInterceptor 中的preHandle 是不同的，主要區別在于該方法的返回值是void ，也就是沒有返回值，所以我們一般主要用它來進行資源的準備工作，比如我們在使用Hibernate 的時候可以在這個方法中準備一個Hibernate 的Session 對象，然后利用WebRequest 的setAttribute(name, value, scope) 把它放到WebRequest 的屬性中。這里可以說說這個setAttribute 方法的第三個參數scope ，該參數是一個Integer 類型的。在WebRequest 的父層接口RequestAttributes 中對它定義了三個常量：

   SCOPE_REQUEST ：它的值是0 ，代表只有在request 中可以訪問。

   SCOPE_SESSION ：它的值是1 ，如果環境允許的話它代表的是一個局部的隔離的session，否則就代表普通的session，并且在該session范圍內可以訪問。

   SCOPE_GLOBAL_SESSION ：它的值是2 ，如果環境允許的話，它代表的是一個全局共享的session，否則就代表普通的session，并且在該session 范圍內可以訪問。

   （2 ）postHandle(WebRequest request, ModelMap model) 方法。該方法將在請求處理之后，也就是在Controller 方法調用之后被調用，但是會在視圖返回被渲染之前被調用，所以可以在這個方法里面通過改變數據模型ModelMap 來改變數據的展示。該方法有兩個參數，WebRequest 對象是用于傳遞整個請求數據的，比如在preHandle 中準備的數據都可以通過WebRequest 來傳遞和訪問；ModelMap 就是Controller 處理之后返回的Model 對象，我們可以通過改變它的屬性來改變返回的Model 模型。

   （3 ）afterCompletion(WebRequest request, Exception ex) 方法。該方法會在整個請求處理完成，也就是在視圖返回并被渲染之后執行。所以在該方法中可以進行資源的釋放操作。而WebRequest 參數就可以把我們在preHandle 中準備的資源傳遞到這里進行釋放。Exception 參數表示的是當前請求的異常對象，如果在Controller 中拋出的異常已經被Spring 的異常處理器給處理了的話，那么這個異常對象就是是null 。

   下面是一個簡單的代碼說明：

Java代碼  

1. import org.springframework.ui.ModelMap;  
2. import org.springframework.web.context.request.WebRequest;  
3. import org.springframework.web.context.request.WebRequestInterceptor;  
4.   
5. public class AllInterceptor implements WebRequestInterceptor {  
6.       
7.     /** 
8.      * 在請求處理之前執行，該方法主要是用于準備資源數據的，然后可以把它們當做請求屬性放到WebRequest中 
9.      */  
10.     @Override  
11.     public void preHandle(WebRequest request) throws Exception {  
12.         // TODO Auto-generated method stub  
13.         System.out.println("AllInterceptor...............................");  
14.         request.setAttribute("request", "request", WebRequest.SCOPE_REQUEST);//這個是放到request范圍內的，所以只能在當前請求中的request中獲取到  
15.         request.setAttribute("session", "session", WebRequest.SCOPE_SESSION);//這個是放到session范圍內的，如果環境允許的話它只能在局部的隔離的會話中訪問，否則就是在普通的當前會話中可以訪問  
16.         request.setAttribute("globalSession", "globalSession", WebRequest.SCOPE_GLOBAL_SESSION);//如果環境允許的話，它能在全局共享的會話中訪問，否則就是在普通的當前會話中訪問  
17.     }  
18.   
19.     /** 
20.      * 該方法將在Controller執行之后，返回視圖之前執行，ModelMap表示請求Controller處理之后返回的Model對象，所以可以在 
21.      * 這個方法中修改ModelMap的屬性，從而達到改變返回的模型的效果。 
22.      */  
23.     @Override  
24.     public void postHandle(WebRequest request, ModelMap map) throws Exception {  
25.         // TODO Auto-generated method stub  
26.         for (String key:map.keySet())  
27.             System.out.println(key + "-------------------------");;  
28.         map.put("name3", "value3");  
29.         map.put("name1", "name1");  
30.     }  
31.   
32.     /** 
33.      * 該方法將在整個請求完成之后，也就是說在視圖渲染之后進行調用，主要用于進行一些資源的釋放 
34.      */  
35.     @Override  
36.     public void afterCompletion(WebRequest request, Exception exception)  
37.     throws Exception {  
38.         // TODO Auto-generated method stub  
39.         System.out.println(exception + "-=-=--=--=-=-=-=-=-=-=-=-==-=--=-=-=-=");  
40.     }  
41.       
42. }  

  二、把定義的攔截器類加到SpringMVC的攔截體系中

         1.在SpringMVC的配置文件中加上支持MVC的schema

Xml代碼  

1.     xmlns:mvc="http://www./schema/mvc"  
2.     xsi:schemaLocation=" http://www./schema/mvc  
3.         http://www./schema/mvc/spring-mvc-3.0.xsd"  

         下面是我的聲明示例：

Xml代碼  

1. <beans xmlns="http://www./schema/beans"  
2.     xmlns:xsi="http://www./2001/XMLSchema-instance" xmlns:context="http://www./schema/context"  
3.     xmlns:mvc="http://www./schema/mvc"  
4.     xsi:schemaLocation="http://www./schema/beans  
5.      http://www./schema/beans/spring-beans-3.0.xsd  
6.      http://www./schema/context  
7.      http://www./schema/context/spring-context-3.0.xsd  
8.      http://www./schema/mvc  
9.      http://www./schema/mvc/spring-mvc-3.0.xsd">  

         這樣在SpringMVC的配置文件中就可以使用mvc標簽了，mvc標簽中有一個mvc:interceptors是用于聲明SpringMVC的攔截器的。

        （二）使用mvc:interceptors標簽來聲明需要加入到SpringMVC攔截器鏈中的攔截器

Xml代碼  

1. <mvc:interceptors>  
2.     <!-- 使用bean定義一個Interceptor，直接定義在mvc:interceptors根下面的Interceptor將攔截所有的請求 -->  
3.     <bean class="com.host.app.web.interceptor.AllInterceptor"/>  
4.     <mvc:interceptor>  
5.         <mvc:mapping path="/test/number.do"/>  
6.         <!-- 定義在mvc:interceptor下面的表示是對特定的請求才進行攔截的 -->  
7.         <bean class="com.host.app.web.interceptor.LoginInterceptor"/>  
8.     </mvc:interceptor>  
9. </mvc:interceptors>  

          由上面的示例可以看出可以利用mvc:interceptors標簽聲明一系列的攔截器，然后它們就可以形成一個攔截器鏈，攔截器的執行順序是按聲明的先后順序執行的，先聲明的攔截器中的preHandle方法會先執行，然而它的postHandle方法和afterCompletion方法卻會后執行。

          在mvc:interceptors標簽下聲明interceptor主要有兩種方式：

                    （1）直接定義一個Interceptor實現類的bean對象。使用這種方式聲明的Interceptor攔截器將會對所有的請求進行攔截。

                    （2）使用mvc:interceptor標簽進行聲明。使用這種方式進行聲明的Interceptor可以通過mvc:mapping子標簽來定義需要進行攔截的請求路徑。

          經過上述兩步之后，定義的攔截器就會發生作用對特定的請求進行攔截了。

補充

    基于Spring4.1.0補充：

不知道從哪個版本開始，Spring MVC的mvc命名空間開始支持exclude-mapping。反正筆者最開始寫這篇博文的時候是基于Spring3.1.0所寫，那時候的mvc命名空間下是沒有execlude-mapping定義的。但是筆者現在使用的Spring4.1.0是有exclude-mapping定義的。所以基于該版本補充Spring MVC攔截器的exclude-mapping的用法。mapping只能映射某些需要攔截的請求，而exclude-mapping用來排除某些特定的請求映射。當我們需要攔截的請求映射是比較通用的，但是其中又包含了某個特殊的請求是不需要使用該攔截器的時候我們就可以把它定義為exclude-mapping了。比如像下面示例這樣，我們定義的攔截器將攔截所有匹配/interceptor/**模式的請求，但是不能攔截請求“/interceptor/b”，因為它定義為了exclude-mapping。當定義了exclude-mapping時，Spring MVC將優先判斷一個請求是否在execlude-mapping定義的范圍內，如果在則不進行攔截。

Xml代碼  

1. <mvc:interceptors>  
2.     <mvc:interceptor>  
3.         <mvc:mapping path="/interceptor/**" />  
4.         <mvc:exclude-mapping path="/interceptor/b" /><!--  
5.             不匹配的 -->  
6.         <bean class="com.host.app.web.interceptor.MyInterceptor" />  
7.     </mvc:interceptor>  
8. </mvc:interceptors>  

雖然筆者的示例中interceptor下面定義的mapping只有一個，但實際上一個interceptor下面定義的mapping和exclude-mapping都是可以有多個的。

另外，exclude-mapping的定義規則和mapping的定義規則是一樣的，我們也可以使用一個星號表示任意字符，使用兩個星號表示任意層次的任意字符。比如下面這樣。

Xml代碼  

1. <mvc:interceptors>  
2.     <mvc:interceptor>  
3.         <mvc:mapping path="/interceptor/**" />  
4.         <mvc:exclude-mapping path="/interceptor/b/*" /><!--  
5.             不匹配的 -->  
6.         <bean class="com.elim.learn.spring.mvc.interceptor.MyInterceptor" />  
7.     </mvc:interceptor>  
8. </mvc:interceptors>