JavaWeb之过滤器

于 2024-09-29 13:34:52 发布
阅读量272 收藏 13
点赞数 16
分类专栏： JavaWeb 文章标签： java javaweb 过滤器
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/gege_0606/article/details/142481762
版权

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

 

代码代码快快显灵
关注
专栏目录
javaweb之过滤器
jerry_wzj_的博客
07-19 179
javaweb之过滤器（Filter） 作用：对前端的请求或servlet的响应进行拦截并过滤 创建过滤器 1.创建一个类实现Filter接口并重写方法 2.定义过滤器的参数：如要过滤的访问路径 3.在doFilter方法中，写过滤代码，即对请求参数的过滤 过滤器细节 web.xml配置 <filter> <filter-name>过滤器名称</filter-name> <filter-class>过滤器所在路径</filter-class&gt
Javaweb之过滤器
smilecb的博客
01-15 155
filter 过滤器 1.1概念        web中的过滤器：当服务器请求资料时，过滤器可以将请求拦截下来，完成一些特殊的功能 1.2过滤器的作用        一般用于完成一些通用的操作。如：登录验证，统一编码处理，敏感字符过滤 2.快速入门 步骤 定义一个类实现接口Filter 复写方法 配置拦截路径:1.注解   2.web
javaWEB之过滤器
weixin_44339867的博客
10-29 202
javaWEB三大组件，Servlet、Listener、Filter，在上一篇博客中javaWEB监听器介绍了监听器，这篇博客记录一下过滤器 FIlter 1、什么是过滤器 过滤器是JavaWeb三大组件之一，它与Servlet很相似！但是过滤器是用来拦截请求的，而不是处理请求的。 当用户请求某个Servlet时，会先执行部署在这个请求上的Filter，如果Filter“放行”，那么会继承执行...
JavaWeb之过滤器的应用
MrSuper_cat的博客
08-05 615
过滤器是JavaWeb中比较重要的部分，以下为过滤器的配置以及方法说明 一、创建过滤器 创建过滤器要实现Filter接口，该接口位于javax.servlet包下。以下以字符编码过滤器为实现。 public class EncodingFilter implements Filter 二、过滤器三大方法 1、初始化方法 @Override public void init(FilterConfig filterConfig) throws ServletException { // filterCo
JavaWeb之过滤器Filter(通俗易懂版)
friggly的博客
04-28 2537
JavaWeb三大组件之过滤器Filter的简单使用
JavaWeb之过滤器(filter)
Mu木
02-25 1464
过滤器(filter)简介 过滤器是Javaweb的组件之一，用来过滤请求和处理响应 过滤器实际上就是对web资源进行拦截，做一些处理后再交给下一个过滤器或servlet处理 通常都是用来拦截request进行处理的，也可以对返回的response进行拦截处理 使用场景： 1.设置请求/响应字符编码 2.校验登录权限 3.敏感词汇的过滤 大致流程图如下： filter的使用（xml配置） 1，声明一个过滤器类要实现Filter接口(CusFilter类) public class CusFilter
javaweb之过滤器与监听器
lss0555的博客
10-21 1138
Filter表示过滤器，是JavaWeb三大组件（Servlet、Filter、Listener）之一。过滤器可以把对web资源的请求拦截下来，做一些处理后再交给下一个过滤器或客户端，实现许多特殊功能。过滤器完成相关功能包括：如登录控制，权限管理，过滤敏感词、日志管理等等。
javaweb之过滤器Filter
Lxn2zh的博客
05-08 477
原文链接 [https://zhhll.icu/2021/javaweb/基础/5.过滤器/] 依赖于servlet容器，基于函数回调，可以对请求和响应进行拦截，在访问后端资源之前，拦截这些来自客户端的请求，在发送回客户端之前，处理这些响应
JavaWeb之过滤器 Filter；登录验证过滤器的实现
博客
07-05 2395
概述 起到在 客户端 和 服务器端的资源 中间对 请求和响应 进行处理的作用。 当客户端请求资源的时候，过滤器将这个请求拦截下来，完成一些特殊的功能。 当服务器资源响应的时候，将响应拦截，完成一些特殊的功能，处理后返回给前台。 一般用于完成 通用 的操作，如：登录验证、统一编码处理、敏感字符过滤 使用 需要实现 Filter 接口 配置web.xml 或者使用 @WebFilter() 注解进行配置 @WebFilter("/*") //“/*”表示所有页面都要经过这个过滤器 public class
javaweb中Filter(过滤器)的常见应用
09-03
在Java Web开发中，Filter（过滤器）是一个强大的工具，它可以拦截HTTP请求和响应，对数据进行预处理或后处理，以实现各种功能。本文将深入探讨javaweb中Filter的常见应用，以及如何解决全站字符编码问题。 首先，...
JavaWeb中过滤器的三个小案例
04-04
本文将详细讲解三个使用JavaWeb过滤器的实际案例，帮助开发者深入理解其功能和应用场景。 案例1：分IP统计网站的访问次数 在网站运营中，了解用户访问来源是至关重要的。通过实现一个过滤器，我们可以记录每个IP...
JavaWeb之Filter过滤器详解
08-31
JavaWeb中的Filter过滤器是JavaWeb开发中一个重要的组件，主要用于在请求被处理之前和响应被发送给客户端之前进行拦截和处理。这篇文章将详细介绍Filter的工作原理、使用方式以及一个具体的防盗链功能的实现案例。 ...
myAutoLoginWeb.rar JavaWeb-过滤器Filter学习(三)实现用户的自动登录与IP黑名单过滤
01-09
JavaWeb-过滤器Filter学习(三)实现用户的自动登录与IP黑名单过滤JavaWeb-过滤器Filter学习(三)实现用户的自动登录与IP黑名单过滤JavaWeb-过滤器Filter学习(三)实现用户的自动登录与IP黑名单过滤JavaWeb-过滤器Filter...
javaWeb之过滤器
babyFF9的博客
04-08 341
Fileter介绍  Filter也称之为过滤器，它是Servlet技术中最实用的技术，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能  Servlet API中提供了一个Filter接口，开发...
工厂模式的介绍及实现
户伟伟的博客
09-25 118
工厂模式（Factory Pattern）是一种创建型设计模式，提供了一种创建对象的接口，而无需显式指定对象的具体类。在这种模式中，我们通过定义一个工厂类，专门负责生产各种类型的对象，这样我们可以避免直接在代码中实例化具体类，使代码更具扩展性、灵活性和维护性。解耦：客户端代码与具体的类解耦，避免了对象创建逻辑的重复。简化对象创建：通过工厂统一管理对象的创建逻辑，使代码更清晰易懂。扩展性强：新增类时，只需在工厂中增加创建逻辑，而不必修改现有的业务代码。
Spring Boot 学习和使用
cesske的博客
09-24 1099
Spring Boot是一款开源的Java Web应用框架，旨在简化Spring应用的初始搭建以及开发过程。Spring Boot通过整合Spring技术栈中的诸多关键组件，为开发者提供了一种快速、简便的Spring应用开发方式。它遵循“约定优于配置”的原则，通过自动配置、起步依赖和内置的Servlet容器，极大地简化了传统Spring应用的配置和部署过程。Spring Boot通过其自动化配置、起步依赖、内嵌服务器等特性，极大地简化了Spring应用的开发和部署过程。
基于Hive和Hadoop的哔哩哔哩网站分析系统
最新发布
图南的博客
09-27 444
本项目是一个基于大数据技术的哔哩哔哩平台分析系统，旨在为用户提供全面的哔哩哔哩视频数据和深入的用户行为分析。系统采用 Hadoop 平台进行大规模数据存储和处理，利用 MapReduce 进行数据分析和处理，通过 Sqoop 实现数据的导入导出，以 Spark 为核心进行高效的数据处理。整个系统结合了大数据处理技术，为用户提供精准的内容推荐和深入的用户兴趣分析，帮助平台更好地了解视频趋势和用户需求。
智能BI平台项目
2302_79400545的博客
09-22 239
BI商业智能：数据可视化、报表可视化系统。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值