Spring Boot学习（十三）：Java三大器之一！Spring Boot的拦截器使用秘籍

前言

Spring Boot系列: 点击查看Spring Boot系列文章

拦截器

拦截器（Interceptor）：在一个流程正在进行的时候，你希望干预它的进展，甚至终止它进行，这是拦截器做的事情。

通俗点来说，就是拦截器可以帮我们把某个流程拦下来，执行一些我们设定的额外流程，执行完再继续本来的流程。

一般我们可以用拦截器做登陆验证、性能检查、日志记录等。

应用场景

日志记录，可以记录请求信息的日志，以便进行信息监控、信息统计等。

权限检查：如登陆检测，进入处理器检测是否登陆，如果没有直接返回到登陆页面。

性能监控：典型的是慢日志。

自定义拦截器

自定义拦截器的方法有两种：
一种是实现 org.springframework.web.servlet.HandlerInterceptor接口，
另一种是继承 org.springframework.web.servlet.handler.HandlerInterceptorAdapter类。实现接口需要实现其接口的所有方法，继承抽象类则一般根据自己的需求来选择实现对应的方法。

以下是HandlerInterceptor 的源码，主要有preHandle，postHandle，afterCompletion三个方法

public interface HandlerInterceptor {
    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 {
    }
}

以下为HandlerInterceptorAdapter的源码：

public abstract class HandlerInterceptorAdapter implements AsyncHandlerInterceptor {
    public HandlerInterceptorAdapter() {
    }

    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        return true;
    }

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

    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, @Nullable Exception ex) throws Exception {
    }


    public void afterConcurrentHandlingStarted(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
    }
}

有时候我们可能只需要实现三个回调方法中的某一个，如果实现HandlerInterceptor接口的话，三个方法必须实现，不管你需不需要，所以spring提供了一个HandlerInterceptorAdapter适配器（一种适配器设计模式的实现），允许我们只实现需要的回调方法。

下面，我们来看一下preHandle，postHandle，afterCompletion三个方法的区别

preHandle：在方法被调用前执行，一般我们做登录校验都是在这个方法上进行。如果返回true，则继续调用下一个拦截器，如果只有一个拦截器，则放行。如果返回false，则中断执行，方法停止执行。

postHandle：在方法执行后调用。

afterCompletion：在整个请求处理完毕后进行回调，也就是说视图渲染完毕或者调用方已经拿到响应。

下面看一张示意图，大家理解一下

总结一下拦截器的执行流程

1、拦截器是按顺序执行的，首先执行拦截器的preHandle，如果为true，则继续执行下一个拦截器的preHandle方法，直到所有拦截器的preHandle方法执行完，才会继续去执行被拦截的方法。如果有一个拦截器的preHandle方法返回false，那么之后的拦截器preHandle方法都不会执行，被拦截的方法也不会执行。

2、所有拦截器的preHandle方法执行完成之后，被拦截的方法执行

3、被拦截的方法执行完业务逻辑代码，但还没渲染数据，返回响应时，会执行postHandle方法。当执行完postHandle和返回响应后，就会执行afterCompletion方法

介绍了这么多，下面我们就来自定义一个拦截器，来看一下

package com.example.demo.aop;

import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;

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

public class TestInterceptor  extends HandlerInterceptorAdapter {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        request.setAttribute("startTime", System.currentTimeMillis());
        System.out.println("-------- preHandle 开始执行 -----------------");
        return super.preHandle(request, response, handler);
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        Long startTime = (Long) request.getAttribute("startTime");
        Long millis = System.currentTimeMillis();
        request.setAttribute("postTime",millis);
        System.out.println("postHandle 开始执行: " + ( millis- startTime));
        super.postHandle(request, response, handler, modelAndView);
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        Long postTime = (Long) request.getAttribute("postTime");
        System.out.println("afterCompletion 开始执行: "+(System.currentTimeMillis()-postTime) );
        super.afterCompletion(request, response, handler, ex);
    }
}

配置拦截器

在自定义完拦截器，还要配置拦截器，这样拦截器才能生效。

配置拦截器也有两种方法，一种是实现WebMvcConfigurer，另一种是继承WebMvcConfigurationSupport。（WebMvcConfigurerAdapter已经被废弃）

下面，我们就用WebMvcConfigurer来配置拦截器

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new TestInterceptor()).addPathPatterns("/**");
    }
}

WebMvcConfigurer方法解析

1、addInterceptors()为添加拦截器方法，registry为注册器

addInterceptor：使用一个拦截器实例作为参数来添加拦截器

addPathPatterns：用于设置拦截器的过滤路径规则；addPathPatterns("/**")表示对所有请求都拦截

excludePathPatterns：用于设置不需要拦截的过滤规则

2、addResourceHandlers：配置静态访问资源

/**
 * 添加静态资源
 */
@Override
public void addResourceHandlers(ResourceHandlerRegistry registry) {
    //过滤swagger
    registry.addResourceHandler("swagger-ui.html")
            .addResourceLocations("classpath:/META-INF/resources/");

}

addResoureHandler：指的是对外暴露的访问路径

addResourceLocations：指的是内部文件放置的目录

3、addCorsMappings：跨域支持

  /**
     * 跨域支持
     * @param registry
     */
    @Override
    public void addCorsMappings(CorsRegistry registry) {
        registry.addMapping("/**")
                .allowedOrigins("*")
                .allowCredentials(true)
                .allowedMethods("GET", "POST", "DELETE", "PUT")
                .maxAge(3600*24);

    }

4、configureMessageConverters：配置消息转换器，以下是配置fastJson转换器

/**
     * @param converters
     */
    @Override
    public void configureMessageConverters(List<HttpMessageConverter<?>> converters) {
        //1.需要定义一个convert转换消息的对象;
        FastJsonHttpMessageConverter fastJsonHttpMessageConverter = new FastJsonHttpMessageConverter();
        //2.添加fastJson的配置信息，比如：是否要格式化返回的json数据;
        FastJsonConfig fastJsonConfig = new FastJsonConfig();
        fastJsonConfig.setSerializerFeatures(SerializerFeature.PrettyFormat,
                SerializerFeature.WriteMapNullValue,
                SerializerFeature.WriteNullStringAsEmpty,
                SerializerFeature.DisableCircularReferenceDetect,
                SerializerFeature.WriteNullListAsEmpty,
                SerializerFeature.WriteDateUseDateFormat);
        //3处理中文乱码问题
        List<MediaType> fastMediaTypes = new ArrayList<>();
        fastMediaTypes.add(MediaType.APPLICATION_JSON_UTF8);
        //4.在convert中添加配置信息.
        fastJsonHttpMessageConverter.setSupportedMediaTypes(fastMediaTypes);
        fastJsonHttpMessageConverter.setFastJsonConfig(fastJsonConfig);
        //5.将convert添加到converters当中.
        converters.add(fastJsonHttpMessageConverter);
    }

5、addViewControllers：页面跳转
通过配置文件映射指定请求路径到指定View页面，当然也是在请求目标页面时不需要做什么数据处理才会使用

 @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        super.addViewControllers(registry);
        registry.addViewController("/").setViewName("/index");
}

测试

最后，我们创建一个controller，来测试一下拦截器的执行

@Controller
public class InterceptorTestController {

    @RequestMapping(value = { "/test/interceptor" })
    @ResponseBody
    public String interceptorTest(){
        System.out.println("运行controller-------------");
        return "hello";
    }
}

输出结果如下：

当在代码中抛出异常后，我发现拦截器的方法也都能执行

 @RequestMapping(value = { "/test/interceptor" })
    @ResponseBody
    public String interceptorTest() {

        throw new NullPointerException();

    }
}

结果：