SpringBoot下拦截器的应用

最近在做某个项目，突击式的把所有功能全部实现了后，反思项目上有哪些需要改进和重构的地方。由于项目是个SpringBoot项目，在观察controller方法时发现很多处理方法存在着大量冗余的代码，而这些代码几乎是完全一模一样的。比如我们这个项目，基本上每个请求都会去验证用户token，而在每个controller里去写一段验证token的代码无疑是非常愚蠢。于是从切面化编程的角度去思考下，第一个就想到了拦截器，把公共的代码抽到拦截器，让需要验证token的请求在到达controller层之前就先过一遍拦截器，好吧，既然想好了，就让我们这么做！

要了解Spring拦截器的作用，我们需要先解释一下HTTP请求的执行链。DispatcherServlet捕获每个请求。调度员做的第一件事就是将接收到的URL和相应的controller进行映射(controller必须恰到好处地处理当前的请求)。但是，在到达对应的controller之前，请求可以被拦截器处理。这些拦截器就像过滤器。只有当URL找到对应于它们的映射时才调用它们。在通过拦截器(拦截器预处理，其实也可以说前置处理)进行前置处理后，请求最终到达controller。之后，发送请求生成视图。但是在这之前，拦截器还是有可能来再次处理它(拦截器后置处理)。只有在最后一次操作之后，视图解析器才能捕获数据并输出视图。

SpringBoot下的拦截器使用无疑是非常简单的，摒弃了XML的配置，一切都采用注解化，现在让我们来看看该怎样去实现：

1. 首先我们要定义一个拦截器，在spring里定义一个拦截器只需要实现HandlerInterceptor接口，你的代码可能看上去是这样的：

@Component
public class UserCheckInterceptor implements HandlerInterceptor{

    /**
     * 预处理回调方法，实现处理器的预处理，第三个参数为响应的处理器，自定义Controller
     * 返回值：true表示继续流程（如调用下一个拦截器或处理器）；false表示流程中断（如登录检查失败），不会继续调用其他的拦截器或处理器，此时我们需要通过response来产生响应；
     */
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        return false;
    }

    /**
     * 后处理回调方法，实现处理器的后处理（但在渲染视图之前），此时我们可以通过modelAndView（模型和视图对象）对模型数据进行处理或对视图进行处理，modelAndView也可能为null。
     */
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {

    }

    /**
     * 整个请求处理完毕回调方法，即在视图渲染完毕时回调，如性能监控中我们可以在此记录结束时间并输出消耗时间，还可以进行一些资源清理，类似于try-catch-finally中的finally，但仅调用处理器执行链中
     */
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {

    }
}

这里放一个图可能更清楚的表现拦截器各方法的作用域:

实现HandlerInterceptor接口有个弊端，接口声明的三个方法必须要全部实现，但其实我们很多时候可能仅会用到这三个方法中的某几个方法而已，因此这里推荐另一种创建拦截器类的方式——实现拦截器适配器HandlerInterceptorAdapter(这是一种接口适配器模式的实现, 三种适配器模式的一种，这里不过多解释), 通过继承适配器类，我们可以仅实现我们需要用的方法，所以你的代码可能看起来是这样的（我们这里仅实现了一个预处理方法）：

@Component
public class UserCheckInterceptor extends HandlerInterceptorAdapter{
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 在这里写下你要预处理的逻辑
    }
}

2.  现在我们手上有个拦截器UserCheckInterceptor类了，那我们怎么把它装载上去呢? 在SpringBoot里这也很简单，我们只要自定义一个继承自WebMvcConfigurerAdapter的拦截器配置类，并实现其中的addInterceptors方法，将我们的拦截器添加进拦截器chain。你的代码看起来可能是这样的：

@Configuration
public class InterceptorConfiguration extends WebMvcConfigurerAdapter{

    @Autowired
    private SecurityInterceptor securityInterceptor;

    @Autowired
    private UserCheckInterceptor userCheckInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(securityInterceptor);
        registry.addInterceptor(userCheckInterceptor).addPathPatterns("/user/**");
    }
}

好了，大功告成就是这么简单。