springmvc 的攔截器

Springmvc的處理器攔截器類似于Servlet 開發(fā)中的過濾器Filter,用于對處理器進(jìn)行預(yù)處理和后處理。本文主要總結(jié)一下springmvc中攔截器是如何定義的,以及測試攔截器的執(zhí)行情況和使用方法。

1. springmvc攔截器的定義和配置

1.1 springmvc攔截器的定義

  在springmvc中,定義攔截器要實(shí)現(xiàn)HandlerInterceptor接口,并實(shí)現(xiàn)該接口中提供的三個方法,如下:

//測試攔截器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");

? ? }

}

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

29

30

  針對這三個方法,我做一下簡單的分析:

preHandle方法:進(jìn)入Handler方法之前執(zhí)行??梢杂糜谏矸菡J(rèn)證、身份授權(quán)。比如如果認(rèn)證沒有通過表示用戶沒有登陸,需要此方法攔截不再往下執(zhí)行(return false),否則就放行(return true)。

postHandle方法:進(jìn)入Handler方法之后,返回ModelAndView之前執(zhí)行??梢钥吹皆摲椒ㄖ杏袀€modelAndView的形參。應(yīng)用場景:從modelAndView出發(fā):將公用的模型數(shù)據(jù)(比如菜單導(dǎo)航之類的)在這里傳到視圖,也可以在這里同一指定視圖。

afterCompletion方法:執(zhí)行Handler完成之后執(zhí)行。應(yīng)用場景:統(tǒng)一異常處理,統(tǒng)一日志處理等。

1.2 springmvc攔截器的配置

  在springmvc中,攔截器是針對具體的HandlerMapping進(jìn)行配置的,也就是說如果在某個HandlerMapping中配置攔截,經(jīng)過該 HandlerMapping映射成功的handler最終使用該攔截器。比如,假設(shè)我們在配置文件中配置了的映射器是org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping,那么我們可以這樣來配置攔截器:

<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"/>

1

2

3

4

5

6

7

8

9

10

  那么在springmvc中,如何配置類似于全局的攔截器呢?上面也說了,springmvc中的攔截器是針對具體的映射器的,為了解決這個問題,springmvc框架將配置的類似全局的攔截器注入到每個HandlerMapping中,這樣就可以成為全局的攔截器了。配置如下:

<!-- 配置攔截器 -->

<mvc:interceptors>

? ? <!-- 多個攔截器,按順序執(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>

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

  一般我們都用這種配置,<mvc:mapping>中指定要攔截的url即可。

2. springmvc攔截器的執(zhí)行測試

  仿照上面的HandlerInterceptor1再寫兩個攔截器,HandlerInterceptor2和HandlerInterceptor3,配置是按照上面這個配置。然后我們來測試一下三個攔截器的執(zhí)行情況,并做相關(guān)總結(jié)。

2.1 三個攔截器都放行

  也就是說,我們將三個攔截器的preHandle方法中返回值都改成true,來測試一下攔截器的執(zhí)行順序,測試結(jié)果如下:

HandlerInterceptor1….preHandle

HandlerInterceptor2….preHandle

HandlerInterceptor3….preHandle

HandlerInterceptor3….postHandle

HandlerInterceptor2….postHandle

HandlerInterceptor1….postHandle

HandlerInterceptor3….afterCompletion

HandlerInterceptor2….afterCompletion

HandlerInterceptor1….afterCompletion

  根據(jù)打印的結(jié)果做一個總結(jié):當(dāng)所有攔截器都放行的時候,preHandle方法是按照配置的順序執(zhí)的;而另外兩個方法按照配置的順序逆向執(zhí)行的。

2.2 有一個攔截器不放行

  我們將第三個攔截器的preHandle方法中返回值改成false,前兩個還是true,來測試一下攔截器的執(zhí)行順序,測試結(jié)果如下:

HandlerInterceptor1….preHandle

HandlerInterceptor2….preHandle

HandlerInterceptor3….preHandle

HandlerInterceptor2….afterCompletion

HandlerInterceptor1….afterCompletion

根據(jù)打印的結(jié)果做一個總結(jié):

  1. 由于攔截器1和2放行,所以攔截器3的preHandle才能執(zhí)行。也就是說前面的攔截器放行,后面的攔截器才能執(zhí)行preHandle。

  2. 攔截器3不放行,所以其另外兩個方法沒有被執(zhí)行。即如果某個攔截器不放行,那么它的另外兩個方法就不會背執(zhí)行。

  3. 只要有一個攔截器不放行,所有攔截器的postHandle方法都不會執(zhí)行,但是只要執(zhí)行過preHandle并且放行的,就會執(zhí)行afterCompletion方法。

2.3 三個攔截器都不放行

  這種情況其實(shí)可以參考上面的情況了,是一個特例,也看一下運(yùn)行結(jié)果:

HandlerInterceptor1….preHandle

  很明顯,就只執(zhí)行了第一個攔截器的preHandle方法,因?yàn)槎疾环判?,所以沒有一個執(zhí)行postHandle方法和afterCompletion方法。

3. 攔截器的使用

  從第二種情況來看,比如現(xiàn)在要寫一個統(tǒng)一異常處理的邏輯,那么要將該攔截器放在攔截器鏈的第一個位置,且一定要放行,因?yàn)橹挥蟹判辛耍艜?zhí)行afterCompletion,而且放在攔截器鏈的第一個的話,afterCompletion方法會最后執(zhí)行,才能在里面執(zhí)行統(tǒng)一異常處理的邏輯。

  再比如,登陸認(rèn)證攔截器,放在攔截器鏈接中第一個位置(如果有統(tǒng)一異常處理,那么應(yīng)該放在統(tǒng)一異常處理的后面)。權(quán)限校驗(yàn)攔截器,放在登陸認(rèn)證攔截器之后(因?yàn)榈顷懲ㄟ^后才校驗(yàn)權(quán)限)。

  這里寫一個登陸驗(yàn)證的攔截器來說明一下如何使用springmvc的攔截器。

3.1 需求

  首先看一下需求:我們要攔截啥,攔截到了要干啥。思路如下:

1、用戶請求url

2、攔截器進(jìn)行攔截校驗(yàn)

如果請求的url是公開地址(無需登陸即可訪問的url),讓放行。

如果用戶session不存在,則跳轉(zhuǎn)到登陸頁面。

如果用戶session存在則放行,繼續(xù)操作。

3.2 實(shí)現(xiàn)登陸的Controller方法

//登陸

@RequestMapping("/login")

public String login(HttpServletRequest request, String username, String password) throws Exception {

? ? //實(shí)際中要去和數(shù)據(jù)庫匹配的

? ? //....

? ? //這里就假設(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";

}

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

3.2 登陸驗(yàn)證攔截器的實(shí)現(xiàn)

//測試攔截器1

public class LoginInterceptor implements HandlerInterceptor{

? ? //進(jìn)入Handler方法之前執(zhí)行

? ? //可以用于身份認(rèn)證、身份授權(quán)。如果認(rèn)證沒有通過表示用戶沒有登陸,需要此方法攔截不再往下執(zhí)行,否則就放行

? ? @Override

? ? public boolean preHandle(HttpServletRequest request,

? ? ? ? ? ? HttpServletResponse response, Object handler) throws Exception {

? ? ? ? //獲取請求的url

? ? ? ? String url = request.getRequestURI();

? ? ? ? //判斷url是否公開地址(實(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)到登陸頁面

? ? ? ? request.getRequestDispatcher("/WEB-INF/jsp/login.jsp").forward(request, response);

? ? ? ? return false;

? ? }

? ? //節(jié)省空間,省略另外兩個方法不寫了,也不用處理

}

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

29

30

31

32

33

然后配置該攔截器:

<!-- 配置攔截器 -->

<mvc:interceptors>

? ? <!-- 多個攔截器,按順序執(zhí)行 -->? ?

? ? <mvc:interceptor>

? ? ? ? <mvc:mapping path="/**"/> <!-- 攔截所有的url包括子url路徑 -->

? ? ? ? <bean class="ssm.interceptor.LoginInterceptor"/>

? ? </mvc:interceptor>

? ? <!-- 其他攔截器 -->

</mvc:interceptors>

1

2

3

4

5

6

7

8

9

  這樣當(dāng)我們?nèi)我庹埱笠粋€url的時候,就會被剛剛我們定義的攔截器給捕獲到,然后會判斷是否session中有用戶信息,沒有的話就會跳到登陸頁面讓我們登陸:

<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>

1

2

3

4

5

攔截器的使用基本上就總結(jié)到這了。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時請結(jié)合常識與多方信息審慎甄別。
平臺聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡書系信息發(fā)布平臺,僅提供信息存儲服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容