拦截器

什么是拦截器

拦截器(Interceptor)是一种动态拦截Controller方法调用的对象,它可以在指定的方法调用前或者调用后,执行预先设定的代码。拦截器作用类似于Filter(过滤器),但是它们的技术归属和拦截内容不同。Filter采用Servlet技术,拦截器采用Spring MVC技术;Filter会对所有的请求进行拦截,拦截器只针对Spring MVC的请求进行拦截。

在Spring MVC 中定义一个拦截器非常简单,常用的拦截器定义方式有以下两种。

• 第一种方式是通过实现HandlerInterceptor接口定义拦截器。

• 第二种方式是通过继承HandlerInterceptor接口的实现类HandlerInterceptorAdapter,定义拦截器。

上述两种方式的区别在于,直接实现HandlerInterceptor接口需要重写HandlerInterceptor接口的所有方法;而继承HandlerInterceptorAdapter类的话,允许只重写想要回调的方法。

自定义拦截器示例

下面通过实现HandlerInterceptor接口自定义拦截器,自定义拦截器的代码如下所示。

package com.lq.interceptor;

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

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

/**
 * @Author: Luqing Teacher
 * @CreateTime: 2025-03-13
 * @Description:
 * @Version: 1.0
 */


public class CustomInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return false;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
    
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
    
    }
}
preHandler()方法

preHandler()方法用于对程序进行安全控制、权限校验等,它会在控制器方法调用前执行。preHandler()方法的参数request是请求对象,response是响应对象,handler是被调用的处理器对象。

preHandler()方法的返回值为bool类型,表示是否中断后续操作。当返回值为true时,表示继续向下执行;当返回值为false时,整个请求就结束了,后续的所有操作都会中断(包括调用下一个拦截器和控制器类中的方法执行等)。

postHandle()方法

postHandle()方法用于对请求域中的模型和视图做出进一步的修改,它会在控制器方法调用之后且视图解析之前执行。

postHandle()方法的前2个参数和preHandler()方法的前2个参数一样,分别是请求对象和响应对象。如果处理器执行完成有返回结果,可以通过第3个参数modelAndView读取和调整返回结果对应的数据与视图信息。

afterCompletion()方法

afterCompletion()方法可以完成一些资源清理、日志信息记录等工作,它会在整个请求完成后执行,即视图渲染结束之后执行。

postHandle()方法的前2个参数和preHandler()方法的前2个参数一样,分别是请求对象和响应对象。第3个参数ex是异常对象,如果处理器执行过程中出现异常,会将异常信息封装在该异常对象中,可以在afterCompletion()方法中针对异常情况进行单独处理。需要注意的是,只有在preHandler()方法的返回值为true时,postHandle()方法和afterCompletion()方法才会按上述执行规则执行。

拦截器的配置

要使自定义的拦截器生效,还需要在Spring MVC的配置文件spring-mvc.xml中进行配置。配置代码如下所示。

<mvc:interceptors><!-- 配置拦截器 -->
   <!--拦截所有请求-->
   <bean class="com.lq.interceptor.MyInterceptor1"/>
   <mvc:interceptor>
       <mvc:mapping path="/**"/> <!-- 配置拦截器作用的路径 -->
       <mvc:exclude-mapping path=""/> <!-- 配置不需要拦截器作用的路径 -->
       <!-- 对匹配路径的请求才进行拦截-->
       <bean class="com.lq.interceptor.MyInterceptor2" /> 
   </mvc:interceptor>
</mvc:interceptors>

在上述代码中,<mvc:interceptors>元素使用2种方式配置了拦截器,其中,使用子元素<bean>声明的拦截器,将会对所有的请求进行拦截;而使用<mvc:interceptor>元素声明的拦截器,会对指定路径下的请求进行拦截。

<mvc:interceptor>元素的子元素<mvc:mapping>通过path属性配置拦截器作用的路径。如上述代码中path的属性值为“/**”,表示拦截所有路径。如果有不需要拦截的请求,可以通过<mvc:exclude-mapping>元素进行配置。需要注意的是,<mvc:interceptor>中的子元素必须按照上述代码的配置顺序进行编写,即<mvc:mapping… />→<mvc:exclude-mapping… />→<bean … />的顺序,否则文件会报错。

拦截器的执行流程
单个拦截器的执行流程:
  • 程序收到请求后,首先会执行拦截器中的preHandle()方法,如果preHandle()方法返回的值为false,则将中断后续所有代码的执行。
  • 如果preHandle()方法的返回值为true,则程序会继续向下执行Handler的代码。
  • 当Handler执行过程中没有出现异常时,接着会执行拦截器中的postHandle()方法。
  • postHandle()方法执行后会通过DispatcherServlet向客户端返回响应,并且在DispatcherServlet处理完请求后,执行拦截器中的afterCompletion()方法;如果Handler执行过程中出现异常,将跳过拦截器中的postHandle()方法,直接由DispatcherServlet渲染异常页面返回响应,最后执行拦截器中的afterCompletion()方法。

Spring MVC 拦截器 知道多少?_mvc

案例演示

下面通过一个案例演示单个拦截器的执行流程,案例具体实现步骤如下所示。在chapter13项目的com.lq.controller包下,创建名称为HelloController的控制器类,在HelloController类中定义2个方法,其中hello()方法用于正常处理客户端的请求,exp()方法被调用时产生异常。

package com.lq.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;

/**
 * @Author: Luqing Teacher
 * @CreateTime: 2025-03-13
 * @Description:
 * @Version: 1.0
 */

@Controller
public class HelloController {

    @RequestMapping("hello")
    public String hello() {
        System.out.println("HelloController...Hello");
        return "success.jsp";
    }
    @RequestMapping("exp")
    public String exp(){
        System.out.println(1/0);
        return "success.jsp";
    }
}

在src\main\java目录下,创建一个路径为com.lq.interceptor的包,并在包中创建实现HandlerInterceptor接口的拦截器MyInterceptor。在MyInterceptor类中重写的3个方法内编写输出语句来验证方法的执行情况。MyInterceptor类部分代码如下所示。

package com.lq.interceptor;

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

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

/**
 * @Author: Luqing Teacher
 * @CreateTime: 2025-03-13
 * @Description:
 * @Version: 1.0
 */


public class MyInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("MyInterceptor...preHandle");
        //对拦截的请求进行放行处理
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("MyInterceptor...postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("MyInterceptor...afterCompletion");
    }
}

Spring MVC的配置文件spring-mvc.xml中添加MyInterceptor拦截器的配置,具体配置如下所示。在spring-mvc.xml中使用<mvc:interceptors>元素的子元素<bean>来配置拦截器,配置的拦截器会拦截所有映射到Handler的请求。

<!-- 配置拦截器 -->
<mvc:interceptors>  
<!--使用bean直接定义在<mvc:interceptors>下面的拦截器将拦截所有请求-->
	<bean class="com.lq.interceptor.MyInterceptor"/>
</mvc:interceptors>

定义success.jsp在webapp目录下:

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>执行成功页面</title>
</head>
<body>
    <h3 style="color: green" >Handler 执行成功!!!</h3>
</body>
</html>

Spring MVC 拦截器 知道多少?_mvc_02

控制台输出:

Spring MVC 拦截器 知道多少?_java_03

接下来验证,当Handler执行出现异常时,拦截器方法的执行顺序。

Spring MVC 拦截器 知道多少?_java_04

Spring MVC 拦截器 知道多少?_spring_05

从上面两图所示的信息可以看出,程序先执行了拦截器中的preHandle()方法,然后执行了拦截器的afterCompletion()方法。这是因为访问的地址映射到exp()方法,执行exp()方法时出现异常,由于程序中设置了异常处理器,DispatchServlet会渲染对应的异常处理页面进行页面转跳,程序跳过了拦截器postHandler()方法的执行。

多个拦截器的执行流程

在大型的企业级项目中,可能会定义很多拦截器来实现不同的功能。假设项目中配置了顺序为Interceptor1、Interceptor2的两个拦截器,多个拦截器的执行流程如图所示。

Spring MVC 拦截器 知道多少?_java_06

从多个拦截器的执行流程图中可以看出,当有程序中配置了多个拦截器时,拦截器中的preHandle()方法会按照配置文件中拦截器的配置顺序执行,而拦截器中的postHandle()方法和afterCompletion()方法则会按照拦截器的配置顺序的相反顺序执行。

案例展示

下面在单个拦截器案例的基础上新增一个拦截器,来演示多个拦截器的执行,具体步骤如下。

package com.lq.interceptor;

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

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

/**
 * @Author: Luqing Teacher
 * @CreateTime: 2025-03-13
 * @Description:
 * @Version: 1.0
 */


public class MyInterceptor2 implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("MyInterceptor2...preHandle");
        //对拦截的请求进行放行处理
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("MyInterceptor2...postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("MyInterceptor2...afterCompletion");
    }
}

在Spring MVC配置文件springmvc-config.xml中的<mvc:interceptors>元素内,新增拦截器MyInterceptor2,<mvc:interceptors>元素内的配置代码具体如下所示。

<mvc:interceptors>
        <!-- 使用bean直接定义在mvc:interceptors下面的拦截器将拦截所有请求 -->
        <bean class="com.lq.interceptor.MyInterceptor" />
        <bean class="com.lq.interceptor.MyInterceptor2" />
    </mvc:interceptors>

测试:

Spring MVC 拦截器 知道多少?_拦截器_07

Spring MVC 拦截器 知道多少?_拦截器_08