SpringBoot Interceptor 简单应用

SpringBoot Interceptor 简单应用

文章目录

• • 简单介绍
  • 使用步骤
  • 示例代码
  • 拦截器与过滤器对比
  • API介绍
  • 拦截器多次执行问题
  • 待研究问题

简单介绍

HandlerInterceptor是Springboot应用提供的拦截器，拦截的对象是spring的Handler，Handler就是我们常见的Controller，也就是说，HandlerInterceptor就是Controller的拦截器。

主要使用场景

1. springboot拦截器功能和过滤器类似，都是可以在业务代码执行前后进行类似切面的处理
2. 通常也可以用于鉴权、日志、监控的场景

使用步骤

1. 创建一个拦截器，实现Springboot拦截器基础接口，HandlerInterceptor，这是实际的拦截器
2. 创建一个类，继承WebMvcConfigurationSupport或者实现WebMvcConfigurer，用于配置和注册拦截器

示例代码

创建拦截器

@Component
public class baseInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("拦截器前置处理");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("拦截器后置处理");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("拦截器请求结束处理");
    }
}

创建配置类

@Configuration
public class InterceptorConfiguration implements WebMvcConfigurer {
    @Autowired
    baseInterceptor baseInterceptor;

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(baseInterceptor).addPathPatterns("/**").order(-100);
    }
}

完成，调用效果如下

拦截器--前置处理
Hello World
拦截器--后置处理
拦截器--请求结束处理

拦截器与过滤器对比

1. Filter是Servlet层面的概念，HandlerInterceptor是Springboot封装的应用层的概念，受Filter的约束
2. Filter的优先级比HandlerInterceptor高，总是先执行Filter
3. Filter的功能更加基础，更加强大，两个的关系有点像TCP和HTTP的关系。

API介绍

//在handler之前执行，如果返回false，流程终止，不执行Controller
default boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler);

//Controller方法处理完之后，DispatcherServlet进行视图的渲染之前执行
default void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
		@Nullable ModelAndView modelAndView) ;

//DispatcherServlet进行视图的渲染之后
default void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
		@Nullable Exception ex);

拦截器多次执行问题

做一个简单的实验，在Controller中抛出一个异常，可以发现，拦截器会被执行2次，这是一个需要注意的问题。

原因

• 由于直接抛出异常后，Tomcat会去请求一个错误页面，请求路径是/error，这相当于是一个新的http请求，从而对于所有path都匹配的拦截器来说，就会执行两次

解决方案

• 可以配置拦截器指定匹配，或者过滤掉/error这种系统保留路径
• 可以设置全局异常拦截，确保最终返回给用户的不是异常，而是处理后的响应

待研究问题

1. 学习拦截器和Filter的源码，熟悉原理
2. 在Controller抛出异常的实验中，发现异常的堆栈打印是在第一次拦截的结束处理之后，这是什么原因？