【Java 进阶篇】Java Filter 过滤器拦截路径配置详解

过滤器（Filter）是 Java Web 应用中一种强大的组件，它可以用于在请求到达目标资源之前或响应返回客户端之前执行一些预处理或后处理操作。其中，过滤器的拦截路径配置是非常重要的，它决定了过滤器会拦截哪些请求。在本文中，我们将深入探讨 Java Filter 过滤器的拦截路径配置，为开发者提供详细的解释和示例。

过滤器拦截路径的基本概念

过滤器通过 doFilter 方法来执行过滤操作，而过滤器是否执行，取决于它的拦截路径配置。在 Java Web 应用中，过滤器的拦截路径可以通过 web.xml 文件或注解进行配置。

使用 web.xml 进行配置

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

<!-- 定义过滤器 -->
<filter>
    <filter-name>MyFilter</filter-name>
    <filter-class>com.example.MyFilter</filter-class>
</filter>

<!-- 配置过滤器的拦截路径 -->
<filter-mapping>
    <filter-name>MyFilter</filter-name>
    <url-pattern>/my/*</url-pattern>
</filter-mapping>

上述配置表示 MyFilter 过滤器将拦截所有以 “/my/” 开头的请求路径。

使用注解进行配置

除了使用 web.xml 外，还可以使用注解来配置过滤器的拦截路径。在过滤器类上添加 @WebFilter 注解，指定 urlPatterns 属性即可。以下是一个使用注解配置的例子：

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

@WebFilter(filterName = "MyFilter", urlPatterns = {"/my/*"},
        initParams = {
                @WebInitParam(name = "param1", value = "value1"),
                @WebInitParam(name = "param2", value = "value2")
        })
public class MyFilter implements Filter {
    // 过滤器的具体实现
    // ...
}

上述注解表示 MyFilter 过滤器将拦截所有以 “/my/” 开头的请求路径，并且定义了两个初始化参数。

拦截路径的匹配规则

在拦截路径的配置中，常用的匹配符号有两种：* 和 /。下面详细介绍它们的使用规则。

* 匹配符

* 匹配符用于匹配一个路径部分（不包含 /）。例如，/abc/* 可以匹配 /abc/xyz、/abc/123 等路径。

<url-pattern>/abc/*</url-pattern>

/ 匹配符

/ 匹配符用于匹配路径的根。例如，/* 可以匹配所有路径。

<url-pattern>/*</url-pattern>

示例：用户权限验证过滤器

下面通过一个用户权限验证的过滤器示例来说明拦截路径的配置。

import javax.servlet.Filter;
import javax.servlet.FilterChain;
import javax.servlet.FilterConfig;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebFilter;
import javax.servlet.annotation.WebInitParam;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

@WebFilter(filterName = "AuthFilter", urlPatterns = {"/secure/*"})
public class AuthFilter implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        // 在此处进行用户权限验证
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        HttpServletResponse httpResponse = (HttpServletResponse) response;

        // 假设用户权限验证通过
        if (userHasPermission(httpRequest)) {
            // 用户权限验证通过，继续执行请求
            chain.doFilter(request, response);
        } else {
            // 用户权限验证失败，重定向到登录页面
            httpResponse.sendRedirect(httpRequest.getContextPath() + "/login");
        }
    }

    private boolean userHasPermission(HttpServletRequest request) {
        // 在此处实现具体的用户权限验证逻辑
        // 返回 true 表示用户有权限，返回 false 表示用户无权限
        // 这里仅为示例，实际实现应根据业务逻辑进行判断
        String username = (String) request.getSession().getAttribute("username");
        return username != null && username.equals("admin");
    }

    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 过滤器初始化方法
    }

    @Override
    public void destroy() {
        // 过滤器销毁方法
    }
}

在上述示例中，我们创建了一个名为 AuthFilter 的过滤器，使用 @WebFilter 注解配置了它的拦截路径为 /secure/*。该过滤器实现了用户权限验证的逻辑，如果用户有权限，则继续执行请求；如果用户无权限，将重定向到登录页面。

在实际应用中，开发者可以根据具体业务需求和权限验证逻辑来调整和扩展该过滤器。

总结

本文详细介绍了在 Java Web 应用中配置过滤器的拦截路径，包括使用 web.xml 文件和注解两种方式。通过示例演示了拦截路径的匹配规则，并通过用户权限验证过滤器的例子说明了拦截路径配置的实际应用。

过滤器是 Web 应用中强大的组件之一，正确配置拦截路径是保证过滤器按照预期工作的关键。希望本文对开发者理解和使用 Java Web 过滤器提供了帮助。

作者信息 作者 ： 繁依Fanyi CSDN： https://techfanyi.blog.csdn.net 掘金：https://juejin.cn/user/4154386571867191