本文研究的主要是SpringMVC中的攔截器的介紹及實例代碼，配置等內容，具體如下。
Springmvc的處理器攔截器類似于Servlet 開發中的過濾器Filter，用于對處理器進行預處理和后處理。本文主要總結一下springmvc中攔截器是如何定義的，以及測試攔截器的執行情況和使用方法。
1. springmvc攔截器的定義和配置
1.1 springmvc攔截器的定義
在springmvc中，定義攔截器要實現HandlerInterceptor接口，并實現該接口中提供的三個方法，如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
//測試攔截器1public class HandlerInterceptor1 implements HandlerInterceptor{ @Override public Boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { System.out.println("HandlerInterceptor1....preHandle"); //false表示攔截，不向下執行；true表示放行 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"); }} |
針對這三個方法，我做一下簡單的分析：
- preHandle方法：進入Handler方法之前執行。可以用于身份認證、身份授權。比如如果認證沒有通過表示用戶沒有登陸，需要此方法攔截不再往下執行（return false），否則就放行（return true）。
- postHandle方法：進入Handler方法之后，返回ModelAndView之前執行。可以看到該方法中有個modelAndView的形參。應用場景：從modelAndView出發：將公用的模型數據（比如菜單導航之類的）在這里傳到視圖，也可以在這里同一指定視圖。
- afterCompletion方法：執行Handler完成之后執行。應用場景：統一異常處理，統一日志處理等。
1.2 springmvc攔截器的配置
在springmvc中，攔截器是針對具體的HandlerMapping進行配置的，也就是說如果在某個HandlerMapping中配置攔截，經過該 HandlerMapping映射成功的handler最終使用該攔截器。比如，假設我們在配置文件中配置了的映射器是org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping，那么我們可以這樣來配置攔截器：
|
1
2
3
4
5
6
7
8
9
10
|
<bean class="org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping"> <property name="interceptors"> <list> <ref bean="handlerInterceptor1"/> <ref bean="handlerInterceptor2"/> </list> </property></bean><bean id="handlerInterceptor1" class="ssm.intercapter.HandlerInterceptor1"/><bean id="handlerInterceptor2" class="ssm.intercapter.HandlerInterceptor2"/> |
那么在springmvc中，如何配置類似于全局的攔截器呢？上面也說了，springmvc中的攔截器是針對具體的映射器的，為了解決這個問題，springmvc框架將配置的類似全局的攔截器注入到每個HandlerMapping中，這樣就可以成為全局的攔截器了。配置如下：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
<!-- 配置攔截器 --><mvc:interceptors> <!-- 多個攔截器，按順序執行 --> <mvc:interceptor> <mvc:mapping path="/**"/> <!-- 表示攔截所有的url包括子url路徑 --> <bean class="ssm.interceptor.HandlerInterceptor1"/> </mvc:interceptor> <mvc:interceptor> <mvc:mapping path="/**"/> <bean class="ssm.interceptor.HandlerInterceptor2"/> </mvc:interceptor> <mvc:interceptor> <mvc:mapping path="/**"/> <bean class="ssm.interceptor.HandlerInterceptor3"/> </mvc:interceptor></mvc:interceptors> |
一般我們都用這種配置，<mvc:mapping>中指定要攔截的url即可。
2. springmvc攔截器的執行測試
仿照上面的HandlerInterceptor1再寫兩個攔截器，HandlerInterceptor2和HandlerInterceptor3，配置是按照上面這個配置。然后我們來測試一下三個攔截器的執行情況，并做相關總結。
2.1 三個攔截器都放行
也就是說，我們將三個攔截器的preHandle方法中返回值都改成true，來測試一下攔截器的執行順序，測試結果如下：
HandlerInterceptor1….preHandle
HandlerInterceptor2….preHandle
HandlerInterceptor3….preHandleHandlerInterceptor3….postHandle
HandlerInterceptor2….postHandle
HandlerInterceptor1….postHandleHandlerInterceptor3….afterCompletion
HandlerInterceptor2….afterCompletion
HandlerInterceptor1….afterCompletion
根據打印的結果做一個總結：當所有攔截器都放行的時候，preHandle方法是按照配置的順序執的；而另外兩個方法按照配置的順序逆向執行的。
2.2 有一個攔截器不放行
我們將第三個攔截器的preHandle方法中返回值改成false，前兩個還是true，來測試一下攔截器的執行順序，測試結果如下：
HandlerInterceptor1….preHandle
HandlerInterceptor2….preHandle
HandlerInterceptor3….preHandleHandlerInterceptor2….afterCompletion
HandlerInterceptor1….afterCompletion
根據打印的結果做一個總結：
1. 由于攔截器1和2放行，所以攔截器3的preHandle才能執行。也就是說前面的攔截器放行，后面的攔截器才能執行preHandle。
2. 攔截器3不放行，所以其另外兩個方法沒有被執行。即如果某個攔截器不放行，那么它的另外兩個方法就不會背執行。
3. 只要有一個攔截器不放行，所有攔截器的postHandle方法都不會執行，但是只要執行過preHandle并且放行的，就會執行afterCompletion方法。
2.3 三個攔截器都不放行
這種情況其實可以參考上面的情況了，是一個特例，也看一下運行結果：
HandlerInterceptor1….preHandle
很明顯，就只執行了第一個攔截器的preHandle方法，因為都不放行，所以沒有一個執行postHandle方法和afterCompletion方法。
3. 攔截器的使用
從第二種情況來看，比如現在要寫一個統一異常處理的邏輯，那么要將該攔截器放在攔截器鏈的第一個位置，且一定要放行，因為只有放行了，才會去執行afterCompletion，而且放在攔截器鏈的第一個的話，afterCompletion方法會最后執行，才能在里面執行統一異常處理的邏輯。
再比如，登陸認證攔截器，放在攔截器鏈接中第一個位置（如果有統一異常處理，那么應該放在統一異常處理的后面）。權限校驗攔截器，放在登陸認證攔截器之后（因為登陸通過后才校驗權限）。
這里寫一個登陸驗證的攔截器來說明一下如何使用springmvc的攔截器。
3.1 需求
首先看一下需求：我們要攔截啥，攔截到了要干啥。思路如下：
1、用戶請求url
2、攔截器進行攔截校驗
如果請求的url是公開地址（無需登陸即可訪問的url），讓放行。
如果用戶session不存在，則跳轉到登陸頁面。
如果用戶session存在則放行，繼續操作。
3.2 實現登陸的Controller方法
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
|
//登陸@RequestMapping("/login")public String login(HttpServletRequest request, String username, String password) throws Exception { //實際中要去和數據庫匹配的 //.... //這里就假設登陸成功了 HttpSession session = request.getSession(); session.setAttribute("username", username); return "redirect:queryItems.action";}//退出@RequestMapping("/logout")public String logout(HttpServletRequest request) throws Exception { HttpSession session = request.getSession(); session.invalidate(); return "redirect:queryItems.action";} |
3.3 登陸驗證攔截器的實現
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
|
//測試攔截器1public class LoginInterceptor implements HandlerInterceptor{ //進入Handler方法之前執行 //可以用于身份認證、身份授權。如果認證沒有通過表示用戶沒有登陸，需要此方法攔截不再往下執行，否則就放行 @Override public Boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception { //獲取請求的url String url = request.getRequestURI(); //判斷url是否公開地址（實際使用時將公開地址配置到配置文件中） //這里假設公開地址是否登陸提交的地址 if(url.indexOf("login.action") > 0) { //如果進行登陸提交，放行 return true; } //判斷session HttpSession session = request.getSession(); //從session中取出用戶身份信息 String username = (String) session.getAttribute("username"); if(username != null) { return true; } //執行到這里表示用戶身份需要驗證，跳轉到登陸頁面 request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request, response); return false; } //節省空間，省略另外兩個方法不寫了，也不用處理} |
然后配置該攔截器：
|
1
2
3
4
5
6
7
8
9
|
<!-- 配置攔截器 --><mvc:interceptors> <!-- 多個攔截器，按順序執行 --> <mvc:interceptor> <mvc:mapping path="/**"/> <!-- 攔截所有的url包括子url路徑 --> <bean class="ssm.interceptor.LoginInterceptor"/> </mvc:interceptor> <!-- 其他攔截器 --></mvc:interceptors> |
這樣當我們任意請求一個url的時候，就會被剛剛我們定義的攔截器給捕獲到，然后會判斷是否session中有用戶信息，沒有的話就會跳到登陸頁面讓我們登陸：
|
1
2
3
4
5
|
<form action="${pageContext.request.contextPath }/login.action" method="post"> 用戶名：<input type="text" name="username" /><br> 密碼：<input type="password" name="password" /><br> <input type="submit" name="提交" /></form> |
攔截器的使用基本上就介紹到這了。
總結
以上就是本文關于SpringMVC中的攔截器詳解及代碼示例的全部內容，希望對大家有所幫助。感興趣的朋友可以繼續參閱本站其他相關專題，如有不足之處，歡迎留言指出。感謝朋友們對本站的支持！
原文鏈接：http://blog.csdn.net/eson_15/article/details/51749880
