秒懂SpringBoot之弄懂Filter与HandlerInterceptor

03/05/2023 2540点热度 3人点赞 3条评论

[版权申明] 非商业目的注明出处可自由转载
出自：shusheng007

@[toc]

概述

在日常开发中，我们会经常用到Filter和HandlerInterceptor，是不是傻傻分不清，那二者有什么异同呢？谁先执行谁后执行呢？分别在什么场景下使用呢？接下来让我们来一探究竟

前置知识

先上一张偶亲手画的图吧，正所谓一图胜千言，不理解无所谓，我们一起来看下。

你有没有觉得在一个熟悉的领域学习相关的新知识就非常容易理解，因为他们直接环环相扣，互相联系，这就是所谓的经验的优势。例如我们今天要谈论的Filter和HandlerIntercetor，如果你不具备Sevlet以及SpringMvc原理的基础知识就会显得很晦涩，而对于有这部分知识的同学就会显得非常的简单易懂。此处我简单描述一下，作为理解下面内容的背景知识。

利用SpringMvc开发的Web程序需要运行在Servlet容器中（Web服务器），例如Tomcat。
SpringMvc使用一个叫DispatcherServlet的组件来接收所有的请求，然后分发给我们写得Controller。

假设我们使用springboot写了一个helloworld的web程序，使用内置的Tomcat来运行，那么一个请求过来会按照下面的路径处理。

request-->tomcat-->filter-->dispatcherSevlet-->handlerInterceptor-->controller

Filter

原理及使用场景

首先Filter不属于Spring框架，而是属于WebServer的，例如Tomcat，其位于org.apache.tomcat.embed:tomcat-embed-core中。

因为请求到达servlet之前都要经过Filter，在此我们可以访问Request和Response，因而可以做很多切面性的工作，最典型的就是授权和认证。例如Spring Security就是使用Filter工作的。

使用

在springboot程序中实现一个Filter非常简单，只需要实现javax.servlet.Filter接口并使用@Component标记即可

@Slf4j
@Component
public class AuthFilter implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        HttpServletRequest request = (HttpServletRequest) servletRequest;
        log.info("AuthFilter请求url：{}", request.getRequestURL());

        filterChain.doFilter(servletRequest, servletResponse);
    }
}

在doFilter方法中我们可以拿到ServletRequest 和ServletResponse ，因而可以获取到非常多请求相关的信息，然后根据自己的业务来处理即可

执行顺序

既然有多个Filter，那么就会存在执行顺序问题，我们如何控制多个Filter的执行顺序呢？

可以使用@Order注解

@Slf4j
@Order(1)
@Component
public class AuthFilter implements Filter {
    ...
}

order里的数字越小越早执行。

设置Filter作用范围

默认情况下Filter将作用于每个请求，我们可以设置让其只作用于某些特定的请求，例如我我们设置AuthFilter 只作用于/auth开头的请求。在这里也可以设置执行顺序，其优先级高于@Order。

@Configuration
public class FilterConfiguration {
    @Autowired
    private AuthFilter authFilter;

    @Bean
    public FilterRegistrationBean<AuthFilter> filterRegistrationBean() {
        FilterRegistrationBean<AuthFilter> registrationBean = new FilterRegistrationBean<>();
        registrationBean.setFilter(authFilter);
        registrationBean.addUrlPatterns("/auth/*");
        registrationBean.setOrder(0);
        return registrationBean;
    }
}

通过这种方法还可以使用第三方的Filter。

HandlerInterceptor

原理及使用场景

HandlerInterceptor 是SpringMvc的组件，其位于DispatcherServlet与Controller之间。其位于
org.springframework:spring-webmvc中。

使用

在springboot程序中实现一个HandlerInterceptor也较为简单，但是比Filter难一点，需要两步。

实现`org.springframework.web.servlet.HandlerInterceptor` 接口

其包含3个default方法，我们选择性的实现即可，preHandle使用的频率更高。

preHandle：在Controller方法执行之前执行
postHandle：在Controller方法执行以后，但是还没有渲染页面之前执行。

这就是它为什么多了一个ModelAndView 类型的参数，但是如今流行前后端分离，所以一般都是返回json数据给前端，不会返回html页面，所以这个参数几乎不怎么用的到。

afterCompletion：在Controller方法完全执行完毕后触发

下面是一个实现：

@Slf4j
public class LogInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        log.info("preHandle {}:{}:{}",request.getRequestURL(),response.getStatus(),handler);
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        log.info("postHandle {}:{}:{}:{}",request,response,handler,modelAndView);
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        log.info("afterCompletion {}:{}:{}:{}",request,response,handler,ex);
    }
}

配置

有了Interceptor还需要一些配置使其生效，我们需要实现org.springframework.web.servlet.config.annotation.WebMvcConfigurer 。因为SpringBoot已经默认启用了@EnableWebMvc，所以可以使用这个接口的实现类配置web相关的功能，这个接口的可配置项纷繁复杂，幸好SpringBoot已经帮我们配置了默认值，不然就蛋疼了... 这里我们只需要重写addInterceptors即可

@Configuration
public class WebConfig implements WebMvcConfigurer {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LogInterceptor());
    }
}

二者异同

共同点

在SpringMvc中二者均可以实现切面性的工作，例如认证授权，记录Log等。

不同点

首先两个东西隶属于不同的框架，Filter更具通用性，粒度更粗。例如你只能从Filter里面拿到http请求相关的信息，而拿不到应用层面的信息，例如你写的那个Controller里面的信息。HandlerInterceptor属于SpringMvc的，它的通用性更差，但是控制粒度更细，因为可以获取到应用层面的信息了。例如我现在想在log中记录类名和方法名，Filter就做不到，但是SpringSecurity这类业务无关框架却又不能使用Interceptor。