1. 过滤器的概念
过滤器是Java Servlet规范中定义的组件,用于在请求到达Servlet之前或响应返回客户端之前,对请求或响应进行拦截和处理。过滤器可以实现以下功能:
- 日志记录:记录请求的详细信息,如URI、参数、时间等。
- 身份验证和授权:检查用户是否已登录,是否有权限访问资源。
- 输入输出编码处理:处理请求和响应的字符编码,防止乱码。
- 请求和响应的修改:可以对请求参数或响应内容进行修改。
2. 过滤器的工作原理
过滤器通过拦截器链(Filter Chain)来工作。当客户端发送请求时,Servlet容器根据配置将请求交给符合条件的过滤器。过滤器可以选择对请求进行处理,然后通过FilterChain
将请求传递给下一个过滤器或目标资源。响应返回时,过滤器也有机会对响应进行处理。
3. 过滤器的生命周期
过滤器的生命周期由Servlet容器管理,主要包括以下方法:
init(FilterConfig filterConfig)
:在过滤器被创建时调用,进行初始化操作。doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
:每次拦截请求时调用,包含过滤逻辑。destroy()
:在过滤器被销毁前调用,用于释放资源。
4. 实现过滤器接口
要创建一个过滤器,需要实现javax.servlet.Filter
接口,并重写上述三个方法。示例:
public class LoggingFilter implements Filter {
public void init(FilterConfig filterConfig) throws ServletException {
// 初始化操作
}
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
// 过滤逻辑
chain.doFilter(request, response); // 放行请求
}
public void destroy() {
// 资源释放操作
}
}
注意导包不要导错了,不然没有doFilter方法的!!!
5. 过滤器的配置
过滤器可以通过两种方式进行配置:
5.1 在web.xml
中配置
<filter>
<filter-name>LoggingFilter</filter-name>
<filter-class>com.example.LoggingFilter</filter-class>
</filter>
<filter-mapping>
<filter-name>LoggingFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
5.2 使用注解配置
@WebFilter(urlPatterns = "/*", filterName = "LoggingFilter")
public class LoggingFilter implements Filter {
// 实现方法
}
6. doFilter
方法详解
doFilter
方法是过滤器的核心,它包含了对请求和响应的处理逻辑。
-
参数说明:
ServletRequest request
:请求对象。ServletResponse response
:响应对象。FilterChain chain
:过滤器链,用于将请求传递给下一个过滤器或目标资源。
-
放行请求:通过调用
chain.doFilter(request, response)
,将请求传递给下一个过滤器或目标资源。 -
处理顺序:在
chain.doFilter()
之前的代码会在请求到达目标资源之前执行;chain.doFilter()
之后的代码会在目标资源处理完毕、响应返回之前执行。
7. 过滤器链和过滤器的顺序
-
过滤器链:多个过滤器可以组成一个链条,按照配置的顺序依次执行。
-
执行顺序:在
web.xml
中,过滤器的执行顺序由<filter-mapping>
的配置顺序决定。先配置的先执行。 -
示例:
<filter-mapping> <filter-name>AuthFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping> <filter-mapping> <filter-name>LoggingFilter</filter-name> <url-pattern>/*</url-pattern> </filter-mapping>
在上述配置中,
AuthFilter
会先于LoggingFilter
执行。
当请求到达时,过滤器链的执行顺序如下:
- 第一个过滤器的
doFilter
方法被调用。 - 该过滤器在完成前处理后,调用
chain.doFilter(request, response)
将请求和响应传递给下一个过滤器。 - 如果还有更多过滤器,它们的
doFilter
方法将依次被调用,直到链的最后一个过滤器。 - 最后,目标资源(如 servlet)处理请求并生成响应。
- 响应返回时,过滤器将依次完成后处理,直到第一个过滤器的
doFilter
方法结束。(像栈一样,先进后处理完成)
代码实操:
设置三个过滤器,看TomCat控制台的输出即可得到其顺序
servlet1:
package com.Gege.filters;
import jakarta.servlet.*;
import jakarta.servlet.annotation.WebFilter;
import java.io.IOException;
@WebFilter("/*")
public class filter1 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
Filter.super.init(filterConfig);
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("filter1 before doFilter invoked");
filterChain.doFilter(servletRequest,servletResponse);
System.out.println("filter1 after doFilter invoked");
}
@Override
public void destroy() {
Filter.super.destroy();
}
}
servlet2:
package com.Gege.filters;
import jakarta.servlet.*;
import jakarta.servlet.annotation.WebFilter;
import java.io.IOException;
@WebFilter("/*")
public class filter2 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
Filter.super.init(filterConfig);
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("filter2 before doFilter invoked");
filterChain.doFilter(servletRequest,servletResponse);
System.out.println("filter2 after doFilter invoked");
}
@Override
public void destroy() {
Filter.super.destroy();
}
}
servlet3:
package com.Gege.filters;
import jakarta.servlet.*;
import jakarta.servlet.annotation.WebFilter;
import java.io.IOException;
@WebFilter("/*")
public class filter3 implements Filter {
@Override
public void init(FilterConfig filterConfig) throws ServletException {
Filter.super.init(filterConfig);
}
@Override
public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
System.out.println("filter3 before doFilter invoked");
filterChain.doFilter(servletRequest,servletResponse);
System.out.println("filter3 after doFilter invoked");
}
@Override
public void destroy() {
Filter.super.destroy();
}
}
XML的配置:
<filter>
<filter-name>filter1</filter-name>
<filter-class>com.Gege.filters.filter1</filter-class>
</filter>
<filter-mapping>
<filter-name>filter1</filter-name>
<url-pattern>/servlet/*</url-pattern>
</filter-mapping>
<filter>
<filter-name>filter2</filter-name>
<filter-class>com.Gege.filters.filter2</filter-class>
</filter>
<filter-mapping>
<filter-name>filter2</filter-name>
<url-pattern>/servlet/*</url-pattern>
</filter-mapping>
<filter>
<filter-name>filter3</filter-name>
<filter-class>com.Gege.filters.filter3</filter-class>
</filter>
<filter-mapping>
<filter-name>filter3</filter-name>
<url-pattern>/servlet/*</url-pattern>
</filter-mapping>
执行顺序1->2->3
输出顺序3->2->1
8. 过滤器的应用场景
-
安全控制:验证用户身份,检查权限,防止未授权的访问。
-
日志记录:记录请求和响应的信息,便于调试和审计。
-
数据压缩:对响应内容进行压缩,提高传输效率。
-
字符编码处理:统一处理请 求和响应的字符编码,防止乱码。
-
敏感词过滤:过滤请求参数或响应内容中的敏感词汇
9. 过滤器的URL匹配和过滤范围
-
url-pattern
的配置:决定了过滤器应用于哪些请求。-
/*
:匹配所有请求。 -
/servlet/*
:匹配以/servlet/
开头的请求。 -
*.jsp
:匹配所有以.jsp
结尾的请求。
-
-
排除特定路径:如果需要排除某些路径,可以在过滤器中添加条件判断,或者在配置中精确指定需要过滤的路径。
13. 示例代码
以下是一个完整的过滤器示例,实现了请求日志记录功能:
@WebFilter(urlPatterns = "/*", filterName = "LoggingFilter")
public class LoggingFilter implements Filter {
private SimpleDateFormat dateFormat;
public void init(FilterConfig filterConfig) throws ServletException {
dateFormat = new SimpleDateFormat("yyyy/MM/dd HH:mm:ss");
}
public void doFilter(ServletRequest req, ServletResponse resp, FilterChain chain)
throws IOException, ServletException {
// 转换为HttpServletRequest,因为要用子类的方法
HttpServletRequest request = (HttpServletRequest) req;
String requestURI = request.getRequestURI();
String dateTime = dateFormat.format(new Date());
long t1 = System.currentTimeMillis();
// 请求到达目标资源之前的处理
System.out.println(requestURI + " 在 " + dateTime + " 被访问了");
// 放行请求
chain.doFilter(req, resp);
// 请求处理完毕后的处理
long t2 = System.currentTimeMillis();
System.out.println(requestURI + " 资源在 " + dateTime + " 的请求耗时:" + (t2 - t1) + " 毫秒");
}
public void destroy() {
// 资源释放
}
}
FilterConfig 对象
FilterConfig
是过滤器的配置对象,提供以下方法:
getFilterName()
:获取过滤器的名称。getInitParameter(String name)
:获取初始化参数的值。getInitParameters()
:获取所有初始化参数的值。getServletContext()
:获取ServletContext
对象,允许访问应用程序的上下文信息。
示例代码
这个过滤器将在初始化时读取一个配置参数,并在处理请求时打印过滤器的名称和上下文路径。
import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;
@WebFilter("/*")
public class MyFilter implements Filter {
private String filterName;
private String initParamValue;
@Override
public void init(FilterConfig filterConfig) throws ServletException {
// 获取过滤器的名称
filterName = filterConfig.getFilterName();
// 获取初始化参数
initParamValue = filterConfig.getInitParameter("myParam");
// 获取 ServletContext 对象
ServletContext context = filterConfig.getServletContext();
String contextPath = context.getContextPath();
System.out.println("Filter Name: " + filterName);
System.out.println("Context Path: " + contextPath);
System.out.println("Initialization Parameter (myParam): " + initParamValue);
}
@Override
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)
throws IOException, ServletException {
// 在请求到达目标资源之前的处理
System.out.println("Request received in filter: " + filterName);
// 放行请求
chain.doFilter(request, response);
// 在响应返回客户端之前的处理
System.out.println("Response processed in filter: " + filterName);
}
@Override
public void destroy() {
// 清理资源
System.out.println("Destroying filter: " + filterName);
}
}
web.xml 配置
为了使用初始化参数,需要在 web.xml
中定义过滤器和参数:
<filter>
<filter-name>MyFilter</filter-name>
<filter-class>com.example.MyFilter</filter-class>
<init-param>
<param-name>myParam</param-name>
<param-value>HelloFilter</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>MyFilter</filter-name>
<url-pattern>/*</url-pattern>
</filter-mapping>
说明
-
init
方法:- 使用
filterConfig.getFilterName()
获取过滤器的名称,并存储在filterName
变量中。 - 使用
filterConfig.getInitParameter("myParam")
获取名为myParam
的初始化参数的值。 - 使用
filterConfig.getServletContext()
获取ServletContext
对象,并获取上下文路径。
- 使用
-
doFilter
方法:- 在请求到达目标资源之前和响应返回之前,打印过滤器的名称。
-
destroy
方法:- 在过滤器被销毁时打印信息。
FilterChain 对象
FilterChain
是过滤器链对象,允许过滤器将请求和响应传递给下一个过滤器或目标资源。主要方法:
doFilter(ServletRequest request, ServletResponse response)
:将请求和响应传递给下一个过滤器或目标资源。如果这是最后一个过滤器,则目标资源会被调用。
推荐更多好文:
JavaWeb过滤器(Filter)详解,是时候该把过滤器彻底搞懂了(万字说明)_webfilter-CSDN博客