SpringMVC学习笔记 | SpringMVC拦截器详解:自定义拦截器、拦截器执行顺序的分析

自定义拦截器

SpringMVC可以使用拦截器对请求进行拦截处理,用户可以自定义拦截器来实现特定的功能,自定义拦截器必须实现HandlerInterceptor接口

步骤

  • 编写一个拦截器类,需要实现HandlerInterceptor接口
    示例:
package com.cerr.springmvc.interceptor;


import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class FirstInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        System.out.println("preHandle");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
        System.out.println("postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
        System.out.println("afterCompletion");
    }
}

  • 在配置文件中配置该拦截器,使用<mvc:interceptors>来进行配置
    配置示例:
<mvc:interceptors>
        <!-- 配置自定义的拦截器-->
        <bean class="com.cerr.springmvc.interceptor.FirstInterceptor"/>
</mvc:interceptors>

对HandlerInterceptor接口的三个方法的解析

public boolean preHandle(HttpServletRequest httpServletRequest, 
            HttpServletResponse httpServletResponse, Object o){};

该方法在目标方法执行前被调用,该方法若返回值为true,则继续调用后续的拦截器和目标方法;若返回值为false,则不会再调用后续的拦截器和目标方法。
可以考虑做权限,日志,事务等等。

public void postHandle(HttpServletRequest httpServletRequest, 
        HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView){};

该方法在目标方法执行之后、渲染视图之前被调用,可以对请求域中的属性或视图作出修改。

public void afterCompletion(HttpServletRequest httpServletRequest, 
         HttpServletResponse httpServletResponse, Object o, Exception e){};

该方法在渲染视图之后被调用,释放资源。

拦截器方法执行顺序图


从该图我们可以看出,拦截器先调的preHandle,然后再去调目标方法,然后再调postHandle,然后再渲染视图,最后调afterCompletion,然后结束。

关于拦截器的其他配置

上面中我们说了拦截器可以通过<mvc:interceptors>来配置,而对于这个标签中,里面还有一个子标签我们还没说到,它就是<mvc:interceptor>。其里面有两个子标签<mvc:mapping path=""/><mvc:exclude-mapping path=""/>

  • <mvc:mapping path=""/>
    表示该拦截器拦截该请求(path里面的值)
  • <mvc:exclude-mapping path=""/>
    表示该拦截器不拦截该请求(path里面的值)

例如我们配置如下:

<mvc:interceptors>
        <!-- 配置自定义的拦截器-->
        <bean class="com.cerr.springmvc.interceptor.FirstInterceptor"/>

        <mvc:interceptor>
            <mvc:mapping path="/emps"/>
            <bean class="com.cerr.springmvc.interceptor.SecondInterceptor"/>
        </mvc:interceptor>
    </mvc:interceptors>

SecondInterceptor拦截器代码:

package com.cerr.springmvc.interceptor;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
public class SecondInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        System.out.println("SecondInterceptor:preHandle");
        return true;
    }
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
        System.out.println("SecondInterceptor:postHandle");
    }
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
        System.out.println("SecondInterceptor:afterCompletion");
    }
}

配置后,对于SecondInterceptor拦截器,只拦截emps请求,而emps请求会被FirstInterceptorSecondInterceptor拦截。

运行后访问emps结果如下:



红框为第二个拦截器,绿框为第一个拦截器。

而如果访问一个其他的(例如i18n)结果如下:



绿框为第一个拦截器,只被第一个拦截器所拦截。

多个拦截器的拦截方法执行顺序


从执行顺序图我们可以看出,对于preHandle方法,先配置的先执行;对于postHandle方法,先配置的后执行;对于afterCompletion方法,先配置的后执行。

有一点需要注意的是:对于afterCompletion方法是否执行是取决于preHandle方法的,在某一个拦截器的prehandle方法返回false前的所有拦截器都会执行afterCompletion方法。例如现在有4个拦截器,而第三个拦截器的prehandle返回了false,所以会执行afterCompletion方法的拦截器有拦截器1、拦截器2。

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容