JSP 过滤器零基础入门教程

在开始学习 JSP 过滤器之前，先来打个通俗的比方。想象一下，你去超市买东西，入口处的保安会检查你是否带着危险物品，出口处的工作人员会检查你是否付款。这里的“保安”和“出口工作人员”就类似于过滤器，他们在你进入或离开一个区域时进行检查或处理。而 JSP 过滤器，就像是网站的“守门员”，每当有请求到来或者响应返回时，它都先“拦截”一下，看看有没有需要先处理的事情。

一、过滤器是什么？

JSP 过滤器是 Java 类，主要作用如下：

• 拦截请求：在请求访问后端资源时进行拦截，就像超市入口的保安。
• 处理响应：管理服务器返回给客户端的响应，类似超市出口的检查。

过滤器在实际开发中应用场景丰富，以下是一些常见的类型：

• 认证过滤器：检查用户是否登录，未登录则拦截，跳转到登录页。
• 数据压缩过滤器：对响应数据进行压缩，提升传输效率。
• 加密过滤器：对敏感数据进行加密处理，确保数据安全。
• 日志过滤器：记录请求相关信息，便于问题排查和数据分析（我们后面会重点讲解这种类型）。

二、过滤器怎么用？

1. 创建过滤器类

过滤器需要实现javax.servlet.Filter接口，这个接口就像是过滤器的标准操作手册，规定了过滤器需要具备哪些基本功能。接口中有三个主要方法：

• init(FilterConfig filterConfig)：容器调用这个方法表明过滤器开始工作。这里可以获取一些初始化参数，比如配置文件中的设置值。
• doFilter(ServletRequest request, ServletResponse response, FilterChain chain)：每当有请求或响应要通过过滤器时，容器都会调用这个方法。在这里可以编写你想要执行的拦截或处理逻辑。
• destroy()：容器调用这个方法表明过滤器即将被移除。可以在这里进行资源清理等操作。

下面是一个简单的日志过滤器示例，它会记录客户端的IP地址和访问时间：

// 引入必要的Java包
import java.io.*;
import javax.servlet.*;
import javax.servlet.http.*;
import java.util.*;

// 实现Filter接口
public class LogFilter implements Filter {
    public void init(FilterConfig config) throws ServletException {
        // 获取初始化参数
        String testParam = config.getInitParameter("test-param");
        System.out.println("初始化参数：Test Param = " + testParam);
    }

    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
        throws IOException, ServletException {
        // 获取客户端IP地址
        String ipAddress = request.getRemoteAddr();
        // 获取当前时间
        String currentTime = new Date().toString();

        // 在控制台输出日志信息（实际开发中建议使用日志框架如Log4j）
        System.out.println("来自IP：" + ipAddress + " 的请求，时间：" + currentTime);

        // 将请求继续传递给下一个过滤器或目标资源
        chain.doFilter(request, response);
    }

    public void destroy() {
        // 在过滤器被移除前进行资源清理等操作
    }
}

2. 配置过滤器

创建好过滤器类后，需要在web.xml文件中进行配置。web.xml就像是网站的“说明书”，告诉服务器哪些过滤器需要被使用，以及在什么情况下使用。

<filter>
    <filter-name>LogFilter</filter-name> <!-- 过滤器名称 -->
    <filter-class>LogFilter</filter-class> <!-- 过滤器类名 -->
    <init-param>
        <param-name>test-param</param-name> <!-- 初始化参数名称 -->
        <param-value>来自编程狮的初始化参数</param-value> <!-- 初始化参数值 -->
    </init-param>
</filter>

<filter-mapping>
    <filter-name>LogFilter</filter-name> <!-- 对应上面定义的过滤器名称 -->
    <url-pattern>/*</url-pattern> <!-- 过滤器应用的URL模式，这里表示所有请求都会被拦截 -->
</filter-mapping>

三、过滤器的作用顺序

如果定义了多个过滤器，它们的执行顺序由web.xml文件中<filter>元素的定义顺序决定。先定义的过滤器先执行，后定义的过滤器后执行。

例如：

<filter>
    <filter-name>AuthenFilter</filter-name> <!-- 定义认证过滤器 -->
    <filter-class>AuthenFilter</filter-class>
</filter>

<filter>
    <filter-name>LogFilter</filter-name> <!-- 定义日志过滤器 -->
    <filter-class>LogFilter</filter-class>
</filter>

<filter-mapping>
    <filter-name>AuthenFilter</filter-name> <!-- 映射认证过滤器 -->
    <url-pattern>/*</url-pattern>
</filter-mapping>

<filter-mapping>
    <filter-name>LogFilter</filter-name> <!-- 映射日志过滤器 -->
    <url-pattern>/*</url-pattern>
</filter-mapping>

上面的配置中，AuthenFilter先于LogFilter执行。

四、为什么要用过滤器？

过滤器就像是网站的“过滤网”，可以让我们在请求到达目标资源之前或响应返回客户端之前，进行一系列的操作。比如：

• 统一处理日志：记录用户的访问信息，方便后续分析用户行为、排查问题。
• 权限控制：检查用户是否有权限访问某个资源，没有权限就直接拦截。
• 数据预处理：对请求数据进行格式转换、加密等操作。
• 资源优化：对响应数据进行压缩，加快页面加载速度。

五、总结

JSP过滤器是Java Web开发中的重要工具，通过实现Filter接口，我们可以创建自定义的过滤器类，并在web.xml中进行配置。过滤器可以按照定义的顺序依次执行，帮助我们实现请求拦截、响应处理等功能。对于初学者来说，可以从简单的日志过滤器入手，逐步理解过滤器的工作原理和应用场景。在实际项目中，合理运用过滤器可以大大提高代码的可维护性和项目的性能。