Fork me on GitHub

学习SpringMVC——拦截器

  拦截器,顾名思义就是用来拦截的。

  那什么是拦截,又为什么要拦截。对于Spring MVC来说,拦截器主要的工作对象就是用户的请求,拦截下来之后,我们可以在拦截的各个阶段悉心呵护【为所欲为】。常见的比如可以做权限验证,登录系统后,系统获取到你的请求然后分析下你的用户权限,是Administrator还是User还是Guest。

 

主要相关类和方法

  HandlerExecutionChain

  该类主要由handler和handler interceptors组成

  HandlerMapping类通过getHandler方法会调用到该类

 

  HandlerInterceptor

  Spring MVC中对于一个请求可以添加多个拦截器,而这个拦截器集合中会链式调用这些拦截器。每个拦截器会执行固定顺序的方法,而这些方法就定义在HandlerInterceptor类中。

  这是拦截器的一个基础接口,里面有三个方法

 

boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception;

  使用时机:在处理请求之前

  应用场景:可以在该方法中放入一些初始化的操作,比如权限验证,日志管理等

  注意:该方法的返回值是boolean类型,若返回值为true,则继续调用后面的拦截器和目标方法,若返回为false,则不会调用后面的拦截器和目标方法,表示请求结束

 

void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView)throws Exception;

  使用时机:在调用目标方法之后,渲染视图之前被调用。具体来说,是在调用了Controller中定义的方法之后,但在DispatcherServlet 处理视图返回渲染结果之前被调用。

  应用场景:根据使用的时机就可以知道,该方法可以对Controller处理之后ModelAndView进行操作

  注意:当有多个interceptor的时候,对于preHandler的调用顺序和postHandler的调用顺序是恰恰想法的。

  举例来说,现在有一个FirstInterceptor和一个SecondInterceptor,单独调用FirstInterceptor的三个方法的顺序为:

    FirstInterceptor.preHandle->HandlerAdapter.handle->FirstInterceptor.postHanle->DispatcherServlet.render->FirstInterceptor.afterCompletion。

  对于两个interceptor的调用顺序大致如下:

  可以总结出preHandler是先进先执行,而postHandler是先进后执行

 

void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex)throws Exception;

  使用时机:渲染视图之后

  应用场景:释放资源

 

具体应用

 

  新建拦截器类FirstInterceptor

  该类需实现HandlerInterceptor接口

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
package com.jackie.springmvc.interceptors;
 
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
 
public class FirstInterceptor implements HandlerInterceptor{
 
    @Override
    public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
            throws Exception {
        System.out.println("Interceptor:afterCompletion");
         
    }
 
    @Override
    public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
            throws Exception {
        System.out.println("Interceptor:postHandle");
 
         
    }
 
    @Override
    public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {
        System.out.println("Interceptor:preHandle");
        return true;
    }
 
}

  在三个方法中分别打印当前方法信息,通过执行,看这些方法是否执行以及执行的顺序。

 

  配置springmvc.xml

1
2
3
<mvc:interceptors>
    <bean class="com.jackie.springmvc.interceptors.FirstInterceptor"></bean>
</mvc:interceptors>

 

  最后启动tomcat服务,得到控制台输出结果为:

    Interceptor:preHandle

    Interceptor:postHandle

    Interceptor:afterCompletion

 

  机智的你,可能会萌生一个想法,对于定义的这个FirstInterceptor,我并不想在任何场景下都要使用它,能不能再指定的场景下执行相应的拦截器,或者指定的场景下不执行呢,答案是肯定的!

  首先我们还是要新建另外一个拦截器SecondInterceptor

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
package com.jackie.springmvc.interceptors;
 
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
 
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
 
public class SecondInterceptor implements HandlerInterceptor{
 
    @Override
    public void afterCompletion(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, Exception arg3)
            throws Exception {
        System.out.println("SecondInterceptor:afterCompletion");
         
    }
 
    @Override
    public void postHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2, ModelAndView arg3)
            throws Exception {
        System.out.println("SecondInterceptor:postHandle");
 
         
    }
 
    @Override
    public boolean preHandle(HttpServletRequest arg0, HttpServletResponse arg1, Object arg2) throws Exception {
        System.out.println("SecondInterceptor:preHandle");
        return true;
    }
 
}

  

  同时在springmvc.xml中添加

1
2
3
4
5
6
7
8
<mvc:interceptors>
    <bean class="com.jackie.springmvc.interceptors.FirstInterceptor"></bean>
    <!-- 配置拦截器(不)作用的路径 -->
    <mvc:interceptor>
    <mvc:mapping path="/emps"/>
        <bean class="com.jackie.springmvc.interceptors.SecondInterceptor"></bean>
    </mvc:interceptor>
</mvc:interceptors>

 

  这样我们在/emps下才能使SecondInterceptor有效,其他路径的请求就不会触发这个拦截器,效果如下:

 

 

至此,我们明白了:

  • 什么是拦截器
  • 拦截器的作用
  • 如何使用拦截器

 

如果您觉得阅读本文对您有帮助,请点一下“推荐”按钮,您的“推荐”将是我最大的写作动力!如果您想持续关注我的文章,请扫描二维码,关注JackieZheng的微信公众号,我会将我的文章推送给您,并和您一起分享我日常阅读过的优质文章。

友情赞助

如果你觉得博主的文章对你那么一点小帮助,恰巧你又有想打赏博主的小冲动,那么事不宜迟,赶紧扫一扫,小额地赞助下,攒个奶粉钱,也是让博主有动力继续努力,写出更好的文章^^。

    1. 支付宝                              2. 微信

                            

posted @ 2016-10-15 13:05  JackieZheng  阅读(7159)  评论(0)    收藏  举报
编辑推荐:
· 运维排查 | SaltStack 远程命令执行中文乱码问题
· Java线程池详解:高效并发编程的核心利器
· 从“看懂世界”到“改造世界”:AI发展的四个阶段你了解了吗?
· 协程本质是函数加状态机——零基础深入浅出 C++20 协程
· 编码之道,道心破碎。
阅读排行:
· 基于.net6的一款开源的低代码、权限、工作流、动态接口平台
· 一个自认为理想主义者的程序员,写了5年公众号、博客的初衷
· Claude Code 初体验 - Windows
· .NET 8 gRPC 实现高效100G大文件断点续传工具
· 基于 C# 编写的轻量级工控网关和 SCADA 组态软件
点击右上角即可分享
微信分享提示