【JavaWeb】过滤器 Filter

最新推荐文章于 2024-06-16 22:53:28 发布
最新推荐文章于 2024-06-16 22:53:28 发布
阅读量1.4k 收藏 26
点赞数 19
分类专栏： 后端 # JavaWeb 文章标签： java web 学习 笔记
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/GavinGroves/article/details/135834426
版权

文章目录

过滤器是什么？

  • Filter ，即 过滤器 ，是JAVAEE技术规范之一,
  • 作用目标资源的请求进行过滤的一套技术规范
  • 是Java Web项目中最为实用的技术之一

客户端发送请求 先经过filter的doFilter方法，这个方法控制是否放行请求到达目标，
不放行 即 使用filter的方式返回响应给客户端；
放行之后 请求即正常到达目标servlet
放行后 还可以对 响应数据进行处理

一、过滤器概述

  • Filter接口定义了过滤器的开发规范,所有的过滤器都要实现该接口

  • Filter的工作位置是项目中所有目标资源之前,容器在创建HttpServletRequest和HttpServletResponse对象后,会先调用Filter的doFilter方法

  • Filter的doFilter方法可以控制请求是否继续,

    • 如果放行,则请求继续,
    • 如果拒绝,则请求到此为止,由过滤器本身做出响应

  • Filter不仅可以对请求做出过滤,也可以在目标资源做出响应前,对响应再次进行处理

  • Filter是GOF中责任链模式的典型案例

  • Filter的常用应用包括但不限于: 登录权限检查,解决网站乱码,过滤敏感字符,日志记录,性能分析… …

二、过滤器工作位置图解

1

三、Filter接口API

  • 源码
package jakarta.servlet;

import java.io.IOException;

public interface Filter {
    default void init(FilterConfig filterConfig) throws ServletException {
    }

    void doFilter(ServletRequest var1, ServletResponse var2, FilterChain var3) throws IOException, ServletException;

    default void destroy() {
    }
}
  • API
API目标
default public void init(FilterConfig filterConfig)初始化方法,由容器调用并传入初始配置信息filterConfig对象
public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain)过滤方法,核心方法,过滤请求,决定是否放行,响应之前的其他处理等都在该方法中
default public void destroy()销毁方法,容器在回收过滤器对象之前调用的方法

四、过滤器使用

  1. 创建类 实现Filter接口
  2. 重写doFilter方法
  3. 可选择调用放行方法 将请求传下去 ：
    3.1. filterChain.doFilter(servletRequest, servletResponse);
    3.2. 不写此方法 就是不放行请求到目标资源 卡这了

目标：开发一个日志记录过滤器

  • 用户请求到达目标资源之前,记录用户的请求资源路径
  • 响应之前记录本次请求目标资源运算的耗时
  • 可以选择将日志记录进入文件,为了方便测试,这里将日志直接在控制台打印

4.1 定义一个过滤器类,编写功能代码：

package com.doug.filters;

import jakarta.servlet.*;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;

import java.io.IOException;
import java.text.SimpleDateFormat;
import java.util.Date;

/**
 * @Description:
 */
public class LoggingFilter implements Filter {
    private SimpleDateFormat dateFormat = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        //父类转子类 能够使用子类独有的方法
        HttpServletRequest req = (HttpServletRequest) servletRequest;
        HttpServletResponse resp = (HttpServletResponse) servletResponse;

        //拼接日志
        String requestURI = req.getRequestURI();
        String time = dateFormat.format(new Date());
        String beforeLogging = requestURI + "在" + time + "被请求了";
        // 打印日志
        System.out.println(beforeLogging);

        // 获取系统时间
        long t1 = System.currentTimeMillis();
        //放行请求
        filterChain.doFilter(servletRequest, servletResponse);
        // 获取系统时间
        long t2 = System.currentTimeMillis();

        //  拼接日志文本
        String afterLogging = requestURI + "在" + time + "的请求耗时:" + (t2 - t1) + "毫秒";
        // 打印日志
        System.out.println(afterLogging);

    }
}

说明

  • doFilter方法中的请求和响应对象是以父接口的形式声明的,实际传入的实参就是HttpServletRequest和HttpServletResponse子接口级别的,可以安全强转
  • filterChain.doFilter(request,response); 这行代码的功能是放行请求,如果没有这一行代码,则请求到此为止
  • filterChain.doFilter(request,response);在放行时需要传入request和response,意味着请求和响应对象要继续传递给后续的资源,这里没有产生新的request和response对象

4.2 xml配置：

    <!--配置filter,并为filter起别名-->
    <filter>
        <filter-name>loggingFilter</filter-name>
        <filter-class>com.doug.filters.LoggingFilter</filter-class>
    </filter>
    
    <!--为别名对应的filter配置要过滤的目标资源-->
    <filter-mapping>
        <filter-name>loggingFilter</filter-name>
        
		<!--  可以用获取servlet别名的方式      -->
        <servlet-name>sg1</servlet-name>
        
		<!--  或者 使用获取servletG 路径的方式      -->
     <url-pattern>/servletG</url-pattern>
     
	 <!-- 或者 通过后缀名确定过滤资源-->
        <url-pattern>*.html</url-pattern>
    </filter-mapping>

说明：

  • filter-mapping标签中定义了过滤器对那些资源进行过滤
  • 子标签url-pattern通过映射路径确定过滤范围
    • /servletA 精确匹配,表示对servletA资源的请求进行过滤
    • *.html表示对以.action结尾的路径进行过滤
    • /* 表示对所有资源进行过滤
    • 一个filter-mapping下可以配置多个url-pattern
  • 子标签servlet-name通过servlet别名确定对那些servlet进行过滤
    • 使用该标签确定目标资源的前提是servlet已经起了别名
    • 一个filter-mapping下可以定义多个servlet-name
    • 一个filter-mapping下,servlet-name和url-pattern子标签可以同时存在

4.3 定义 servletG 目标资源 模拟测试 :

@WebServlet(value = "/servletG",name = "sg1")
public class ServletG extends HttpServlet {
    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        resp.setContentType("text/html;charset=UTF-8");
        resp.getWriter().write("servletG处理请求的方法,耗时10毫秒");
        System.out.println("servletG处理请求的方法,耗时10毫秒");
        try {
            Thread.sleep(10);
        } catch (InterruptedException e) {
            throw new RuntimeException(e);
        }
    }
}

结果

4.4 过滤图解

在这里插入图片描述

五、过滤器生命周期

过滤器作为web项目的组件之一,和Servlet的生命周期类似,
略有不同,没有servlet的load-on-startup的配置,
默认就是系统启动立刻构造

阶段对应方法执行时机执行次数
创建对象构造器web应用启动时1
初始化方法void init(FilterConfig filterConfig)构造完毕1
过滤请求void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)每次请求多次
销毁default void destroy()web应用关闭时1次

六、过滤器链的使用

一个web项目中,可以同时定义多个过滤器,
多个过滤器对同一个资源进行过滤时,工作位置有先后,整体形成一个工作链,
称之为过滤器链

  • 过滤器链中的过滤器的顺序由filter-mapping顺序决定
  • 每个过滤器过滤的范围不同,针对同一个资源来说,过滤器链中的过滤器个数可能是不同的
  • 如果某个Filter是使用ServletName进行匹配规则的配置，那么这个Filter执行的优先级要更低

6.1 图解过滤链

1

6.2 测试过滤链

  1. 定义servlet
@WebServlet("/servletH")
public class ServletH extends HttpServlet {
    @Override
    protected void service(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {
        System.out.println("servletH service method  invoked");
    }
}
  1. 创建多个Filter
    三个过滤器代码
public class Filter1  implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filter1 before chain.doFilter code invoked");

        filterChain.doFilter(servletRequest,servletResponse);

        System.out.println("filter1 after  chain.doFilter code invoked");

    }
}


public class Filter2 implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filter2 before chain.doFilter code invoked");

        filterChain.doFilter(servletRequest,servletResponse);

        System.out.println("filter2 after  chain.doFilter code invoked");

    }
}


public class Filter3 implements Filter {
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        System.out.println("filter3 before chain.doFilter code invoked");

        filterChain.doFilter(servletRequest,servletResponse);

        System.out.println("filter3 after  chain.doFilter code invoked");

    }
}
  1. xml 定义多个filtermapping 标签
   <filter>
        <filter-name>filter1</filter-name>
        <filter-class>com.doug.filters.Filter1</filter-class>
    </filter>

    <filter>
        <filter-name>filter2</filter-name>
        <filter-class>com.doug.filters.Filter2</filter-class>
    </filter>

    <filter>
        <filter-name>filter3</filter-name>
        <filter-class>com.doug.filters.Filter3</filter-class>
    </filter>

    <!--filter-mapping的顺序决定了过滤器的工作顺序-->
    <filter-mapping>
        <filter-name>filter1</filter-name>
        <url-pattern>/servletH</url-pattern>
    </filter-mapping>

    <filter-mapping>
        <filter-name>filter2</filter-name>
        <url-pattern>/servletH</url-pattern>
    </filter-mapping>

    <filter-mapping>
        <filter-name>filter3</filter-name>
        <url-pattern>/servletH</url-pattern>
    </filter-mapping>

流程

6.3 工作流程图解

2

七、注解方式配置过滤器

1

7.1 一个比较完整的Filter的XML配置

<!--配置filter,并为filter起别名-->
<filter>
    <filter-name>loggingFilter</filter-name>
    <filter-class>com.doug.filters.LoggingFilter</filter-class>
    <!--配置filter的初始参数-->
    <init-param>
        <param-name>dateTimePattern</param-name>
        <param-value>yyyy-MM-dd HH:mm:ss</param-value>
    </init-param>
</filter>
<!--为别名对应的filter配置要过滤的目标资源-->
<filter-mapping>
    <filter-name>loggingFilter</filter-name>
    <!--通过映射路径确定过滤资源-->
    <url-pattern>/servletA</url-pattern>
    <!--通过后缀名确定过滤资源-->
    <url-pattern>*.html</url-pattern>
    <!--通过servlet别名确定过滤资源-->
    <servlet-name>servletBName</servlet-name>
</filter-mapping>

7.2 将xml配置转换成注解方式实现

@WebFilter(
        filterName = "loggingFilter",
        initParams = {@WebInitParam(name="dateTimePattern",value="yyyy-MM-dd HH:mm:ss")},
        urlPatterns = {"/servletA","*.html"},
        servletNames = {"servletBName"}
)
public class LoggingFilter  implements Filter {
    private SimpleDateFormat dateFormat ;

    /*init初始化方法,通过filterConfig获取初始化参数
    * init方法中,可以用于定义一些其他初始化功能代码
    * */
    @Override
    public void init(FilterConfig filterConfig) throws ServletException {
        // 获取初始参数
        String dateTimePattern = filterConfig.getInitParameter("dateTimePattern");
        // 初始化成员变量
        dateFormat=new SimpleDateFormat(dateTimePattern);
    }
    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {
        // 参数父转子
        HttpServletRequest request =(HttpServletRequest)  servletRequest;
        HttpServletResponse  response =(HttpServletResponse)  servletResponse;
        // 拼接日志文本
        String requestURI = request.getRequestURI();
        String time = dateFormat.format(new Date());
        String beforeLogging =requestURI+"在"+time+"被请求了";
        // 打印日志
        System.out.println(beforeLogging);
        // 获取系统时间
        long t1 = System.currentTimeMillis();
        // 放行请求
        filterChain.doFilter(request,response);
        // 获取系统时间
        long t2 = System.currentTimeMillis();
        String afterLogging =requestURI+"在"+time+"的请求耗时:"+(t2-t1)+"毫秒";
        // 打印日志
        System.out.println(afterLogging);

    }
}

总结

过滤器开发中应用的场景 :

  • 日志的记录
  • 性能的分析
  • 乱码的处理
  • 事务的控制
  • 登录的控制
  • 跨域的处理
  • … …

关于tomcat 10 在xml 配置 过滤器 导包是 jakarta 不是 'javax 会报红
但是可以正常使用…
1
1
不想爆红：

  1. 就降低 tomcat版本 为tomcat9
    主要是servlet-api 版本问题

  2. 添加依赖也可以
    因为以上没有使用maven 所以没有pom.xml添加依赖

加文格罗夫斯
关注
  • 19
    点赞
  • 踩
  • 26
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
Java体系知识之过滤器Filter
qq_45464872的博客
12-02 740
Java体系知识之过滤器Filter 1 技术简介 2 过滤器使用步骤（重点） 2.1 使用步骤 2.2 案例 3 过滤器执行过程（重点） 3.1 内容概述 3.2 案例 4 过滤器生命周期 4.1
javaweb中Filter(过滤器)的常见应用
09-03
在Java Web开发中，Filter（过滤器）是一个强大的工具，它可以拦截HTTP请求和响应，对数据进行预处理或后处理，以实现各种功能。本文将深入探讨javaweb中Filter的常见应用，以及如何解决全站字符编码问题。 首先，...
java过滤器（Filter）
热门推荐
爪哇人的博客
10-19 3万+
filter也称之为过滤器，它是javaWeb三大组件之一（Servlet程序、Listener监听器、Filter过滤器）既可以对请求进行拦截，也可以对响应进行处理。权限检查，日记操作、拦截请求、过滤操作、对请求字符设置编码。要想介绍filter，就必须介绍Filter中的三个方法。/*** web应用启动时，web服务器将创建Filter的实例对象，并调用init方法，读取web.xml的配置，完成对象的初始化功能，
Java中的Filter（过滤器）解析
最新发布
m0_67989094的博客
06-16 647
filter也称之为过滤器，它是javaWeb三大组件之一（Servlet程序、Listener监听器、Filter过滤器）既可以对请求进行拦截，也可以对响应进行处理。权限检查，日记操作、拦截请求、过滤操作、对请求字符设置编码。要想介绍filter，就必须介绍Filter中的三个方法。/*** web应用启动时，web服务器将创建Filter的实例对象，并调用init方法，读取web.xml的配置，完成对象的初始化功能，
JavaWeb学习篇之----Servlet过滤器Filter和监听器
weixin_30485291的博客
04-10 153
首先来看一下Servlet的过滤器内容: 一、Servlet过滤器的概念： *************************************************************************************** Servlet过滤器是在Java Servlet规范2.3中定义的，它能够对Servlet容器的请求和响应对象进行检查和修改。...
[Java]过滤器（Filter）
m0_71229255的博客
04-19 9929
当浏览器发送请求给服务器的时候，先执行过滤器，然后才访问Web的资源。服务器响应Response，从Web资源抵达浏览器之前，也会途径过滤器。 过滤器的用途：过滤一些敏感的字符串【规定不能出现敏感字符串】、避免中文乱码【规定Web资源都使用UTF-8编码】、权限验证【规定只有带Session或Cookie的浏览器，才能访问web资源】等等等。
Java中的过滤器Filter
m0_68988603的博客
05-07 1万+
一：Filter简介 二：关于Filter （一）如何使用Filter进行过滤 （二）过滤器链 (FilterChain) （三）Filter的配置 1.通过web.xml文件配置 2.通过注解配置 （四）Filter的生命周期 （五）中文乱码过滤器 三：测试案例 1.单个过滤器 2.多个过滤器
Java Web之过滤器（Filter）
Garry
10-12 1219
过滤器(Filter) 过滤器实际上就是对web资源进行拦截，做一些处理后再交给下一个过滤器或servlet处理 通常都是用来拦截request进行处理的，也可以对返回的response进行拦截处理 大概流程图如下 应用场景 自动登录 统一设置编码格式 访问权限控制 敏感字符过滤等 创建Filter 在Servl...
JavaWeb Servlet中Filter过滤器的详解
01-08
JavaWeb Servlet中Filter过滤器的详解 1.简述  Filter过滤器,对web服务器所有web资源进行过滤，从而实现一些特殊的功能(权限访问控制、过滤敏感词汇、压缩响应信息)。Filter能够对Servlet容器的请求和响应进行检查...
JavaWeb之Filter过滤器详解
08-31
JavaWeb中的Filter过滤器是JavaWeb开发中一个重要的组件，主要用于在请求被处理之前和响应被发送给客户端之前进行拦截和处理。这篇文章将详细介绍Filter的工作原理、使用方式以及一个具体的防盗链功能的实现案例。 ...
Javaweb过滤器.zip
12-31
JavaWeb过滤器（Filter）是Servlet规范的一部分，它允许开发者在请求到达目标资源（如Servlet、JSP页面）之前对其进行预处理，或者在响应返回给客户端之后进行后处理。过滤器可以用来实现统一的功能，如登录检查、...
java 过滤器 filter
06-11
如果访问的路径中截取的内容和filter-mapping中的url-pattern相同,就会拦截用户的请求,然后到对应的filter类中,自动调用doFilter方法. 拦截之后的处理都有该法决定. (与servlet的区别: 调用doPost/doGet) .
javaweb过滤器
11-15
### JavaWeb过滤器详解 #### 过滤器概述 在JavaWeb开发中，过滤器扮演着极其重要的角色，它能够实现在请求到达目标资源（如Servlet或JSP页面）之前或者响应返回客户端之前的拦截功能。这类似于现实生活中大厦里的...
JavaWeb的Filter过滤器应用
午-夜
07-25 1428
过滤器应用案例 分ip统计网站的访问次数 ip count 192.168.1.111 2 192.168.1.112 59   统计工作需要在所有资源执行前，那么就可以放到Filter中了。 我们这个过滤器不打算做拦截操作！因为我们只是用来做统计的。 用什么东西来装载统计的数据。Map
Java之过滤器Filter
weixin_43790613的博客
02-04 4252
文章目录介绍实现利用过滤器解决的实际问题请求乱码处理非法请求拦截 介绍 过滤器是一种对象，它对资源的请求(servlet或静态内容)或来自资源的响应执行过滤任务，或者两者都执行，在一个web应用中，可以开发编写多个Filter，这些Filter组合起来组合成一个Filter链。若是一个过滤器链，先配置先执行，执行顺序是根据类名的的排序（请求时的执行顺序），响应时以相反的顺序执行， 过滤器在doFilter方法中执行过滤。 每个Filter都可以访问一个FilterConfig对象，它可以从中获取它的初始化参
JavaWeb-Filter
起舞的日子
10-07 488
话说： Filter
JavaWeb-过滤器Filter学习(一)Filter知识点
weixin_34097242的博客
08-18 144
Filter简介 　Filter也称之为过滤器，它是Servlet技术中最激动人心的技术，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息、自动登录等...
JAVA过滤器-Filter
杉 言
06-09 304
 1.怎么样创建一个JAVA的Filter(过滤器)，下面就来介绍一下Filter的创建及用途。  过滤器Filter,在servlet之前或之后对servlet中的request和response进行处理  Filter有一个FilterChain的概念，FilterChain包括多个Filter  客户端请求request在抵达servlet之前会经过FilterChain里面所有的Filte...
Java_Filter
幸遇三杯酒好，况逢一朵花新
05-24 306
文章目录前言叙述宝图 是什么？过滤过程怎么做？方法 init方法 doFilter方法 destroy方法结语 前言   最近学习了有关Filter的内容，小咸儿将在此总结下来，分享给大家。有什么不足之处，还希望各位能够在评论区中留言，一起讨论。 叙述 宝图 是什么？   Filter的基本功能是对Servlet容器调用Servlet的过程进行拦截，从而在Servlet进行响应处理的前后实现...
JavaWeb过滤器Filter详解与实战入门
"本文档是关于Java Web中的过滤器（Filter）技术的介绍，适合初学者学习。内容包括Filter的基本概念、工作原理以及简单的开发入门示例。" 在Web开发中，Filter，即过滤器，是一项重要的技术，它允许开发者对HTTP...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

加文格罗夫斯

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值