深入了解 Java 拦截器与过滤器

在构建 Java Web 应用程序时，拦截器（Interceptor） 和 过滤器（Filter） 是两个重要的概念。它们在不同阶段拦截和处理 HTTP 请求和响应，帮助开发者对应用的处理流程进行更精细的控制。

虽然它们在表面上看似相似，但拦截器和过滤器有着不同的架构设计和使用场景。本文将详细介绍它们的工作原理、应用场景及其区别。

一、拦截器（Interceptor）

1.1 拦截器的定义

拦截器是一种 AOP（面向切面编程）机制，用于拦截目标方法的调用。在 Web 应用中，它通常用于在请求进入控制器（Controller）之前或在请求结束之后执行一些逻辑操作。拦截器的核心作用是对应用的控制层进行增强，例如权限验证、日志记录和异常处理等。

拦截器的应用与框架紧密相关，在 Spring MVC 框架中尤为常见。

1.2 拦截器的生命周期

拦截器有三个核心的生命周期方法，分别对应请求的不同阶段：

1. preHandle()：该方法在请求进入控制器方法之前执行，用于进行前置处理，例如权限检查或请求参数验证。如果该方法返回 false，请求将被中断，不会继续向下执行。

2. postHandle()：该方法在控制器方法执行之后，视图渲染之前调用。可以在这里对控制器返回的数据进行修改或对视图做进一步调整。

3. afterCompletion()：在整个请求处理完成并且视图渲染结束后调用，通常用于清理资源或记录最终的日志。

1.3 拦截器的实现示例

在 Spring MVC 中，拦截器通过实现 HandlerInterceptor 接口来定义，具体示例如下：

public class MyInterceptor implements HandlerInterceptor {

    // 该方法在目标方法执行之前调用
    @Override
    public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception {
        // 前置处理，例如权限检查、日志记录等
        System.out.println("Pre-handle method is called");
        return true;  // 返回 true 表示继续执行，返回 false 则中断请求
    }

    // 该方法在目标方法执行之后调用
    @Override
    public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception {
        // 对请求处理后的结果进行修改或扩展
        System.out.println("Post-handle method is called");
    }

    // 请求处理完毕后调用，通常用于清理资源
    @Override
    public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception {
        System.out.println("After-completion method is called");
    }
}

1.4 拦截器的配置

拦截器通常需要在 Spring 的配置文件（如 applicationContext.xml）或 Java 配置类中注册：

@Configuration
public class WebConfig implements WebMvcConfigurer {
    
    @Override
    public void addInterceptors(InterceptorRegistry registry) {
        registry.addInterceptor(new MyInterceptor())
                .addPathPatterns("/**")  // 拦截所有请求
                .excludePathPatterns("/login", "/logout");  // 排除特定路径
    }
}

1.5 拦截器的常见应用场景

• 用户认证和权限检查：在请求进入控制器之前，判断用户是否具有访问权限。
• 请求日志记录：记录每个请求的关键信息，例如 URL、IP 地址、执行时间等。
• 数据预处理：对请求参数进行处理或验证，例如对表单数据进行预处理。
• 全局异常处理：捕获控制器中的异常并进行统一处理。

二、过滤器（Filter）

2.1 过滤器的定义

过滤器是 Servlet 规范的一部分，它位于 Web 应用的请求和响应链中，能够在请求进入目标资源（如 Servlet、JSP、静态资源）之前或响应发送到客户端之前，对请求和响应进行处理。

与拦截器不同，过滤器关注整个请求/响应的生命周期，而不仅仅是控制器层面的操作。

2.2 过滤器的生命周期

过滤器的生命周期主要包括以下几个阶段：

1. init()：过滤器初始化阶段，在 Web 容器启动时调用，只会执行一次。

2. doFilter()：过滤器的核心方法，每个请求都会进入该方法。该方法可以：

   • 对请求对象（ServletRequest）进行修改。
   • 继续传递请求到下一个过滤器或目标资源（通过 FilterChain 调用 doFilter()）。
   • 对响应对象（ServletResponse）进行修改。

3. destroy()：在 Web 容器销毁或应用程序关闭时调用，用于清理资源。

2.3 过滤器的实现示例

过滤器的实现需要继承 javax.servlet.Filter 接口，示例如下：

public class MyFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 初始化过滤器，只执行一次
        System.out.println("Filter initialized");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        // 前置处理
        System.out.println("Request intercepted by filter");

        // 继续调用下一个过滤器或资源
        chain.doFilter(request, response);

        // 后置处理
        System.out.println("Response intercepted by filter");
    }

    @Override
    public void destroy() {
        // 过滤器销毁时调用
        System.out.println("Filter destroyed");
    }
}

2.4 过滤器的配置

过滤器可以通过 web.xml 配置，也可以通过注解进行配置：

web.xml 配置示例：

<filter>
    <filter-name>myFilter</filter-name>
    <filter-class>com.example.MyFilter</filter-class>
</filter>

<filter-mapping>
    <filter-name>myFilter</filter-name>
    <url-pattern>/*</url-pattern>  <!-- 拦截所有路径 -->
</filter-mapping>

注解方式配置：

@WebFilter(urlPatterns = "/*")
public class MyFilter implements Filter {
    // 实现 doFilter 方法
}

2.5 过滤器的常见应用场景

• 请求日志记录：可以记录所有 HTTP 请求及其相关信息。
• 安全控制：对不合法的请求进行过滤，例如过滤掉 SQL 注入攻击等恶意请求。
• 统一编码设置：通过过滤器统一设置请求和响应的字符编码格式，避免出现乱码问题。
• 压缩响应数据：对 HTTP 响应进行压缩，以减少数据传输量，提高传输效率。

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

虽然拦截器和过滤器在功能上有一定的重叠，但它们的设计目的和工作机制存在显著区别：

3.1 使用过滤器的场景

• 需要对请求进行全局控制，如字符编码统一处理。
• 在整个应用的层面进行日志记录、安全检查等操作。
• 操作与请求/响应流直接相关的数据。

3.2 使用拦截器的场景

• 对特定的控制器进行权限检查、参数验证。
• 实现 AOP 逻辑，如日志记录、事务管理、性能监控。
• 对控制器层面的业务逻辑进行增强。

四、总结

拦截器和过滤器是 Java Web 开发中的两个重要工具，它们都可以用于在请求处理过程中执行预处理和后处理逻辑。两者的主要区别在于作用范围和执行顺序：过滤器是基于 Servlet 容器的，作用于整个请求/响应的生命周期；而拦截器则专注于控制器层的处理，在特定的请求路径中提供更细粒度的控制。

根据项目需求合理选择拦截器和过滤器，可以帮助开发者更好地管理请求的生命周期和应用的业务逻辑。

希望通过这篇文章，你能更加深入理解 Java 中拦截器和过滤器的机制与区别。如果你喜欢这篇文章,请点个赞和收藏吧。祝点赞和收藏的帅哥美女们今年都能暴富。如果有更多问题，欢迎随时提问。