当前位置: 首页 > news >正文

java web 过滤器

在 Java Web 开发中,过滤器(Filter)是 Servlet 规范中的一个重要组件,用于在请求到达 Servlet 之前或者响应返回客户端之前对请求和响应进行预处理或后处理。

过滤器的工作原理

过滤器的工作原理基于责任链模式。当客户端向服务器发送请求时,请求会先经过一系列过滤器,每个过滤器可以对请求进行修改、验证或拦截。请求依次通过过滤器链,最终到达目标 Servlet。当 Servlet 处理完请求并返回响应时,响应会按照相反的顺序再次经过这些过滤器,每个过滤器可以对响应进行修改或处理

过滤器的应用场景

  • 权限验证:检查用户是否有访问特定资源的权限。
  • 字符编码处理:统一设置请求和响应的字符编码,防止乱码问题。
  • 日志记录:记录请求的信息,如请求的 URL、参数等。
  • 敏感信息过滤:过滤请求中包含的敏感词汇。

过滤器的实现步骤

1. 实现 javax.servlet.Filter 接口

Filter 接口定义了三个方法:

  • init(FilterConfig filterConfig):在过滤器被创建时调用,用于初始化过滤器。
  • doFilter(ServletRequest request, ServletResponse response, FilterChain chain):对请求和响应进行处理的核心方法。
  • destroy():在过滤器被销毁时调用,用于释放资源。
import javax.servlet.*;
import java.io.IOException;public class CharacterEncodingFilter implements Filter {private String encoding;@Overridepublic void init(FilterConfig filterConfig) throws ServletException {// 从过滤器配置中获取字符编码encoding = filterConfig.getInitParameter("encoding");if (encoding == null) {encoding = "UTF-8";}}@Overridepublic void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)throws IOException, ServletException {// 设置请求的字符编码request.setCharacterEncoding(encoding);// 设置响应的字符编码response.setCharacterEncoding(encoding);// 将请求和响应传递给下一个过滤器或目标 Servletchain.doFilter(request, response);}@Overridepublic void destroy() {// 可以在这里释放资源}
}

2. 配置过滤器

可以通过 web.xml 或注解的方式配置过滤器。

使用 web.xml 配置

<filter><filter-name>CharacterEncodingFilter</filter-name><filter-class>com.example.CharacterEncodingFilter</filter-class><init-param><param-name>encoding</param-name><param-value>UTF-8</param-value></init-param>
</filter>
<filter-mapping><filter-name>CharacterEncodingFilter</filter-name><url-pattern>/*</url-pattern>
</filter-mapping>

使用注解配置(Servlet 3.0 及以上)

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;@WebFilter(filterName = "CharacterEncodingFilter", urlPatterns = "/*", initParams = {@WebInitParam(name = "encoding", value = "UTF-8")
})
public class CharacterEncodingFilter implements Filter {private String encoding;@Overridepublic void init(FilterConfig filterConfig) throws ServletException {encoding = filterConfig.getInitParameter("encoding");if (encoding == null) {encoding = "UTF-8";}}@Overridepublic void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)throws IOException, ServletException {request.setCharacterEncoding(encoding);response.setCharacterEncoding(encoding);chain.doFilter(request, response);}@Overridepublic void destroy() {// 可以在这里释放资源}
}

过滤器链

在一个 Web 应用中可以配置多个过滤器,这些过滤器会按照配置的顺序形成一个过滤器链。请求会依次通过过滤器链中的每个过滤器,响应则会按照相反的顺序返回。例如,有两个过滤器 FilterA 和 FilterB,配置顺序为 FilterA 在前,FilterB 在后,那么请求的处理顺序为:FilterA -> FilterB -> Servlet,响应的处理顺序为:Servlet -> FilterB -> FilterA

注意事项

  • 过滤器是单例的,在整个 Web 应用的生命周期中只会创建一个实例。
  • 过滤器的 doFilter 方法中必须调用 FilterChain 的 doFilter 方法,否则请求将无法到达目标 Servlet。
  • 在 init 方法中可以通过 FilterConfig 获取过滤器的初始化参数。
  • 在 destroy 方法中可以释放过滤器占用的资源,如关闭数据库连接等。

实例:

import javax.servlet.*;
import javax.servlet.annotation.WebFilter;
import java.io.IOException;// 使用 @WebFilter 注解配置过滤器,拦截所有请求
@WebFilter(filterName = "RequestLoggingFilter", urlPatterns = "/*")
public class RequestLoggingFilter implements Filter {@Overridepublic void init(FilterConfig filterConfig) throws ServletException {// 过滤器初始化方法,这里可以进行一些初始化操作,例如读取配置文件System.out.println("RequestLoggingFilter 初始化");}@Overridepublic void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)throws IOException, ServletException {// 记录请求开始时间long startTime = System.currentTimeMillis();// 获取 HttpServletRequest 对象,以便获取请求的详细信息javax.servlet.http.HttpServletRequest httpRequest = (javax.servlet.http.HttpServletRequest) request;// 获取请求的 URLString requestUrl = httpRequest.getRequestURL().toString();// 获取请求的方法(如 GET、POST 等)String requestMethod = httpRequest.getMethod();System.out.println("开始处理请求: " + requestMethod + " " + requestUrl);try {// 将请求传递给下一个过滤器或目标 Servletchain.doFilter(request, response);} finally {// 记录请求结束时间long endTime = System.currentTimeMillis();// 计算请求处理所花费的时间long processingTime = endTime - startTime;System.out.println("请求处理完成: " + requestMethod + " " + requestUrl + ",耗时: " + processingTime + " 毫秒");}}@Overridepublic void destroy() {// 过滤器销毁方法,这里可以进行一些资源释放操作System.out.println("RequestLoggingFilter 销毁");}
}    
  1. 注解配置@WebFilter(filterName = "RequestLoggingFilter", urlPatterns = "/*") 此注解将该类配置为过滤器,filterName 是过滤器的名称,urlPatterns = "/*" 表示该过滤器会拦截所有的请求。
  2. init 方法:在过滤器初始化时被调用,可用于执行一些初始化操作,例如读取配置文件。
  3. doFilter 方法:这是过滤器的核心方法,其主要工作如下:
    • 记录请求开始时间。
    • 把 ServletRequest 转换为 HttpServletRequest,从而获取请求的详细信息。
    • 输出请求的 URL 和请求方法。
    • 调用 chain.doFilter(request, response) 把请求传递给下一个过滤器或者目标 Servlet。
    • 计算请求处理所花费的时间并输出。
  4. destroy 方法:在过滤器销毁时被调用,可用于释放资源。

相关文章:

  • 好未来golang后端开发
  • 【Linux】第十五章 调度未来任务
  • 洛谷 B3644:【模板】拓扑排序 / 家谱树 ← 邻接表
  • elementui里的el-tabs的内置样式修改失效?
  • LeetCode - 02.02.返回倒数第 k 个节点
  • 自定义指令input中前面不能输入空格
  • WPF TextBlock控件性能优化指南
  • Dali 1.1.4 | 使用尖端技术将描述转换成独特艺术品、照片和图像,发挥无限创意
  • Docker容器资源控制--CGroup
  • 强化学习之基于无模型的算法之时序差分法
  • Python 数据智能实战 (2):LLM 工具箱搭建 - API/库实操与高效 Prompt 设计入门
  • react-新建项目复用node_modules
  • uni-app - 微信小程序中,使用 navigateTo 传递非常大的数字传参精度丢失的问题
  • 1.6 点云数据获取方式——单目相机多视图几何
  • SpringBoot获取用户信息常见问题(密码屏蔽、驼峰命名和下划线命名的自动转换)
  • 每日算法-250429
  • selenium IDE脚本如何转换为可运行的selenium webdriver java程序
  • leetcode 21. 合并两个有序链表(c++解法+相关知识点复习)
  • 如何用vivado导出pin delay
  • DevExpressWinForms-TreeList-设置不可编辑
  • 铁路上海站今日预计发送旅客65.8万人次,同比增长超16%
  • 中国海油总裁:低油价短期影响利润,但也催生资产并购机会
  • “75后”袁达已任国家发改委秘书长
  • 宋徽宗《芙蓉锦鸡图》亮相,故宫首展历代动物绘画
  • 国家卫健委:工作相关肌肉骨骼疾病、精神和行为障碍成职业健康新挑战
  • 上海数学教育及数学科普专家陈永明去世,享年85岁