Filter源码

javax.servlet.Filter

 接口是 Java Servlet API 的一部分，它用于在 Servlet 执行请求之前或响应之后对请求和响应进行预处理和后处理。这个接口包含三个方法：init(), doFilter(), 和 destroy()

package javax.servlet;

public interface Filter {
    default void init(javax.servlet.FilterConfig filterConfig) throws javax.servlet.ServletException { /* compiled code */ }

    void doFilter(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse, javax.servlet.FilterChain filterChain) throws java.io.IOException, javax.servlet.ServletException;

    default void destroy() { /* compiled code */ }
}

1. init(FilterConfig filterConfig) 方法：

   • 在 Filter 实例被创建后调用。
   • 用于初始化 Filter。
   • 参数 FilterConfig 提供了 Filter 的配置信息和 Servlet 上下文。

2. doFilter(ServletRequest request, ServletResponse response, FilterChain chain) 方法：

   • 核心方法，用于执行过滤操作。
   • 接受请求（ServletRequest）和响应（ServletResponse）对象，以及 Filter 链（FilterChain）。
   • 可以在将请求传递给链中的下一个实体前或向客户端发送响应后，对它们进行检查或修改。

3. destroy() 方法：

   • 在销毁 Filter 实例前调用。
   • 用于释放 Filter 占用的资源。

示例代码

package com.example;

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

public class LogFilter implements Filter {

    @Override
    public void init(FilterConfig filterConfig) {
        // 初始化代码，例如读取 Filter 的配置参数
        System.out.println("LogFilter 初始化");
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) 
            throws IOException, ServletException {
        // 请求到达前的处理
        System.out.println("LogFilter 开始处理请求");

        // 将请求传递给下一个 Filter 或 Servlet
        chain.doFilter(request, response);

        // 响应返回后的处理
        System.out.println("LogFilter 处理请求完成");
    }

    @Override
    public void destroy() {
        // 销毁时的清理代码
        System.out.println("LogFilter 销毁");
    }
}