Spring Boot 开发 -- 过滤器与拦截器详解

引言

在Web开发中，经常需要对请求进行预处理或在响应后进行后处理，Spring Boot提供了过滤器和拦截器两种机制来实现这一需求。虽然它们都可以用来处理HTTP请求和响应，但在使用场景、执行顺序和配置方式上存在明显的差异。本文将详细讲解Spring Boot中过滤器和拦截器的概念、使用方法和它们之间的区别。

一、过滤器（Filter）的配置

方式一：使用spring boot提供的FilterRegistrationBean注册Filter

1. 实现Filter接口：

创建一个类并实现javax.servlet.Filter接口，重写doFilter方法。

public class LogCostFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        long start = System.currentTimeMillis();
        filterChain.doFilter(servletRequest,servletResponse);
        System.out.println("Execute cost="+(System.currentTimeMillis()-start));
    }

    @Override
    public void destroy() {

    }
}

2. 注册自定义Filter

在Spring boot中，我们需要FilterRegistrationBean来完成配置。其实现过程如下：

@Configuration
public class FilterConfig {

    @Bean
    public FilterRegistrationBean registFilter() {
        FilterRegistrationBean registration = new FilterRegistrationBean();
        registration.setFilter(new LogCostFilter());
        registration.addUrlPatterns("/*");
        registration.setName("LogCostFilter");
        registration.setOrder(1);
        return registration;
    }

}

方式二：使用原生servlet注解定义Filter

除了通过 FilterRegistrationBean 来配置以外，还有一种更直接的办法，直接通过注解就可以完成了：

@WebFilter(urlPatterns = "/*", filterName = "logFilter2")
public class LogCostFilter2 implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {

    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        long start = System.currentTimeMillis();
        filterChain.doFilter(servletRequest, servletResponse);
        System.out.println("LogFilter2 Execute cost=" + (System.currentTimeMillis() - start));
    }

    @Override
    public void destroy() {

    }
}

这里直接用@WebFilter就可以进行配置，同样，可以设置url匹配模式，过滤器名称等。这里需要注意一点的是**@WebFilter这个注解是Servlet3.0的规范**，并不是Spring boot提供的。除了这个注解以外，我们还需在配置类中加另外一个注解：@ServletComponetScan，指定扫描的包。

@SpringBootApplication
@MapperScan("com.dz.blog.dao")
@ServletComponentScan("com.dz.blog.filters")
public class Application {
    public static void main(String[] args) throws Exception {
        SpringApplication.run(Application.class, args);
    }
}

二、拦截器（Interceptor）的配置

拦截器是Spring MVC框架中的一部分，用于在请求处理前后执行一些操作，如权限验证、日志记录等。拦截器通过实现HandlerInterceptor接口或继承HandlerInterceptorAdapter类来实现。

我们使用拦截器来实现上面同样的功能，记录请求的执行时间。

1. 首先我们实现拦截器类：

public class LogCostInterceptor implements HandlerInterceptor {
    long start = System.currentTimeMillis();
    @Override
    public boolean preHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o) throws Exception {
    	// 请求前处理逻辑  
        start = System.currentTimeMillis();
        // 如果返回false，则请求终止
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, ModelAndView modelAndView) throws Exception {
    	// 请求后处理逻辑
        System.out.println("Interceptor cost="+(System.currentTimeMillis()-start));
    }

    @Override
    public void afterCompletion(HttpServletRequest httpServletRequest, HttpServletResponse httpServletResponse, Object o, Exception e) throws Exception {
    	// 整个请求处理完毕后调用  
    }
}

2. 注册Interceptor：

在配置类中通过实现WebMvcConfigurer接口并重写addInterceptors方法来注册拦截器。

@Configuration
public class InterceptorConfig extends WebMvcConfigurerAdapter {

    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new LogCostInterceptor()).addPathPatterns("/**");
        super.addInterceptors(registry);
    }
}