JavaWeb三大组件之一的Filter详解

Filter是JavaWeb三大组件之一，它的作用是过滤请求并对请求做出必要的处理，例如，对于某些请求需要进行权限验证、日志记录等处理，这个时候Filter就可以派上用场了。本文将详细讲解Filter的使用方式和常用的应用场景。

一、Filter的使用方式

1.1 定义Filter类

可以通过实现javax.servlet.Filter接口定义Filter类，该接口中有三个方法需要实现：init(), doFilter()和destroy()。其中，init()方法在Filter创建时被自动调用，用于初始化Filter；doFilter()方法是Filter中最重要的方法，它接受Servlet的请求并对请求进行处理，如果请求符合过滤条件，则继续执行该请求，并将请求传递给下一个Filter或者Servlet；destroy()方法在Filter销毁时被调用，用于释放资源。

一个简单的Filter类的定义如下：

public class MyFilter implements Filter {
    @Override
    public void init(FilterConfig config) throws ServletException {
        //初始化方法
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        //处理请求的方法
        chain.doFilter(request, response);
    }

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

1.2 配置Filter

要使Filter生效，需要在web.xml中进行配置，配置方式如下：

<filter>
    <filter-name>myFilter</filter-name>
    <filter-class>com.example.MyFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>myFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

其中，<filter-name>指定Filter的名称，<filter-class>指定Filter的类名，<filter-mapping>指定Filter的映射关系，<url-pattern>指定需要过滤的URL路径。

二、Filter的应用场景

2.1 鉴权认证

通过Filter可以对请求进行鉴权认证，判断请求是否合法。例如，我们可以对需要登录的请求进行拦截并进行登录验证，如果没有登录则重定向到登录页面。以下是一个简单的示例：

public class AuthFilter implements Filter {
    @Override
    public void init(FilterConfig config) throws ServletException {
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        //判断是否登录
        HttpSession session = ((HttpServletRequest) request).getSession();
        if (session.getAttribute("user") == null) {
            ((HttpServletResponse) response).sendRedirect("/login");
            return;
        }
        chain.doFilter(request, response);
    }

    @Override
    public void destroy() {
    }
}

在web.xml中进行配置：

<filter>
    <filter-name>authFilter</filter-name>
    <filter-class>com.example.AuthFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>authFilter</filter-name>
    <url-pattern>/protected/*</url-pattern>
</filter-mapping>

此时，所有以/protected/开头的请求都需要进行登录验证。

2.2 记录日志

通过Filter还可以记录请求日志，例如请求URL、请求参数、请求时间等。以下是一个简单的示例：

public class LogFilter implements Filter {
    @Override
    public void init(FilterConfig config) throws ServletException {
    }

    @Override
    public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        long start = System.currentTimeMillis();

        chain.doFilter(request, response);

        String uri = ((HttpServletRequest) request).getRequestURI();
        String params = ((HttpServletRequest) request).getQueryString();
        long end = System.currentTimeMillis();
        long elapsedTime = end - start;
        System.out.println(String.format("Request: %s, Parameters: %s, Time: %d ms", uri, params, elapsedTime));
    }

    @Override
    public void destroy() {
    }
}

在web.xml中进行配置：

<filter>
    <filter-name>logFilter</filter-name>
    <filter-class>com.example.LogFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>logFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

此时，所有请求都会被记录日志。