SpringBoot拦截器HandlerInterceptor实现

一、HandlerInterceptor简介

拦截器我想大家都并不陌生，最常用的登录拦截、或是权限校验、或是防重复提交、或是根据业务像12306去校验购票时间,总之可以去做很多的事情。

二、拦截器的实现

方式一：类实现Spring 的HandlerInterceptor 接口 （推荐）

例如：类直接实现HandlerInterceptor 或直接实现AsyncHandlerInterceptor

方式二：类继承实现了HandlerInterceptor 接口的类

例如： 已经提供的实现了HandlerInterceptor 接口的抽象类HandlerInterceptorAdapter（已不推荐，spring从5.3开始HandlerInterceptorAdapter已经被弃用@deprecated，）

三、基于方式一实现拦截器

自定义拦截器，实现 HandlerInterceptor 接口，并实现其中的三个方法

preHandle 方法：在业务处理器处理请求之前被调用，预处理，可以进行编码、安全控制、权限校验等处理换句话说就是请求在达到controller层之前会被拦截并运行preHandle方法。

postHandle 方法：在业务处理器处理请求执行完成后，生成视图之前执行。后处理（调用了Service并返回ModelAndView，但未进行页面渲染），有机会修改ModelAndView ；

afterCompletion：在DispatcherServlet完全处理完请求后被调用，可用于清理资源等。返回处理（已经渲染了页面）；

示例如下：

1. 自定义拦截器

package com.xiaohaitang.somedemo.ierInterceptor;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

public class lerInterceptor  implements HandlerInterceptor {
    private static final Logger logger = LoggerFactory.getLogger(lerInterceptor.class);
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        logger.info("Interceptor preHandle");
        //如果返回false则 postHandle()和 afterCompletion()不会执行
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        logger.info("Interceptor postHandle");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        logger.info("Interceptor afterCompletion");
    }
}

2.注册拦截器并定义拦截范围

package com.xiaohaitang.somedemo.config;

import com.xiaohaitang.somedemo.ierInterceptor.lerInterceptor;
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 MyWebAppConfigurer implements WebMvcConfigurer {
    @Bean
    public lerInterceptor myInterceptor() {
        return new lerInterceptor();
    }

    @Override
    //此方法用来专门注册一个拦截器
    public void addInterceptors(InterceptorRegistry registry) {
        //addPathPatterns("/**")对所有请求都拦截，但是排除了/apiList/v1/calculator和/js/**和/*/v1/returnJson请求的拦截。
        registry.addInterceptor(myInterceptor())
                .addPathPatterns("/**")
                .excludePathPatterns("/apiList/v1/calculator", "/js/**", "/*/v1/returnJson");
    }
}

3. 验证

1. 假设现在我们运行接口 /apiList/v1/calculator , 将不会打印任何信息，因为上面排除了 /apiList/v1/calculator ，所以 /apiList/v1/calculator不会被拦截。

2. 假设现在我们运行接口 /apiList/v1/findAll ，这个接口里面的逻辑是打印

jsonObject:{note=你好啊！, month=12, yer=2020, day=24}

运行接口 /apiList/v1/findAll 后控制台打印了以下信息：

2021-02-05 14:38:36,738:INFO http-nio-8080-exec-1 (lerInterceptor.java:14) - Interceptor preHandle
2021-02-05 14:38:36,755:INFO http-nio-8080-exec-1 (UserConsumer.java:93) - jsonObject:{note=你好啊！, month=12, yer=2020, day=24}
2021-02-05 14:38:36,776:INFO http-nio-8080-exec-1 (lerInterceptor.java:21) - Interceptor postHandle
2021-02-05 14:38:36,776:INFO http-nio-8080-exec-1 (lerInterceptor.java:26) - Interceptor afterCompletion

可以看到请求在到达接口 /apiList/v1/findAll 前，先执行了拦截器里的preHandle方法，再执行了接口里的逻辑，最后再执行了postHandle和afterCompletion方法。

四、多个拦截器的实现

假设我们有两个自定义的拦截器：FirstInterceptor 和 SecondInterceptor

1.FirstInterceptor 拦截器

public class FirstInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println(">>> FirstInterceptor preHandle");
        return true;
    }
}

2. SecondInterceptor 拦截器

public class SecondInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println(">>> SecondInterceptor preHandle");
        return true;
    }
}

3.配置类中批量注册拦截器

创建一个配置类，实现 WebMvcConfigurer：

@Configuration
public class WebConfig implements WebMvcConfigurer {
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        // 注册第一个拦截器，order越小优先级越高
        registry.addInterceptor(new FirstInterceptor())
                .addPathPatterns("/api/**") // 只拦截 /api
                .order(0);

        // 注册第二个拦截器
        registry.addInterceptor(new SecondInterceptor())
                .addPathPatterns("/**") // 全局拦截
                .order(1);
    }
}

关于 order 说明：

拦截器是按照 order 升序执行的：
前置方法（preHandle）按 order 从小到大执行：order 0 -> order 1 -> order 2 ...
后置方法（postHandle 和 afterCompletion）按 order 从大到小执行：order 2 -> order 1 -> order 0

上面的例子执行顺序：

阶段	          执行顺序
preHandle	      FirstInterceptor  → SecondInterceptor
postHandle	      SecondInterceptor → FirstInterceptor
afterCompletion	  SecondInterceptor → FirstInterceptor

如果不设置 order，即如果不调用 .order()，默认顺序是注册顺序（先注册先执行），比如：

registry.addInterceptor(new FirstInterceptor()).addPathPatterns("/**");
registry.addInterceptor(new SecondInterceptor()).addPathPatterns("/**");

//就相当于：
//FirstInterceptor (order = 0)
//SecondInterceptor (order = 1)

---

你也可以使用自定义注解配合拦截器对特定接口进行拦截校验，可参考我另一篇文章：Java 自定义注解及使用

---

参考：
SpringBoot之HandlerInterceptor拦截器的使用 ——（一）
springboot拦截器简单实现
Java三大器之拦截器(Interceptor)的实现原理及代码示例
Spring中的拦截器
Spring Boot配置接口 WebMvcConfigurer