学习web必学的三大组件之Filter过滤器

写在前面： 今天我来简单的介绍一下Filter过滤器，希望对小白有所帮助。
作者公众号：小白编码
前一篇介绍了： 干货来了！JavaWeb三大组件之Servlet核心技术，附带Http协议【较全整理】

Filter 什么是过滤器

1、Filter 过滤器它是JavaWeb 的三大组件之一。三大组件分别是：Servlet 程序、Listener 监听器、Filter 过滤器
2、Filter 过滤器它是JavaEE 的规范。也就是接口
3、Filter 过滤器它的作用是：拦截请求，过滤响应。

Filter 的基本功能是对 Servlet 容器调用 Servlet 的过程进行拦截，从而在 Servlet 进行响应处理的前后实现一些特殊的功能。

在 Servlet API 中定义了三个接口类来开供开发人员编写 Filter 程序：Filter, FilterChain, FilterConfig

Filter 程序是一个实现了 Filter 接口的 Java 类，与 Servlet 程序相似，它由 Servlet 容器进行调用和执行

Filter 程序需要在 web.xml 文件中进行注册和设置它所能拦截的资源：Filter 程序可以拦截 Jsp, Servlet, 静态图片文件和静态 html 文件

一、Filter简介

Filter也称之为过滤器，它是Servlet技术中最激动人心的技术，WEB开发人员通过Filter技术，对web服务器管理的所有web资源：例如Jsp, Servlet, 静态图片文件或静态 html 文件等进行拦截，从而实现一些特殊的功能。例如实现URL级别的权限访问控制、过滤敏感词汇、压缩响应信息等一些高级功能。
　　Servlet API中提供了一个Filter接口，开发web应用时，如果编写的Java类实现了这个接口，则把这个java类称之为过滤器Filter。通过Filter技术，开发人员可以实现用户在访问某个目标资源之前，对访问的请求和响应进行拦截，如下所示：

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-AC91WFWJ-1589384811933)(C:\Users\JUN\AppData\Roaming\Typora\typora-user-images\image-20200510102654044.png)]$

拦截请求常见的应用场景有：
1、权限检查
2、日记操作
3、事务管理
……等等

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-X9yw9D2Y-1589384811936)(C:\Users\JUN\AppData\Roaming\Typora\typora-user-images\image-20200513115314876.png)]$

Filter使用

FilterChain接口：代表当前 Filter 链的对象。由容器实现，容器将其实例作为参数传入过滤器对象的doFilter()方法中。过滤器对象使用FilterChain 对象调用过滤器链中的下一个过滤器，如果该过滤器是链中最后一个过滤器，那么将调用目标资源。

doFilter(ServletRequest request,ServletResponse response)throws java.io.IOException：调用该方法将使过滤器链中的下一个过滤器被调用。如果是最后一个过滤器，会调用目标资源。

FilterConfig接口

javax.servlet.FilterConfig接口：该接口类似于ServletConfig接口，由容器实现。**Servlet ** 规范将代表 ServletContext 对象和 Filter **的配置参数信息都封装在该对象中。**Servlet 容器将其作为参数传入过滤器对象的init()方法中。

String getFilterName()：得到描述符中指定的过滤器的名字。

String getInitParameter(String name)： 返回在部署描述中指定的名字为name的初始化参数的值。如果不存在返回null.

Enumeration getInitParameterNames()：返回过滤器的所有初始化参数的名字的枚举集合。

public ServletContext getServletContext()：返回Servlet上下文对象的引用。

Filter原理：

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-viIlafBz-1589384811937)(C:\Users\JUN\AppData\Roaming\Typora\typora-user-images\image-20200508175403215.png)]$

Filter 过滤器的使用步骤：

1、编写一个类去实现Filter 接口
2、实现过滤方法doFilter()
3、到web.xml 中去配置Filter 的拦截路径

练习：Filter登陆过滤：

要求： 在这个页面，点跳转到一个页面中，实现需要登陆成功后才能够跳转

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-TLnHCinx-1589384811939)(C:\Users\JUN\AppData\Roaming\Typora\typora-user-images\image-20200513232251222.png)]$

需要登陆才能跳转这个页面

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-WWYoIS02-1589384811940)(C:\Users\JUN\AppData\Roaming\Typora\typora-user-images\image-20200513232339582.png)]$

思路： 在登陆的时候，向Session域中设置一个user对象，通过判断Session中的user来确定用户是否登陆。

index.jsp ：

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
  <head>
    <title>$Title$</title>
  </head>
  <base href="http://localhost:8080/filter/">
  <body>
  <form action="http://localhost:8080/filter/loginServlet" method="get">
    用户名：<input type="text" name="username"/> <br>
    密码：<input type="password" name="password"/> <br>
    <input type="submit" />
  </form><br/>
  <a href="success.html">跳转一个页面</a>
  </body>
</html>

LoginServlet:

public class LoginServlet extends HttpServlet {
    
    @Override
    protected void doGet(HttpServletRequest req, HttpServletResponse resp) throws ServletException, IOException {

        //响应乱码，设置编码集
        resp.setContentType("text/html; charset=UTF-8");

        String username = req.getParameter("username");
        String password = req.getParameter("password");
        if ("admin".equals(username) && "admin".equals(password)) {
            //向session域中放入user对象，用于dofilter判断
            req.getSession().setAttribute("user", username);
            resp.getWriter().write("登录成功！！！");
        } else {
            req.getRequestDispatcher("/index.jsp").forward(req, resp);
        }
    }
}

LoginFilter：

public class LoginFilter implements Filter {

    @Override
    public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {

        HttpServletRequest req = (HttpServletRequest) servletRequest;
		//获取session中的user
        Object user = req.getSession().getAttribute("user");

        if (user == null) {
            //如果没有登陆
            //请求转发回登陆页面
            req.getRequestDispatcher("index.jsp").forward(servletRequest, servletResponse);
        } else {
            //放行
            filterChain.doFilter(servletRequest, servletResponse);

        }
}

success.Html：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>这是登陆后才能访问的页面</h1><br/>
<a href="index.jsp">回到登陆页面</a>
</body>
</html>

XML:

  <servlet>
        <servlet-name>LoginServlet</servlet-name>
        <servlet-class>cn.codewhite.filter.LoginServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>LoginServlet</servlet-name>
        <url-pattern>/loginServlet</url-pattern>
    </servlet-mapping>

   
    <!--filter 标签用于配置一个Filter 过滤器-->
    <filter>
        <!--给filter 起一个别名-->
        <filter-name>LoginFilter</filter-name>
        <!--配置filter 的全类名-->
        <filter-class>cn.codewhite.filter.LoginFilter</filter-class>
    </filter>
    <!--filter-mapping 配置Filter 过滤器的拦截路径-->
    <filter-mapping>
        <!--filter-name 表示当前的拦截路径给哪个filter 使用-->
        <filter-name>LoginFilter</filter-name>
        <!--url-pattern 配置拦截路径
       / 表示请求地址为：http://ip:port/工程路径/ 映射到IDEA 的web 目录
       /success.html 表示请求地址为：http://ip:port/工程路径/success.html
       -->
        <url-pattern>/success.html</url-pattern>
    </filter-mapping>

测试结果：

此时，我并没有登陆，点击跳转一个页面，地址栏发生改变了，大门但是并没有跳转到success.html页面，

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-FAlL1I6r-1589384811942)(C:\Users\JUN\AppData\Roaming\Typora\typora-user-images\image-20200513234107606.png)]$

我们来看看Debug，是因为给我的Filter过滤器拦截了，user是null，请求转发回登陆页面了

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-HcI7F8Y2-1589384811943)(C:\Users\JUN\AppData\Roaming\Typora\typora-user-images\image-20200513234057850.png)]$

当我登陆后：向Session域中设置了一个user对象，此时登陆成功：

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-R21iVoqQ-1589384811944)(C:\Users\JUN\AppData\Roaming\Typora\typora-user-images\image-20200513234401221.png)]$

Debug中可以看出，我在登陆成功的时候，向Session域中放入了user对象

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-609wTc23-1589384811944)(C:\Users\JUN\AppData\Roaming\Typora\typora-user-images\image-20200513234312671.png)]$

所以再次返回首页，我再次点击跳转页面：

此时Debug中,发现Filter检测到了Session中有一个user对象，并且通过dofiler放行了页面。所以我们能够进入success.html页面

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-05N9fngj-1589384811945)(C:\Users\JUN\AppData\Roaming\Typora\typora-user-images\image-20200513234520616.png)]$

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-F0jXVPTb-1589384811946)(C:\Users\JUN\AppData\Roaming\Typora\typora-user-images\image-20200513234621590.png)]$

Filter 的生命周期

Filter 的生命周期包含几个方法:
1、构造器方法
2、init 初始化方法
第1，2 步，在web 工程启动的时候执行（Filter 已经创建）
3、doFilter 过滤方法
第3 步，每次拦截到请求，就会执行
4、destroy 销毁
第4 步，停止web 工程的时候，就会执行（停止web 工程，也会销毁 Filter 过滤器）

FilterConfig 类

FilterConfig 类见名知义，它是Filter 过滤器的配置文件类。
Tomcat 每次创建Filter 的时候，也会同时创建一个FilterConfig 类，这里包含了Filter 配置文件的配置信息。

FilterConfig 类的作用是获取filter 过滤器的配置内容
1、获取Filter 的名称filter-name 的内容
2、获取在Filter 中配置的init-param 初始化参数
3、获取ServletContext 对象

@Override
public void init(FilterConfig filterConfig) throws ServletException {
    System.out.println("2.Filter 的init(FilterConfig filterConfig)初始化");
    // 1、获取Filter 的名称filter-name 的内容
    System.out.println("filter-name 的值是：" + filterConfig.getFilterName());
    // 2、获取在web.xml 中配置的init-param 初始化参数
    System.out.println("初始化参数username 的值是：" + filterConfig.getInitParameter("username"));
    System.out.println("初始化参数url 的值是：" + filterConfig.getInitParameter("url"));
    // 3、获取ServletContext 对象
    System.out.println(filterConfig.getServletContext());
}

xml:

<!--filter 标签用于配置一个Filter 过滤器-->
<filter>
<!--给filter 起一个别名-->
<filter-name>AdminFilter</filter-name>
<!--配置filter 的全类名-->
<filter-class>com.atguigu.filter.AdminFilter</filter-class>
<init-param>
<param-name>username</param-name>
<param-value>root</param-value>
</init-param>
<init-param>
<param-name>url</param-name>
<param-value>jdbc:mysql://localhost3306/test</param-value>
</init-param>
</filter>

FilterChain 过滤器链

Filter 过滤器
Chain 链，链条
FilterChain 就是过滤器链（多个过滤器如何一起工作）

$[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-cXM2hg4m-1589384811946)(C:\Users\JUN\AppData\Roaming\Typora\typora-user-images\image-20200508180049851.png)]$

Filter 的拦截路径：

–精确匹配

<url-pattern>/target.jsp</url-pattern>

以上配置的路径，表示请求地址必须为：http://ip:port/工程路径/target.jsp

–目录匹配

<url-pattern>/admin/* </url-pattern>

以上配置的路径，表示请求地址必须为：http://ip:port/工程路径/admin/*

–后缀名匹配

<url-pattern> * .html</url-pattern>

以上配置的路径，表示请求地址必须以.html 结尾才会拦截到

<url-pattern>* .do</url-pattern>

以上配置的路径，表示请求地址必须以.do 结尾才会拦截到

<url-pattern>*.action</url-pattern>

以上配置的路径，表示请求地址必须以.action 结尾才会拦截到
Filter 过滤器它只关心请求的地址是否匹配，不关心请求的资源是否存在！！！

写在后边：

以上就是JavaWeb三大组件之Filter的简单介绍内容。若有问题可以私聊我。

学习web必学的三大组件之Filter过滤器

目录

Filter 什么是过滤器

一、Filter简介

Filter使用

Filter原理：

Filter 过滤器的使用步骤：

练习：Filter登陆过滤：

Filter 的生命周期

FilterChain 过滤器链

写在后边：

SQL优化-20231016

最流行的JSON介紹與同JS轉化和Java轉化的方式 -JavaWeb篇

都路過了，那麼進來學學Servlet處理請求的技術吧

SSM整合權限框架的管理系統

Spring事務管理，帶你回顧數據庫事務！

保姆級教學！Linux操作3天快速入門系列第二天【篇二】（整合常用命令）

https://yachay.unat.edu.pe/blog/index.php?comment_area=format_blog&comment_component=blog&comment_co

linux以太網驅動總結