JavaWeb之过滤器

news2024/9/29 16:57:38

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方法的!!!

d0b861492bfa49f987809e48dafa7449.png

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执行。

        当请求到达时,过滤器链的执行顺序如下:

  1. 第一个过滤器的 doFilter 方法被调用。
  2. 该过滤器在完成前处理后,调用 chain.doFilter(request, response) 将请求和响应传递给下一个过滤器。
  3. 如果还有更多过滤器,它们的 doFilter 方法将依次被调用,直到链的最后一个过滤器。
  4. 最后,目标资源(如 servlet)处理请求并生成响应。
  5. 响应返回时,过滤器将依次完成后处理,直到第一个过滤器的 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>

 

3c0711e0778d41059ecc20340bb58845.png

执行顺序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博客

 

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/2177358.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

Hugging Face + JuiceFS:多用户多节点环境下提升模型加载效率

Hugging Face 的 Transformers 是一个功能强大的机器学习框架&#xff0c;提供了一系列 API 和工具&#xff0c;用于预训练模型的下载和训练。为了避免重复下载&#xff0c;提高训练效率&#xff0c;Transformers 会自动下载和缓存模型的权重、词表等资源&#xff0c;默认存储在…

官方权威解读|CNAS-CL01过程部分解读,抽样部分

CNAS-CL01文件是软件测试实验室申请CNAS软件评测机构资质的重要参考材料&#xff0c;也是CNAS软件测试实验室建立质量管理体系的重要依据。近日CNAS为响应国家相关要求&#xff0c;组织开展了一系列专题调研。结合行业关注热点问题&#xff0c;推出了认可评审案例系列。前面的文…

macOS 新系统必知道:窗口分屏终于来了

对于很多从 Windows 转换到 macOS 的用户来说&#xff0c;最不习惯的一点可能就是窗口管理了。 Windows 系统自 Windows 7 开始就支持通过拖拽应用窗口至屏幕边缘来实现快速的分屏操作&#xff0c;到了 Windows 11 这一功能更是进化得更加灵活多变&#xff0c;允许用户根据需要…

临床常用的焦虑测评量表有哪些?

常笑医学整理了5个临床常用的焦虑测评量表&#xff0c;包括焦虑自评表&#xff08;SAS&#xff09;、状态-特质焦虑问卷&#xff08;STAI&#xff09;等。这些量表在常笑医学网均支持在线评估、下载和创建项目使用。 01 焦虑自评表&#xff08;SAS&#xff09; &#xff08;完…

ECCV 2024 | 融合跨模态先验与扩散模型,快手处理大模型让视频画面更清晰!

计算机视觉领域顶级会议 European Conference on Computer Vision&#xff08;ECCV 2024&#xff09;将于9月29日至10月4日在意大利米兰召开&#xff0c;快手音视频技术部联合清华大学所发表的题为《XPSR: Cross-modal Priors for Diffusion-based Image Super-Resolution》——…

原宝,四周年快乐!

原神&#xff0c;公测于2020年9月28日开启。 现在已经是第4个年头了&#xff0c;7个国家已经开放了6个&#xff0c;来到了火之国。其实自从2022年继续开放游戏版号以来&#xff0c;好品质的二次元游戏、三端游戏也是层出不穷。无论是立绘&#xff0c;建模都有非常优秀的作品。…

柯桥学英语商务口语中老外最爱说的“what‘s up“是什么意思?回答错超尴尬!

“Whats up&#xff1f;” 在看美剧或者和老外聊天的时候 我们总能听到这句话 那你知道这句老外很爱说的 “whats up”是什么意思吗&#xff1f; 快和小编一起来学习吧~ 01 whats up 怎么理解&#xff1f; 很多人觉得Whats up就是更地道的“How are you”&#xff0c;嗯………

Tkinter制作登录界面以及登陆后页面切换(一)

Tkinter制作登录界面以及登陆后页面切换&#xff08;一&#xff09; 前言序言1. 由来2. 思路3. 项目结构描述4. 项目实战1. 登录界面实现&#xff08;代码&#xff09;2. 首页界面实现&#xff08;代码&#xff09;3. 打包build.py&#xff08;与main.py同级目录&#xff09;4.…

kafka发送消费核心参数与设计原理详解

核心参数详解: 发送端参数: 发送方式:默认值一般都是1: 重试参数 : 批量参数: 消费端参数: 自动提交参数: 如果是false,就是说消费完后不提交位移。也就是说比如之前消费的1-5.第N次还是消费到1-5.如果是false。那么第一次消费1-3,第二次消费4-5:默认是true:我们…

制定六西格玛人才培养方案需要考虑哪些因素?

当下&#xff0c;六西格玛作为一种先进的质量管理方法&#xff0c;被越来越多的企业采纳并应用于日常管理和流程优化中。然而&#xff0c;要成功实施六西格玛&#xff0c;关键在于培养一支具备高度专业素养和实战能力的六西格玛人才队伍。那么&#xff0c;制定六西格玛人才培养…

基于微信小程序的交友平台

作者&#xff1a;计算机学姐 开发技术&#xff1a;SpringBoot、SSM、Vue、MySQL、JSP、ElementUI、Python、小程序等&#xff0c;“文末源码”。 专栏推荐&#xff1a;前后端分离项目源码、SpringBoot项目源码、Vue项目源码、SSM项目源码、微信小程序源码 精品专栏&#xff1a;…

软件游戏运行缺少vcruntime140.dll怎么办?总结四种有效简单方法

1. 文件基本信息 1.1 定义与作用 vcruntime140.dll是Microsoft Visual C 2015 Redistributable Package的一部分&#xff0c;它包含了C运行时库&#xff0c;用于支持使用Visual C开发的Windows应用程序。这个动态链接库&#xff08;DLL&#xff09;文件提供了程序执行时所需的…

可视化服务编排:jvs-logic API出参加密实战教程

在现代软件开发与系统集成的过程中&#xff0c;API&#xff08;应用程序接口&#xff09;非常重要&#xff0c;它能使不同系统之间连接&#xff0c;进行数据交换和功能调用。当然&#xff0c;数据交换的数据安全肯定是不可忽视的&#xff0c;为了确保数据在传输过程中的保密性和…

基于Java(Spring+Struts+Hibernate 框架)实现(Web)学生课程管理系统

课程管理系统设计文档 一、更新历史 二、引言 2.1 目的 本文档详细描述了课程管理系统的设计&#xff0c;达到引导开发的作用&#xff0c;同时实现测试人员以及用户的沟通。本文档面向开发人员&#xff0c;测试人员以及最终用户编写&#xff0c;是了解系统的导航。2.2 范围…

五金精密加工提升效率的方法与技巧

在五金精密加工领域&#xff0c;提高加工效率是企业增强竞争力的关键。以下是一些有效的提升方法与技巧。 一、优化加工设备 设备升级与更新 定期评估加工设备的性能&#xff0c;引进先进的五金精密加工机床。例如&#xff0c;高精度的数控加工中心能够实现多轴联动加工&#x…

开放式蓝牙耳机哪个品牌更靠谱?5款高性价比开放式耳机推荐

谈到开放式蓝牙耳机哪个品牌更靠谱&#xff0c;市场上有许多优秀的选择。以前也经常使用入耳式耳机&#xff0c;但总是会感觉耳机插在耳朵里不舒服&#xff0c;戴久了耳朵很疼&#xff0c;跑步的时候还总掉。还有在过马路的时候接电话、听音乐&#xff0c;几乎感知不到周围环境…

【HarmonyOS】深入理解LocalStorage之逻辑处理存取

【HarmonyOS】深入理解LocalStorage 一、前言 鸿蒙应用中关于状态管理的处理机制有很多。从状态装饰器State prop等&#xff0c;LocalStrong&#xff0c;AppStrong到首选项&#xff0c;再到数据库。内存到持久化。轻量级到重量级。全方位覆盖。 学习和记忆技术点&#xff0c…

springboot实现沙箱支付退款

<!DOCTYPE html> <html lang"en"> <head><meta charset"UTF-8"><title>商城与订单管理</title><link rel"stylesheet" href"https://unpkg.com/element-ui/lib/theme-chalk/index.css"><…

websocket集群部署遇到的一些事

最近刚好有个场景&#xff0c;业务处理一份报告需要关注实时处理的进度。 本来打算使用前端轮训方式&#xff0c;但是考虑到这样效率比较低&#xff0c;也无法精确知道处理进度&#xff0c;就想到用websocket和前端实时交互&#xff0c;进度有更新就通知前端&#xff0c;避免了…

【Qt】系统相关学习--底层逻辑--代码实践

Qt事件 基本概念 理解Qt事件 事件是用户与应用程序之间交互的基础。它允许应用程序对用户的输入做出响应&#xff0c;例如鼠标点击一下又或者用户键盘输入相应内容。也就是说每一次用户与应用程序交互的时候&#xff0c;都会产生一个事件&#xff0c;然后传递给相应的控件或者…