【SpringMVC】拦截器

拦截器（Interceptor）是一种用于动态拦截方法调用的机制。在 Spring MVC 中，拦截器能够动态地拦截控制器方法的执行过程。以下是请求发送与接收的基本流程：

当浏览器发出请求时，请求首先到达 Tomcat 服务器。Tomcat 根据请求类型（静态资源或动态资源）进行处理。对于静态资源，Tomcat 直接返回相应的资源；而对于动态资源，请求会经过 Servlet 过滤器，接着交给 Spring 进行处理。Spring 通过中央控制器将请求分发到具体的 Controller 中，执行相应操作，并将处理后的数据返回给浏览器。

在这个过程中，可能会出现一些需求，例如权限控制和身份验证。为了在所有控制器的执行前或执行后统一处理这些操作，拦截器就此出现。拦截器允许我们在控制器方法执行的前后添加统一的逻辑，从而实现更灵活和易于管理的代码结构。概括而言，拦截器的作用包括：

在指定的方法调用前后执行预先设定的代码
阻止原始方法的执行

拦截器 vs 过滤器

在请求发送与接收的过程中，涉及到过滤器（Filter）和拦截器（Interceptor）。两者之间的主要区别如下：

归属不同：过滤器属于 Servlet 技术，而拦截器则属于 Spring MVC 技术
拦截内容不同：过滤器在 Tomcat 服务器阶段进行配置，对所有访问进行增强；而拦截器仅针对 Spring MVC 的请求进行增强。

拦截器使用

在实际开发过程中，拦截器的使用主要包括两个步骤：

制作拦截器功能类
配置拦截器的执行位置

（1）制作拦截器功能类

声明拦截器的 Bean，并实现 HandlerInterceptor 接口（注意：后续需要扫描加载 Bean）。具体地，创建一个 com.it.interceptor 包，在该包中创建一个拦截器 ProjectInterceptor，实现 HandlerInterceptor 接口，并且重写 preHandle、postHandle 和 afterCompletion 三个方法，这三个方法分别对应前置处理、后置处理和完成后处理：

java 复制代码

@Component
public class ProjectInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("preHandle...");
        return true; 
        // return false 时，将终止原始操作，后续的 postHandle 和 afterCompletion 也不会执行
    }

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

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

当前置处理（对应 preHandle 方法）返回 false 时，将终止原始操作，后续的 postHandle 和 afterCompletion 也不会执行，过程如下图所示。

（2）配置拦截器的执行位置

在 com.it.config 包中定义配置类，该类继承 WebMvcConfigurationSupport，并实现 addInterceptor 方法（注意：后续需要扫描加载配置）。在方法中注册拦截器并设定拦截的访问路径，路径可以通过可变参数设置多个。

java 复制代码

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {
    @Autowired
    private ProjectInterceptor projectInterceptor;

    @Override
    protected void addInterceptors(InterceptorRegistry registry) {
        // 所有以 /users 开头的访问路径都被拦截
        registry.addInterceptor(projectInterceptor).addPathPatterns("/users", "/users/*");
    }
}

（3）扫描加载

在 SpringMvcConfig 配置类中，多添加对 com.it.interceptor 和 com.it.config 包的扫描，以此完成对拦截器的加载：

java 复制代码

@Configuration
@ComponentScan({"com.it.controller", "com.it.interceptor", "com.it.config"})
@EnableWebMvc
public class SpringMvcConfig {
}

（4）简化开发

上述拦截器的使用过程可以进一步简化。通过使用标准接口 WebMvcConfigurer，可以减少开发的复杂性。将 SpringMvcSupport 配置类与 SpringMvcConfig 配置类合并，可以有效降低代码量。

java 复制代码

@Configuration
@ComponentScan({"com.it.controller", "com.it.interceptor"})
@EnableWebMvc
public class SpringMvcConfig implements WebMvcConfigurer {

    @Autowired
    private ProjectInterceptor projectInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(projectInterceptor).addPathPatterns("/users", "/users/*");
    }
}

拦截器参数

（1）前置处理

java 复制代码

public boolean preHandle(
        HttpServletRequest request, 
        HttpServletResponse response, 
        Object handler
) throws Exception {
    System.out.println("preHandle...");
    return true;
}

参数
- request：请求对象
- response：响应对象
- handler：被调用的处理器对象，本质上是一个方法对象，对反射技术中的 Method 对象进行了再包装
返回值
- 返回值为 false 时，被拦截的处理器将不执行

（2）后置处理

java 复制代码

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

参数
- modelAndview：如果处理器执行完成具有返回结果，可以读取到对应数据与页面信息，并进行调整（现阶段开发模式下基本用不上）

（3）完成后处理

java 复制代码

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

参数
- ex：如果处理器执行过程中出现异常对象，可以针对异常情况进行单独处理

拦截器链配置

当配置多个拦截器时，会形成拦截器链。拦截器链的运行顺序遵循拦截器的添加顺序，具体执行顺序如下：

preHandle：按照配置顺序执行
postHandle：按照配置顺序的相反顺序执行
afterCompletion：同样按照配置顺序的相反顺序执行

此外，还有几点需要注意：

如果某个拦截器拦截了原始处理器的执行，后续的拦截器将停止运行。
如果拦截器的执行过程中发生中断，仅会执行在前面配置的拦截器的 afterCompletion 操作。