【Java 进阶篇】Java Filter 过滤器链详解

news2024/12/27 10:47:28

在这里插入图片描述

过滤器（Filter）是 Java Web 应用中重要的组件之一，它用于在请求到达 Servlet 之前或响应返回客户端之前对请求和响应进行处理。在实际开发中，我们可能会使用多个过滤器来完成不同的任务，这就引出了过滤器链的概念。本文将详细介绍 Java 中过滤器链的工作原理和使用方法。

过滤器链简介

过滤器链是由多个过滤器按照一定的顺序组成的链状结构。当请求到达 Servlet 之前，或者响应返回客户端之前，请求和响应都会依次经过过滤器链中的每个过滤器，每个过滤器都可以对请求和响应进行处理。过滤器链的执行顺序由过滤器在 web.xml 文件或使用注解配置时的顺序决定。

过滤器链的执行流程

过滤器链的执行流程可以分为以下几个阶段：

过滤器初始化： 在 Web 应用启动时，所有配置的过滤器都会被初始化。在初始化阶段，过滤器可以执行一些必要的初始化操作。
请求到达过滤器链： 当客户端发起请求时，请求会经过过滤器链。每个过滤器在 doFilter 方法中执行自己的逻辑，然后调用过滤器链上的下一个过滤器的 doFilter 方法。
Servlet 处理请求： 如果请求通过了所有过滤器的处理，它将到达目标 Servlet。Servlet 处理完请求后，响应会返回到过滤器链。
响应经过过滤器链： 响应会按照与请求相反的顺序经过过滤器链。每个过滤器在 doFilter 方法中执行自己的逻辑，然后调用过滤器链上的下一个过滤器的 doFilter 方法。
过滤器销毁： 在 Web 应用关闭或被卸载时，过滤器将被销毁。在销毁阶段，过滤器可以执行一些必要的清理操作。

过滤器链的配置

通过 `web.xml` 文件配置过滤器链

在 web.xml 文件中，可以通过 <filter> 和 <filter-mapping> 元素配置过滤器及其拦截路径。以下是一个简单的示例：

<web-app>
    <!-- 配置过滤器 -->
    <filter>
        <filter-name>Filter1</filter-name>
        <filter-class>com.example.Filter1</filter-class>
    </filter>
    <filter>
        <filter-name>Filter2</filter-name>
        <filter-class>com.example.Filter2</filter-class>
    </filter>

    <!-- 配置过滤器映射 -->
    <filter-mapping>
        <filter-name>Filter1</filter-name>
        <url-pattern>/secure/*</url-pattern>
    </filter-mapping>
    <filter-mapping>
        <filter-name>Filter2</filter-name>
        <url-pattern>/secure/*</url-pattern>
    </filter-mapping>
</web-app>

在上述示例中，我们配置了两个过滤器 Filter1 和 Filter2，并指定它们的拦截路径为 /secure/*。请求经过该路径时，将会依次执行 Filter1 和 Filter2。

通过注解配置过滤器链

使用注解配置过滤器链更加简洁，可以在过滤器类上使用 @WebFilter 注解进行配置。以下是一个使用注解配置过滤器链的示例：

@WebFilter(filterName = "Filter1", urlPatterns = {"/secure/*"})
public class Filter1 implements Filter {
    // 过滤器的实现
}

@WebFilter(filterName = "Filter2", urlPatterns = {"/secure/*"})
public class Filter2 implements Filter {
    // 过滤器的实现
}

在上述示例中，我们通过 @WebFilter 注解配置了两个过滤器 Filter1 和 Filter2，并指定它们的拦截路径为 /secure/*。

过滤器链的工作原理

过滤器链的工作原理涉及到 FilterChain 接口，它定义了过滤器链的基本操作。FilterChain 接口包含一个 doFilter 方法，该方法用于在过滤器链上执行过滤器的逻辑，并调用链上的下一个过滤器。以下是 FilterChain 接口的简化版本：

public interface FilterChain {
    void doFilter(ServletRequest request, ServletResponse response) throws IOException, ServletException;
}

在过滤器的 doFilter 方法中，开发者需要显式调用 FilterChain 的 doFilter 方法，以便请求能够继续传递到下一个过滤器。如果在某个过滤器的 doFilter 方法中没有调用 FilterChain 的 doFilter 方法，请求将被阻塞，不会继续传递到后续的过滤器或 Servlet。

下面是一个简单的过滤器示例，演示了如何在 doFilter 方法中调用过滤器链：

@WebFilter(filterName = "MyFilter", urlPatterns = {"/secure/*"})
public class MyFilter implements Filter {
    
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        // 执行过滤器的逻辑，例如对请求进行处理
        
        // 调用过滤器链的下一个过滤器
        chain.doFilter(request, response);
        
        // 执行过滤器的逻辑，例如对响应进行处理
    }

    // 其他方法，例如初始化和销毁方法
}

在上述示例中，MyFilter 过滤器通过调用 chain.doFilter(request, response) 将请求传递给过滤器链的下一个过滤器。在此之前和之后，可以编写一些逻辑来处理请求和响应。

过滤器链的顺序

过滤器链的执行顺序由过滤器在配置时的顺序决定。在 web.xml 文件或使用注解配置时，过滤器的声明顺序就是它们在过滤器链中的执行顺序。

在 web.xml 文件中配置过滤器时，可以使用 <filter-mapping> 元素的 <dispatcher> 子元素来指定过滤器的拦截类型。例如：

<filter-mapping>
    <filter-name>Filter1</filter-name>
    <url-pattern>/secure/*</url-pattern>
    <dispatcher>REQUEST</dispatcher>
</filter-mapping>