SpringMVC中的攔截器詳解及代碼示例
本文研究的主要是SpringMVC中的攔截器的介紹及實(shí)例代碼,配置等內(nèi)容,具體如下。
Springmvc的處理器攔截器類似于Servlet 開發(fā)中的過(guò)濾器Filter,用于對(duì)處理器進(jìn)行預(yù)處理和后處理。本文主要總結(jié)一下springmvc中攔截器是如何定義的,以及測(cè)試攔截器的執(zhí)行情況和使用方法。
1. springmvc攔截器的定義和配置
1.1 springmvc攔截器的定義
在springmvc中,定義攔截器要實(shí)現(xiàn)HandlerInterceptor接口,并實(shí)現(xiàn)該接口中提供的三個(gè)方法,如下:
//測(cè)試攔截器1
public class HandlerInterceptor1 implements HandlerInterceptor{
@Override
public Boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler) throws Exception {
System.out.println("HandlerInterceptor1....preHandle");
//false表示攔截,不向下執(zhí)行;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");
}
}
針對(duì)這三個(gè)方法,我做一下簡(jiǎn)單的分析:
- preHandle方法:進(jìn)入Handler方法之前執(zhí)行??梢杂糜谏矸菡J(rèn)證、身份授權(quán)。比如如果認(rèn)證沒(méi)有通過(guò)表示用戶沒(méi)有登陸,需要此方法攔截不再往下執(zhí)行(return false),否則就放行(return true)。
- postHandle方法:進(jìn)入Handler方法之后,返回ModelAndView之前執(zhí)行??梢钥吹皆摲椒ㄖ杏袀€(gè)modelAndView的形參。應(yīng)用場(chǎng)景:從modelAndView出發(fā):將公用的模型數(shù)據(jù)(比如菜單導(dǎo)航之類的)在這里傳到視圖,也可以在這里同一指定視圖。
- afterCompletion方法:執(zhí)行Handler完成之后執(zhí)行。應(yīng)用場(chǎng)景:統(tǒng)一異常處理,統(tǒng)一日志處理等。
1.2 springmvc攔截器的配置
在springmvc中,攔截器是針對(duì)具體的HandlerMapping進(jìn)行配置的,也就是說(shuō)如果在某個(gè)HandlerMapping中配置攔截,經(jīng)過(guò)該 HandlerMapping映射成功的handler最終使用該攔截器。比如,假設(shè)我們?cè)谂渲梦募信渲昧说挠成淦魇莖rg.springframework.web.servlet.handler.BeanNameUrlHandlerMapping,那么我們可以這樣來(lái)配置攔截器:
<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中,如何配置類似于全局的攔截器呢?上面也說(shuō)了,springmvc中的攔截器是針對(duì)具體的映射器的,為了解決這個(gè)問(wèn)題,springmvc框架將配置的類似全局的攔截器注入到每個(gè)HandlerMapping中,這樣就可以成為全局的攔截器了。配置如下:
<!-- 配置攔截器 -->
<mvc:interceptors>
<!-- 多個(gè)攔截器,按順序執(zhí)行 -->
<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攔截器的執(zhí)行測(cè)試
仿照上面的HandlerInterceptor1再寫兩個(gè)攔截器,HandlerInterceptor2和HandlerInterceptor3,配置是按照上面這個(gè)配置。然后我們來(lái)測(cè)試一下三個(gè)攔截器的執(zhí)行情況,并做相關(guān)總結(jié)。
2.1 三個(gè)攔截器都放行
也就是說(shuō),我們將三個(gè)攔截器的preHandle方法中返回值都改成true,來(lái)測(cè)試一下攔截器的執(zhí)行順序,測(cè)試結(jié)果如下:
HandlerInterceptor1….preHandle
HandlerInterceptor2….preHandle
HandlerInterceptor3….preHandleHandlerInterceptor3….postHandle
HandlerInterceptor2….postHandle
HandlerInterceptor1….postHandleHandlerInterceptor3….afterCompletion
HandlerInterceptor2….afterCompletion
HandlerInterceptor1….afterCompletion
根據(jù)打印的結(jié)果做一個(gè)總結(jié):當(dāng)所有攔截器都放行的時(shí)候,preHandle方法是按照配置的順序執(zhí)的;而另外兩個(gè)方法按照配置的順序逆向執(zhí)行的。
2.2 有一個(gè)攔截器不放行
我們將第三個(gè)攔截器的preHandle方法中返回值改成false,前兩個(gè)還是true,來(lái)測(cè)試一下攔截器的執(zhí)行順序,測(cè)試結(jié)果如下:
HandlerInterceptor1….preHandle
HandlerInterceptor2….preHandle
HandlerInterceptor3….preHandleHandlerInterceptor2….afterCompletion
HandlerInterceptor1….afterCompletion
根據(jù)打印的結(jié)果做一個(gè)總結(jié):
1. 由于攔截器1和2放行,所以攔截器3的preHandle才能執(zhí)行。也就是說(shuō)前面的攔截器放行,后面的攔截器才能執(zhí)行preHandle。
2. 攔截器3不放行,所以其另外兩個(gè)方法沒(méi)有被執(zhí)行。即如果某個(gè)攔截器不放行,那么它的另外兩個(gè)方法就不會(huì)背執(zhí)行。
3. 只要有一個(gè)攔截器不放行,所有攔截器的postHandle方法都不會(huì)執(zhí)行,但是只要執(zhí)行過(guò)preHandle并且放行的,就會(huì)執(zhí)行afterCompletion方法。
2.3 三個(gè)攔截器都不放行
這種情況其實(shí)可以參考上面的情況了,是一個(gè)特例,也看一下運(yùn)行結(jié)果:
HandlerInterceptor1….preHandle
很明顯,就只執(zhí)行了第一個(gè)攔截器的preHandle方法,因?yàn)槎疾环判?,所以沒(méi)有一個(gè)執(zhí)行postHandle方法和afterCompletion方法。
3. 攔截器的使用
從第二種情況來(lái)看,比如現(xiàn)在要寫一個(gè)統(tǒng)一異常處理的邏輯,那么要將該攔截器放在攔截器鏈的第一個(gè)位置,且一定要放行,因?yàn)橹挥蟹判辛耍艜?huì)去執(zhí)行afterCompletion,而且放在攔截器鏈的第一個(gè)的話,afterCompletion方法會(huì)最后執(zhí)行,才能在里面執(zhí)行統(tǒng)一異常處理的邏輯。
再比如,登陸認(rèn)證攔截器,放在攔截器鏈接中第一個(gè)位置(如果有統(tǒng)一異常處理,那么應(yīng)該放在統(tǒng)一異常處理的后面)。權(quán)限校驗(yàn)攔截器,放在登陸認(rèn)證攔截器之后(因?yàn)榈顷懲ㄟ^(guò)后才校驗(yàn)權(quán)限)。
這里寫一個(gè)登陸驗(yàn)證的攔截器來(lái)說(shuō)明一下如何使用springmvc的攔截器。
3.1 需求
首先看一下需求:我們要攔截啥,攔截到了要干啥。思路如下:
1、用戶請(qǐng)求url
2、攔截器進(jìn)行攔截校驗(yàn)
如果請(qǐng)求的url是公開地址(無(wú)需登陸即可訪問(wèn)的url),讓放行。
如果用戶session不存在,則跳轉(zhuǎn)到登陸頁(yè)面。
如果用戶session存在則放行,繼續(xù)操作。
3.2 實(shí)現(xiàn)登陸的Controller方法
//登陸
@RequestMapping("/login")
public String login(HttpServletRequest request, String username, String password) throws Exception {
//實(shí)際中要去和數(shù)據(jù)庫(kù)匹配的
//....
//這里就假設(shè)登陸成功了
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 登陸驗(yàn)證攔截器的實(shí)現(xiàn)
//測(cè)試攔截器1
public class LoginInterceptor implements HandlerInterceptor{
//進(jìn)入Handler方法之前執(zhí)行
//可以用于身份認(rèn)證、身份授權(quán)。如果認(rèn)證沒(méi)有通過(guò)表示用戶沒(méi)有登陸,需要此方法攔截不再往下執(zhí)行,否則就放行
@Override
public Boolean preHandle(HttpServletRequest request,
HttpServletResponse response, Object handler) throws Exception {
//獲取請(qǐng)求的url
String url = request.getRequestURI();
//判斷url是否公開地址(實(shí)際使用時(shí)將公開地址配置到配置文件中)
//這里假設(shè)公開地址是否登陸提交的地址
if(url.indexOf("login.action") > 0) {
//如果進(jìn)行登陸提交,放行
return true;
}
//判斷session
HttpSession session = request.getSession();
//從session中取出用戶身份信息
String username = (String) session.getAttribute("username");
if(username != null) {
return true;
}
//執(zhí)行到這里表示用戶身份需要驗(yàn)證,跳轉(zhuǎn)到登陸頁(yè)面
request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request, response);
return false;
}
//節(jié)省空間,省略另外兩個(gè)方法不寫了,也不用處理
}
然后配置該攔截器:
<!-- 配置攔截器 -->
<mvc:interceptors>
<!-- 多個(gè)攔截器,按順序執(zhí)行 -->
<mvc:interceptor>
<mvc:mapping path="/**"/> <!-- 攔截所有的url包括子url路徑 -->
<bean class="ssm.interceptor.LoginInterceptor"/>
</mvc:interceptor>
<!-- 其他攔截器 -->
</mvc:interceptors>
這樣當(dāng)我們?nèi)我庹?qǐng)求一個(gè)url的時(shí)候,就會(huì)被剛剛我們定義的攔截器給捕獲到,然后會(huì)判斷是否session中有用戶信息,沒(méi)有的話就會(huì)跳到登陸頁(yè)面讓我們登陸:
<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>
攔截器的使用基本上就介紹到這了。
總結(jié)
以上就是本文關(guān)于SpringMVC中的攔截器詳解及代碼示例的全部?jī)?nèi)容,希望對(duì)大家有所幫助。感興趣的朋友可以繼續(xù)參閱本站其他相關(guān)專題,如有不足之處,歡迎留言指出。感謝朋友們對(duì)本站的支持!
相關(guān)文章
詳解Java多線程編程中CountDownLatch阻塞線程的方法
在Java中和ReadWriteLock.ReadLock一樣,CountDownLatch的本質(zhì)也是一個(gè)"共享鎖",這里我們就來(lái)詳解Java多線程編程中CountDownLatch阻塞線程的方法:2016-07-07
如何解決java:錯(cuò)誤:無(wú)效的源發(fā)行版:17問(wèn)題
這篇文章主要介紹了如何解決java:錯(cuò)誤:無(wú)效的源發(fā)行版:17問(wèn)題,具有很好的參考價(jià)值,希望對(duì)大家有所幫助,如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2024-07-07
基于Java代碼實(shí)現(xiàn)數(shù)字在數(shù)組中出現(xiàn)次數(shù)超過(guò)一半
這篇文章主要介紹了基于Java代碼實(shí)現(xiàn)數(shù)字在數(shù)組中出現(xiàn)次數(shù)超過(guò)一半的相關(guān)資料,需要的朋友可以參考下2016-02-02
舉例講解Java設(shè)計(jì)模式編程中模板方法模式的運(yùn)用實(shí)例
這篇文章主要介紹了Java設(shè)計(jì)模式編程中模板方法模式的運(yùn)用實(shí)例,模板方法模式強(qiáng)調(diào)基于繼承的代碼復(fù)用,需要的朋友可以參考下2016-05-05
利用Mybatis?Plus實(shí)現(xiàn)一個(gè)SQL攔截器
SQL攔截器是一種用于攔截和修改Mybatis執(zhí)行的SQL語(yǔ)句的工具,通過(guò)使用SQL攔截器,開發(fā)人員可以在執(zhí)行SQL語(yǔ)句之前或之后對(duì)其進(jìn)行修改或記錄,本文就來(lái)借助一下Mybatis-Plus實(shí)現(xiàn)一個(gè)SQL攔截器吧2023-05-05
Java數(shù)據(jù)結(jié)構(gòu)之線段樹的原理與實(shí)現(xiàn)
線段樹是一種二叉搜索樹,是用來(lái)維護(hù)區(qū)間信息的數(shù)據(jù)結(jié)構(gòu)。本文將利用示例詳細(xì)講講Java數(shù)據(jù)結(jié)構(gòu)中線段樹的原理與實(shí)現(xiàn),需要的可以參考一下2022-06-06

