SpringBoot之HandlerInterceptor

声明：所有的代码基于SpringBoot 2.0.3版本

HandlerInterceptor简介

HandlerInterceptor是一个允许自定义处理链的工作流接口。应用程序可以为某些处理程序注册任意数量的现有或自定义拦截器，无需修改现有拦截器的实现即可增加常见的预处理动作。在适当的HandlerAdapter触发处理程序本身的执行之前调用HandlerInterceptor。该机制可用于很多领域的预处理工作，例如， 授权检查，通用处理流程（区域设置或主题更改）。 拦截器的其主要目的是允许分解重复的处理代码。

在异步处理场景中，拦截器可以在单独的线程中执行，主线程退出可能不会调用postHandle和afterCompletion方法。当并发处理程序执行完成后，请求将再次被分发以继续呈现模型，并再次调用所有拦截的方法。关于异步拦截器可以参考AsyncHandlerInterceptor。

HandlerInterceptor接口方法

boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)throws Exception

拦截handler的执行，在HandlerMapping确定合适的handler之后，调用handler之前调用该方法。DispatcherServlet在包含多个拦截器的执行链中处理一个handler，并在执行链的结尾执行handler自身。通过该方法，每个拦截器可以决定中止执行链，通常是发送HTTP错误或返回自定义响应。

参数

request - 当前HTTP请求
response - 当前HTTP响应
handler - 选择的handler

返回值

true - 执行链可以执行下一个拦截器或handler本身。
false - 拦截器已经处理了相应。

 void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,ModelAndView modelAndView) throws Exception 

拦截handler的执行，在HandlerAdapter调用handler之后，DispatcherServlet呈现视图之前调用该方法。可以通过给定的ModelAndView向视图增加其他模型对象。DispatcherServlet在包含多个拦截器的执行链中处理一个handler，并在执行链的结尾执行handler自身。使用该方法，每个拦截器都可以对操作后处理，实现按照处理链逆序执行。

参数

request - 当前HTTP请求
response - 当前HTTP响应
handler - 异步执行器
modelAndView - 处理返回值的模型视图

void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,Exception ex) throws Exception

在请求处理完成而且preHandle执行完成并返回true的条件下才调用该方法，使用该方法可以进行合理的资源清理。

参数

request - 当前HTTP请求
response - 当前HTTP响应
handler - 异步执行器
ex - 当前拦截器抛出的异常

SpringBoot中自定义Interceptor

自定义Interceptor

import org.springframework.lang.Nullable;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.util.Enumeration;

public class CustomInterceptor implements HandlerInterceptor {

    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        Enumeration headerNames = request.getHeaderNames();
        while (headerNames.hasMoreElements()) {
            String heanderName = headerNames.nextElement();
            System.out.println(heanderName);
        }
        return true;
    }

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

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

}

注册Interceptor

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 CustomConfigure implements WebMvcConfigurer {

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

将自定义的Interceptor注册后启动SpringBoot应用，访问/user即可看到拦截器可以正常工作。