Servlet 过滤器

Servlet 过滤器是 Java Web 应用程序中非常重要的组件，它可以对请求和响应进行拦截和处理。本文将详细介绍 Servlet 过滤器的概念、工作原理、使用场景及实现方式。

一、Servlet 过滤器的基本概念

Servlet 过滤器是实现了 javax.servlet.Filter 接口的 Java 类，它可以在请求到达 Servlet 之前对请求进行预处理，也可以在响应返回客户端之前对响应进行后处理。过滤器可以用于多种场景，如字符编码转换、权限验证、日志记录、压缩响应数据等。

二、Servlet 过滤器的工作原理

Servlet 过滤器的工作流程如下：

1. 客户端发送 HTTP 请求
2. 请求首先到达过滤器链
3. 过滤器链中的每个过滤器按顺序对请求进行处理
4. 请求最终到达目标 Servlet
5. Servlet 处理请求并生成响应
6. 响应按相反顺序通过过滤器链
7. 每个过滤器可以对响应进行后处理
8. 最终响应返回给客户端

三、Servlet 过滤器的使用场景

Servlet 过滤器的常见应用场景包括：

• 字符编码处理：确保请求和响应使用统一的字符编码
• 权限验证：检查用户是否有权限访问特定资源
• 日志记录：记录请求和响应信息
• 数据压缩：压缩响应数据以减少传输量
• 敏感信息过滤：过滤请求或响应中的敏感信息

四、Servlet 过滤器的实现

下面通过一个完整的示例来演示如何实现一个简单的 Servlet 过滤器。

使用 @WebFilter 注解 配置 3 个过滤器，分别实现以下功能：

1. 日志记录：打印请求信息；
2. 字符编码设置：设置 UTF-8 编码；
3. 身份验证：检查请求参数 auth=true，否则返回 401。

1. 日志记录过滤器（LoggingFilter.java）

@WebFilter("/*")
public class LoggingFilter implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        System.out.println("请求开始: " + request.getRemoteAddr());
        chain.doFilter(request, response);
        System.out.println("请求结束");
    }
}

2. 字符编码过滤器（CharacterEncodingFilter.java）

@WebFilter("/*")
public class CharacterEncodingFilter implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        request.setCharacterEncoding("UTF-8");
        response.setCharacterEncoding("UTF-8");
        chain.doFilter(request, response);
    }
}

3. 身份验证过滤器（AuthenticationFilter.java）

@WebFilter("/hello")
public class AuthenticationFilter implements Filter {
    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
            throws IOException, ServletException {
        HttpServletRequest httpRequest = (HttpServletRequest) request;
        HttpServletResponse httpResponse = (HttpServletResponse) response;

        if ("true".equals(httpRequest.getParameter("auth"))) {
            chain.doFilter(request, response);
        } else {
            httpResponse.sendError(HttpServletResponse.SC_UNAUTHORIZED, "未授权");
        }
    }
}

@WebFilter("/hello") 表示该过滤器将匹配以下两种 URL 模式：

1. 精确匹配：完全等于 /hello 的 URL 路径
2. 扩展匹配：以 /hello/ 开头的所有子路径

4. 示例 Servlet（HelloServlet.java）

@WebServlet("/hello")
public class HelloServlet extends HttpServlet {
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws IOException {
        resp.getWriter().write("Hello, world!");
        System.out.println("世界，你好");
    }
}

五、过滤器链的执行顺序

当有多个过滤器同时存在时，它们会形成一个过滤器链。过滤器的执行顺序由以下因素决定：

1.注解配置：

如果使用@WebFilter注解配置过滤器，执行顺序由过滤器类的全名（包括包名）的字典序决定

@WebFilter(urlPatterns = "/*")
public class FilterA implements Filter { ... }

@WebFilter(urlPatterns = "/*")
public class FilterB implements Filter { ... }

假设 FilterA 的全类名是com.example.filter.FilterA，FilterB 的全类名是com.example.filter.FilterB，那么执行顺序是：FilterA → FilterB → Servlet → FilterB → FilterA

2.web.xml 配置：

如果使用 web.xml 配置过滤器，执行顺序由<filter-mapping>标签的顺序决定

<filter>
    <filter-name>filterA</filter-name>
    <filter-class>com.example.filter.FilterA</filter-class>
</filter>
<filter>
    <filter-name>filterB</filter-name>
    <filter-class>com.example.filter.FilterB</filter-class>
</filter>

<filter-mapping>
    <filter-name>filterA</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<filter-mapping>
    <filter-name>filterB</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

执行顺序是：FilterA → FilterB → Servlet → FilterB → FilterA

3.Servlet 3.0 + 的配置方式：

使用@Order注解或实现Ordered接口指定顺序 

@WebFilter(urlPatterns = "/*")
@Order(1)
public class FilterA implements Filter { ... }

@WebFilter(urlPatterns = "/*")
@Order(2)
public class FilterB implements Filter { ... }