SpringBoot之拦截器

上一篇对过滤器的定义做了说明，也比较简单。过滤器属于Servlet范畴的API，与Spring 没什么关系。 Web开发中，我们除了使用 Filter 来过滤请web求外，还可以使用Spring提供的HandlerInterceptor（拦截器）。HandlerInterceptor 的功能跟过滤器类似，但是提供更精细的的控制能力：在request被响应之前、request被响应之后、视图渲染之前以及request全部结束之后。我们不能通过拦截器修改request内容，但是可以通过抛出异常（或者返回false）来暂停request的执行。
实现自定义拦截器只需要3步：
1、创建我们自己的拦截器类并实现 HandlerInterceptor 接口。
2、创建一个Java类继承WebMvcConfigurerAdapter，并重写 addInterceptors 方法。
2、实例化我们自定义的拦截器，然后将对像手动添加到拦截器链中（在addInterceptors方法中添加）。

代码实现

@Component
public class TimeInterceptor implements HandlerInterceptor {
    private Logger logger = Logger.getLogger(this.getClass());

    /**
     * 进入controler之前执行此方法
     *
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o
     * @return
     * @throws Exception
     */
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
        logger.info("==============preHandle====================");
          Gson gson = new GsonBuilder().enableComplexMapKeySerialization().create();
        logger.info("请求接口:{},请求参数{}",request.getRequestURL(),gson.toJson(request.getParameterMap()));
        return true;// 只有返回true才会继续向下执行，返回false取消当前请求
    }

    /**
     * 退出controler之后执行此方法（controler没有异常）
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o
     * @param modelAndView
     * @throws Exception
     */
    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
        logger.info("==============postHandle====================" + o);
    }

    /**
     * 退出controler之后执行此方法（无论是否异常）
     * @param httpServletRequest
     * @param httpServletResponse
     * @param o
     * @throws Exception
     */
    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
        logger.info("==============afterCompletion====================");

    }
}

@Configuration
public class TimeInterceptorConfig extends WebMvcConfigurerAdapter {

    //拦截器1
    @Autowired
    private TimeInterceptor timeInterceptor;

    //拦截器2
    @Autowired
    private TimeTwoInterceptor timeTwoInterceptor;


    /**
     * 添加自定义拦截器
     * @param registry
     */
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        //注册拦截器
        InterceptorRegistration timeTwo = registry.addInterceptor(timeTwoInterceptor);
        InterceptorRegistration time = registry.addInterceptor(timeInterceptor);
        //配置拦截路径
        timeTwo.addPathPatterns("/*");
        time.addPathPatterns("/*");
        //忽略拦截路径
        timeTwo.excludePathPatterns("/do");
        time.excludePathPatterns("/user");
    }
}

先放到InterceptorRegistration 的拦截器先执行。

多个拦截器执行顺序

---

拦截器和过滤器区别参考：http://blog.youkuaiyun.com/Kincym/article/details/78920918