首页 > 编程语言 >JavaWeb之过滤器

JavaWeb之过滤器

时间：2024-09-29 17:51:54浏览次数：8  
标签：请求 void Filter doFilter 过滤器 public JavaWeb

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博客

 

标签：请求,void,Filter,doFilter,过滤器,public,JavaWeb
From： https://blog.csdn.net/gege_0606/article/details/142481762

相关文章

  • javaweb基于SSH开发小型学生宿舍管理系统源码+报告 课程设计 大作业
    ......
  • javaweb学习4
    今天主要学习了获取数据库连接的操作和mavenmaven导入mysql和druidjar包具体的jar坐标可以去这个网站找https://mvnrepository.com/<dependencies><dependency><groupId>mysql</groupId><artifactId>mysql-connector-java</artifactId......
  • 基于JavaWeb技术的在线考试系统设计与实现（11551）
     有需要的同学，源代码和配套文档领取，加文章最下方的名片哦一、项目演示项目演示视频二、资料介绍完整源代码（前后端源代码+SQL脚本）配套文档（LW+PPT+开题报告）远程调试控屏包运行三、技术介绍Java语言SSM框架SpringBoot框架Vue框架JSP页面Mysql数据库IDEA/Eclipse开发四、项......
  • springcloud的gateway使用全局过滤器
    全局过滤器是可以做一些统一的事情，比如认证鉴权、日志处理等@ComponentpublicclassLogFilterimplementsGlobalFilter,Ordered{Loggerlog=LoggerFactory.getLogger(this.getClass());@OverridepublicMono<Void>filter(ServerWebExchangeexchange,G......
  • JavaWeb基础-学习笔记01
    01JavaWeb介绍一个Web的互联网系统可以分为三个主要部分：网页、JavaWeb程序、数据库网页：展现数据数据库：存储和管理数据javaWeb程序：逻辑处理因此，JavaWeb的学习内容对应以上三部分内容：数据库部分MySQL：一款主流的数据库产品（数据库管理系统），用结构化查询语言SQL操作数据库JD......
  • 面试官：项目中如何实现布隆过滤器？
    谈起“布隆过滤器”相信大家都不陌生，它也算日常面试中的常见面试题了。例如，当面试官在问到Redis模块的相关问题时，可能会问到缓存穿透（Redis四大经典问题之一），而缓存穿透的经典解决方案之一，则是“布隆过滤器”。但是，对于布隆过滤器是什么？以及布隆过滤器的实现原理？相信大部分同学......
  • javaWeb项目-springboot+vue+mysql财务管理系统功能说明介绍
    项目源码资源（点击链接下载）：java-springboot+vue财务管理系统源码(项目源码-说明文档)资源-CSDN文库项目关键技术： 1、java技术java页面实质上也是一个HTML页面，只不过它包含了用于产生动态网页内容的JAVA代码，这些JAVA代码可以是JAVABean、SQL语句、RMI对象等。例如一个java......
  • 2.Javaweb-JSP实现数据传递和保存
    Javaweb-JSP实现数据传递和保存文章目录Javaweb-JSP实现数据传递和保存一、get与post区别二、equest对象常用方法三、内置对象--out对象JSP已经准备好的，可以直接使用的对象四、中文乱码JSP中默认使用的字符编码方式：iso-8859-1，不支持中文解决中文乱码参数传递在请求中保......
  • 1.Javaweb-搭建Web环境、初识JSP
    Javaweb-搭建Web环境、初识JSP文章目录Javaweb-搭建Web环境、初识JSP一、pc端程序架构分类：二、web服务器Tomcat三、JSP页面四、脚本语言五、Web程序常见错误六、错误替换JSP九大内置对象（包括JSP四大作用域）JSP四大作用域一、pc端程序架构分类：B/S：浏览器—服务......
  • javaweb学习2 -2024/9/24
    今天学习了数据库中约束的概念数据库-约束约束的概念约束是作用于表中列上的规则,用于限制加入表的数据约束的存在保证了数据库中数据的正确性,有效性和完整性约束的分类#约束createtableemp2(#自动增长auto_increment当列时数据类型并且唯一约束id......

赞助商

阅读排行

网站主页关于我们联系我们网站地图

本网站内容转载自其他媒体，侵权联系[admin##ips99.com]。

Copyright © 2020-2023 IPS99 版权所有 IPS99