本文介绍如何使用 Spring MVC 中的 Interceptor 拦截器

概述

Interceptor 拦截器作为 Spring 中的组件，其底层使用 AOP 对请求进行拦截处理。提供类似于 Servlet 中 Filter 过滤器的能力。但其作用目标、范围与 Filter 不同，其是对 Controller 中的请求进行拦截、处理。拦截器与过滤器间的关系如下所示。当然我们可以同时使用多个拦截器，各拦截器会依次对用户请求进行处理。通过它可以实现拦截用户请求并作相应的处理，例如：记录请求信息、请求耗时统计分析等

figure 1.jpg

Spring 当中如果期望实现拦截器，可以实现 HandlerInterceptor 接口或者继承 HandlerInterceptorAdapter 抽象类。二者本质上并无差别，因为后者实际上是实现了前者。故这里重点介绍 HandlerInterceptor 接口中定义的几个方法

preHandle：该方法会在 Controller 方法调用前执行，其返回值表示是否中断后续所有操作。如果为 true 则继续向下执行；反之则表示请求结束，终止后续所有操作 (包括后续的 Interceptor 和 Controller)
postHandle：该方法会在 Controller 方法调用后、解析视图之前执行，可通过此方法对 ModelAndView 做进一步修改。事实上在前后分离的时代背景下，该方法可以直接忽略，直接空实现即可
afterCompletion：该方法会在视图渲染结束之后执行。主要用于执行资源清理的工作

这里补充说明下：

当配置多个拦截器时，与 Filter 类似。各拦截器在 Controller 方法调用前后的执行顺序是相反的。即：拦截器 1 preHandle 方法 -> 拦截器 2 preHandle 方法 -> Controller 方法 -> 拦截器 2 postHandle 方法 -> 拦截器 1 postHandle 方法 -> 拦截器 2 afterCompletion 方法 -> 拦截器 1 afterCompletion 方法
当某拦截器的 preHandle 方法返回 false 后，则该请求会直接终止。即不会向后面的拦截器或 Controller 传递、执行、处理。自然该拦截器的 postHandle、afterCompletion 方法也不会被执行

实践

这里我们选择通过实现 HandlerInterceptor 接口来开发拦截器 1

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Slf4j
public class MyInterceptor1 implements HandlerInterceptor {

    /**
     * 该方法会在Controller方法调用前执行，其返回值表示是否中断后续所有操作
     * @param request
     * @param response
     * @param handler
     * @return true: 继续向下执行; false: 表示请求结束, 终止后续所有操作(包括后续的Interceptor和Controller)
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.info("[Interceptor 1] This is preHandle method");
        String name = request.getParameter("name");

        // Tony 无权限
        if("Tony".equals(name)) {
            ServletOutputStream outputStream = response.getOutputStream();
            String str = "No Power !!!";
            outputStream.write(str.getBytes("utf-8"));
            outputStream.flush();
            return false;
        }
        return true;
    }

    /**
     * 该方法会在Controller方法调用后、解析视图之前执行，可通过此方法对ModelAndView做进一步修改
     * @param request
     * @param response
     * @param handler
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("[Interceptor 1] This is postHandle method");
    }

    /**
     * 该方法会在视图渲染结束之后执行。主要用于执行资源清理的工作
     * @param request
     * @param response
     * @param handler
     * @param ex
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("[Interceptor 1] This is afterCompletion method");
        ServletOutputStream outputStream = response.getOutputStream();
        String str = "  <Thank You>";
        outputStream.write(str.getBytes("utf-8"));
        outputStream.flush();
    }
}

同理，为便于验证多拦截器的执行顺序。这里我们提供了一个空实现的拦截器 2

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.ServletOutputStream;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Slf4j
public class MyInterceptor2 implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.info("[Interceptor 2] This is preHandle method");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("[Interceptor 2] This is postHandle method");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("[Interceptor 2] This is afterCompletion method");
    }
}

最后只需利用 Java 配置类，通过实现 WebMvcConfigurer 接口中的 addInterceptors 方法进行拦截器的注册即可。事实上，我们还可以通过继承 WebMvcConfigurerAdapter 抽象类的 addInterceptors 方法来注册拦截器。但 WebMvcConfigurerAdapter 本质上依然是一个对 WebMvcConfigurer 接口进行空实现的抽象类。但由于 JDK 8 通过 default 关键字，提供了对接口支持默认实现的能力。故 Spring 5.0 中已经重写 WebMvcConfigurer 接口并提供了默认的空实现，故在 Spring 5.0 中已不推荐使用 WebMvcConfigurerAdapter 抽象类

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.InterceptorRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;

@Configuration
public class MyInterceptorConfig implements WebMvcConfigurer {

    @Bean
    public MyInterceptor1 myInterceptor1() {
        return new MyInterceptor1();
    }

    @Bean
    public MyInterceptor2 myInterceptor2() {
        return new MyInterceptor2();
    }

    /**
     * 注册拦截器
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //注册拦截器1
        registry.addInterceptor( myInterceptor1() )
            // 数字越小，优先级越高
            .order(5)
            // 指定需要拦截的URL
            .addPathPatterns("/testInterceptor/*")
            // 指定不拦截的URL
            .excludePathPatterns("/hello/*", "/person/add");

        //注册拦截器2
        registry.addInterceptor( myInterceptor2() )
            // 数字越小，优先级越高
            .order(996)
            // 指定需要拦截的URL
            .addPathPatterns("/testInterceptor/*");
    }
}