SpringBoot下使用拦截器

1、使用示例

实现拦截器可以通过继承HandlerInterceptorAdapter类：

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 Interceptor1 extends HandlerInterceptorAdapter {

    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        StringBuffer requestURL = httpServletRequest.getRequestURL();
        System.out.println("拦截器1 preHandle： 请求的uri为："+requestURL.toString());
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
        System.out.println("拦截器1 postHandle： ");
    }

    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
        System.out.println("拦截器1 afterCompletion： ");
    }
}

注册拦截器：

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

    /**
     * 注册自定义拦截器
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {

        registry.addInterceptor(new Interceptor1()).addPathPatterns("/**");
        registry.addInterceptor(new Interceptor2()).addPathPatterns("/**");
    }
}

注意这里注册了两个拦截器。这两个拦截器的执行顺序和配置顺序有关系，即先配置顺序就在前。

发起一个请求，得到请求结果：

过滤器1开始工作：http://127.0.0.1:17093/testFilter
过滤器2开始工作：http://127.0.0.1:17093/testFilter
拦截器1 preHandle： 请求的uri为：http://127.0.0.1:17093/testFilter
拦截器2 preHandle： 请求的uri为：http://127.0.0.1:17093/testFilter
aop1开始：
aop1拦截方法参数arg is：abc
aop1拦截方法参数arg is：123
aop2开始：
aop2拦截方法参数arg is：abc
aop2拦截方法参数arg is：123
控制器testFilter开始工作：str='abc',integer=123
aop2结束：
aop1结束：
拦截器2 postHandle： 
拦截器1 postHandle： 
----渲染视图view----
拦截器2 afterCompletion： 
拦截器1 afterCompletion：
过滤器2结束工作：
过滤器1结束工作：

1.1、中断流程

如果在Interceptor2.preHandle中报错或返回false ,那么接下来的流程就会被中断，但注意被执行过的拦截器的afterCompletion仍然会执行。下面为Interceptor2.preHandle返回false的情况：

过滤器1开始工作：http://127.0.0.1:17093/testFilter
过滤器2开始工作：http://127.0.0.1:17093/testFilter
拦截器1 preHandle： 请求的uri为：http://127.0.0.1:17093/testFilter
拦截器1 afterCompletion：
过滤器2结束工作：
过滤器1结束工作：

2、拦截器工作原理

一个拦截器，只有preHandle方法返回true，postHandle、afterCompletion才有可能被执行；如果preHandle方法返回false，则该拦截器的postHandle、afterCompletion必然不会被执行。拦截器不是Filter，却实现了Filter的功能，其原理在于：

所有的拦截器(Interceptor)和处理器(Handler)都注册在HandlerMapping中。
Spring MVC中所有的请求都是由DispatcherServlet分发的。
当请求进入DispatcherServlet.doDispatch()时候，首先会得到处理该请求的Handler（即Controller中对应的方法）以及所有拦截该请求的拦截器。拦截器就是在这里被调用开始工作的。

3、应用场景：

登录验证，判断用户是否登录。
权限验证，判断用户是否有权限访问资源，如校验token。
日志记录，记录请求操作日志（用户ip，访问时间等），以便统计请求访问量。
处理cookie、本地化、国际化、主题等。
性能监控，监控请求处理时长等。