Spring中的过滤器和拦截器

news2024/11/13 15:39:19

Spring中的过滤器和拦截器

一、引言

在Spring框架中，过滤器（Filter）和拦截器（Interceptor）是实现请求处理的两种重要机制。它们都基于AOP（面向切面编程）思想，用于在请求的生命周期中插入额外的处理逻辑。过滤器和拦截器虽然有相似之处，但在实现原理、触发时机、使用范围等方面存在明显差异。本文将深入探讨Spring中的过滤器和拦截器，并通过代码示例展示它们的具体应用。

二、过滤器和拦截器的实现与区别

1、过滤器（Filter）的实现

过滤器是基于Servlet规范的一部分，用于在请求进入Servlet之前或响应离开Servlet之后进行拦截处理。在Spring Boot项目中，可以通过实现Filter接口并使用@WebFilter注解来创建过滤器。

1.1、过滤器的代码示例

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;

@WebFilter(urlPatterns = "/*")
public class TestFilter implements Filter {
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        System.out.println("过滤器：执行 init 方法。");
    }

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("过滤器：开始执行 doFilter 方法。");
        // 请求放行
        filterChain.doFilter(servletRequest, servletResponse);
        System.out.println("过滤器：结束执行 doFilter 方法。");
    }

    @Override
    public void destroy() {
        System.out.println("过滤器：执行 destroy 方法。");
    }
}

2、拦截器（Interceptor）的实现

拦截器是Spring框架提供的一个组件，它基于动态代理实现，可以在请求的多个阶段进行拦截处理，如请求到达Controller之前、之后以及视图渲染之后。

2.1、拦截器的代码示例

import org.springframework.stereotype.Component;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

@Component
public class TestInterceptor implements HandlerInterceptor {
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        System.out.println("拦截器：执行 preHandle 方法。");
        return true;
    }

    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        System.out.println("拦截器：执行 postHandle 方法。");
    }

    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("拦截器：执行 afterCompletion 方法。");
    }
}

三、过滤器和拦截器的区别

在这里插入图片描述

1、实现原理不同

过滤器（Filter）是基于Java Servlet规范的一部分，它的工作原理是函数回调。在过滤器中，doFilter方法是核心，它接收一个FilterChain对象作为参数，这个对象代表过滤器链中的下一个过滤器或目标资源（如Servlet）。通过调用filterChain.doFilter(request, response)，过滤器可以控制请求的流动，决定是否将请求传递给下一个过滤器或目标资源。这种机制允许开发者在请求处理的不同阶段插入自定义逻辑，如身份验证、日志记录等。

拦截器（Interceptor）则是Spring框架提供的一个高级功能，它基于Java的动态代理机制实现。拦截器可以拦截进入Controller之前的请求，Controller处理之后的请求，以及响应完成后的处理。拦截器的实现依赖于HandlerInterceptor接口，开发者需要实现该接口的preHandle、postHandle和afterCompletion方法。这些方法分别在请求处理的不同阶段被调用，允许开发者在请求的前后插入逻辑，如权限检查、数据预处理等。

2、使用范围不同

过滤器的使用范围受限于Servlet容器，因此它们只能在Web应用程序中使用。过滤器的作用域是整个Web容器，可以对所有的请求进行过滤，包括对静态资源（如图片、CSS、JavaScript文件）的请求。

拦截器的使用范围则更广，因为它是Spring框架的一部分，不依赖于Servlet容器。这意味着拦截器不仅可以在Web应用程序中使用，还可以在任何Spring管理的应用程序中使用，如非Web的Spring应用。这使得拦截器的使用更加灵活，可以跨越不同的应用类型。

3、触发时机不同

过滤器的触发时机是在请求进入Servlet容器后，但在到达具体的Servlet之前，以及在响应离开Servlet容器之后。这意味着过滤器可以在请求被Spring的DispatcherServlet处理之前或之后执行。

拦截器的触发时机则与过滤器不同。拦截器在请求进入Servlet容器后，在到达Controller之前被触发，以及在Controller处理请求之后和响应完成后。这允许拦截器在请求处理的更细粒度的阶段插入逻辑。

4、拦截的请求范围不同

过滤器可以拦截所有进入Servlet容器的请求，包括对静态资源的请求。这意味着过滤器可以用来处理如请求日志、请求限流、请求内容的修改等通用功能。

拦截器主要拦截发送到Controller的请求。由于拦截器是Spring框架的一部分，它们只能拦截那些由Spring MVC的DispatcherServlet处理的请求。这意味着拦截器不能拦截对静态资源的请求，但可以拦截对Controller的请求，这使得拦截器非常适合用于处理与业务逻辑相关的任务，如权限检查、业务日志记录等。

通过这些详细的比较，我们可以更清晰地理解过滤器和拦截器的不同之处，以及它们在实际开发中的适用场景。