拦截器
1.1. 概念
Java 里的拦截器是动态拦截action调用的对象。它提供了一种机制可以使开发者可以定义在一个action执行的前后执行的代码,也可以在一个action执行前阻止其执行,同时也提供了一种可以提取action中可重用部分的方式。在 AOP(Aspect-Oriented Programming,面向切面编程)中拦截器用于在某个方法(包括构造器)或字段被访问之前进行拦截,然后在之前或之后加入某些操作。特别地,现阶段 Spring 自身仅支持基于方法的拦截操作!如果基于方法的拦截操作不能满足需求,可以使用 AspectJ 与 Spring 进行集成,以实现更细粒度或更多方面的拦截操作。
1.2. 原理
SpringMVC的拦截器基于Java的动态代理实现的
1.3. 作用
拦截器主要用于用户登录处理、权限检查、日志记录等
1.4. 实现方式
- 通过实现HandlerInterceptor接口
- 通过继承AbstractInterceptor抽象类
public interface HandlerInterceptor {
/*
预处理方法
在控制器方法之前执行,在这个方法中可以获取请求的信息,如uri等
可以根据请求信息来判断截断请求还是放行请求
handler : 被拦截的控制器对象
*/
default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
return true;
}
/*
后处理方法
在控制器方法之后执行,可以获取控制器方法的返回值,可以对返回结果做修改
*/
default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable ModelAndView modelAndView) throws Exception {
}
/*
在请求处理完成后执行的
一般做资源的回收工作
*/
default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
}
}
HandlerInterceptor接口的方法权限修饰符是default,可以自行选择实现方法(Spring 5.3.4)
1.5. 拦截器的配置
在SpringMVC的配置文件中配置拦截器
<mvc:interceptors>
<mvc:interceptor>
<!--
path : 拦截的请求路径,一般使用通配符,/**表示拦截所有请求
class : 拦截器对象的全限定类名
-->
<mvc:mapping path="/**"/>
<bean class="com.example.MyInterceptor"/>
</mvc:interceptor>
</mvc:interceptors>
1.6. 拦截器链
在项目中拦截器可能有多个,那么多个拦截器的各个方法的执行顺序是怎样的
public class MyInterceptor1 implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("11111preHandle方法执行");
return false;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("11111postHandle方法执行");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("11111afterCompletion方法执行");
}
}
public class MyInterceptor2 implements HandlerInterceptor {
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
System.out.println("22222preHandle方法执行");
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
System.out.println("22222postHandle方法执行");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
System.out.println("22222afterCompletion方法执行");
}
}
定义两个拦截器对象,并在配置文件中配置,先后顺序为MyInterceptor1>MyInterceptor2
当两个拦截器都放行时,执行结果为
当第一个拦截器放行,第二个拦截器截断时,执行结果为
当第一个拦截器截断时,执行结果为
执行示意图如下
1.7. 拦截器和过滤器的区别
- 过滤器是Servlet规范中的对象,拦截器则是Spring框架中的对象
- 过滤器实现Filter接口,拦截器实现HandlerInterceptor接口
- 过滤器是用来设置request,response的参数,属性的,侧重于对数据的过滤,如使用过滤器设置字符集,拦截器是用来验证请求的,能截断请求
- 过滤器先于拦截器执行
- 过滤器是tomcat服务器创建的对象,而拦截器对象则是由SpringMVC容器创建
- 过滤器只有一个执行时间点,拦截器有三个执行时间点
- 过滤器可以处理jsp,js,html等,拦截器侧重于拦截Controller对象,如果请求不能被中央调度器接收,这个请求就不会被拦截