JavaWeb：过滤器与监听器

痛定思痛。 2024-03-27 11:48 104阅读 0赞

### 一、过滤器`Filter` ###

#### 1.1 过滤器`Filter`概述 ####

`Filter`表示过滤器，是`JavaWeb`三大组件（`Servlet`、`Filter`、`Listener`）之一。`Servlet`我们之前都已经介绍过了，`Filter`和`Listener`我们今天都会进行介绍。

过滤器可以把对资源的请求 拦截 下来，从而实现一些特殊的功能。

如下图所示，浏览器可以访问服务器上的所有的资源（`servlet`、`jsp`、`html`等）

![在这里插入图片描述][41c9e6b5002c4223ab4912c68a887cd2.png_pic_center]

而在访问到这些资源之前可以使过滤器拦截来下，也就是说在访问资源之前会先经过`Filter`，如下图

![在这里插入图片描述][f774087a13cb49f0be32f9e100cccc32.png_pic_center]

拦截器拦截到后可以做什么功能呢？

过滤器一般完成一些通用的操作。 比如每个资源都要写一些代码完成某个功能，我们总不能在每个资源中写这样的代码吧，而此时我们可以将这些代码写在过滤器中，因为请求每一个资源都要经过过滤器。

我们之前做的品牌数据管理的案例中就已经做了登陆的功能，而如果我们不登录能不能访问到数据呢？我们可以在浏览器直接访问首页 ，可以看到 `查询所有` 的超链接

![在这里插入图片描述][5e09deebea914a70b7613bf39d090802.png_pic_center]

当我点击该按钮，居然可以看到品牌的数据

![在这里插入图片描述][d55d55990247407a8b25792aafcf7c6c.png_pic_center]

这显然和我们的要求不符。我们希望实现的效果是用户如果登陆过了就跳转到品牌数据展示的页面；如果没有登陆就跳转到登陆页面让用户进行登陆，要实现这个效果需要在每一个资源中都写上这段逻辑，而像这种通用的操作，我们就可以放在过滤器中进行实现。这个就是 权限控制 ，以后我们还会进行细粒度权限控制。过滤器还可以做 `统一编码处理`、 `敏感字符处理` 等等…

#### 1.2 `Filter`快速入门 ####

##### 1.2.1 开发步骤 #####

进行 `Filter` 开发分成以下三步实现

*  定义类，实现`Filter`接口，并重写其所有方法![在这里插入图片描述][56bdc2dcb1f24b34906742575ec6eec9.png_pic_center]
 *  配置`Filter`拦截资源的路径：在类上定义 `@WebFilter` 注解。而注解的 `value` 属性值 `/*` 表示拦截所有的资源![在这里插入图片描述][4bd89e38b93f4f3b827056cdb1e97ace.png_pic_center]
 *  在`doFilter`方法中输出一句话，并放行![在这里插入图片描述][738ef754404541768f406c09d92e7725.png_pic_center]
    
    > 上述代码中的 `chain.doFilter(request,response);` 就是放行，也就是让其访问本该访问的资源。

##### 1.2.2 代码演示 #####

创建一个项目，项目下有一个 `hello.jsp` 页面，项目结构如下：![在这里插入图片描述][bba8313f10014ee89e79460300a85269.png_pic_center]

`pom.xml` 配置文件内容如下：

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <groupId>com.dcxuexi</groupId>
      <artifactId>filter-demo</artifactId>
      <packaging>war</packaging>
      <version>1.0-SNAPSHOT</version>
    
      <properties>
        <maven.compiler.source>17</maven.compiler.source>
        <maven.compiler.target>17</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
      </properties>
    
      <dependencies>
        <dependency>
          <groupId>javax.servlet</groupId>
          <artifactId>javax.servlet-api</artifactId>
          <version>3.1.0</version>
          <scope>provided</scope>
        </dependency>
        <dependency>
          <groupId>junit</groupId>
          <artifactId>junit</artifactId>
          <version>3.8.1</version>
          <scope>test</scope>
        </dependency>
      </dependencies>
    </project>

`hello.jsp` 页面内容如下：

<%--
      Created by IntelliJ IDEA.
      User: DongChuang
      Date: 2023/2/2
      Time: 20:30
      To change this template use File | Settings | File Templates.
    --%>
    <%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
        <title>hello</title>
    </head>
    <body>
        <h1>hello JSP~</h1>
    </body>
    </html>

我们现在在浏览器输入 `http://localhost/filter-demo/hello.jsp` 访问 `hello.jsp` 页面，这里是可以访问到 `hello.jsp` 页面内容的。![在这里插入图片描述][46418a38547144599cc873c8ddfac24f.png_pic_center]

接下来编写过滤器。过滤器是`Web`三大组件之一，所以我们将 `filter` 创建在 `com.itheima.web.filter` 包下，起名为 `FilterDemo`

package com.dcxuexi.web.filter;
    
    import javax.servlet.*;
    import javax.servlet.annotation.WebFilter;
    import java.io.IOException;
    
    /***
     * @Title FilterDemo
     * @Description TOTD
     * @Auter DongChuang
     * @Date 2023/2/2 20:28
     * @Version 1.0.0
     */
    @WebFilter("/*")
    public class FilterDemo implements Filter {
        
        @Override
        public void init(FilterConfig filterConfig) throws ServletException {
        
    
        }
    
        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        
            System.out.println("FilterDemo  被执行了，，，");
        }
    
        @Override
        public void destroy() {
        
    
        }
    }

重启启动服务器，再次重新访问 `hello.jsp` 页面，这次发现页面没有任何效果，但是在 `idea` 的控制台可以看到如下内容![在这里插入图片描述][6838bb8e28eb46728b76d2e581e6e443.png_pic_center]

上述效果说明 `FilterDemo` 这个过滤器的 `doFilter()` 方法执行了，但是为什么在浏览器上看不到 `hello.jsp` 页面的内容呢？这是因为在 `doFilter()` 方法中添加放行的方法才能访问到 `hello.jsp` 页面。那就在 `doFilter()` 方法中添加放行的代码

//放行
     chain.doFilter(request,response);

再次重启服务器并访问 `hello.jsp` 页面，发现这次就可以在浏览器上看到页面效果。

**`FilterDemo` 过滤器完整代码如下：**

package com.dcxuexi.web.filter;
    
    import javax.servlet.*;
    import javax.servlet.annotation.WebFilter;
    import java.io.IOException;
    
    /***
     * @Title FilterDemo
     * @Description TOTD
     * @Auter DongChuang
     * @Date 2023/2/2 20:28
     * @Version 1.0.0
     */
    @WebFilter("/*")
    public class FilterDemo implements Filter {
        
        @Override
        public void init(FilterConfig filterConfig) throws ServletException {
        
    
        }
    
        @Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        
            System.out.println("FilterDemo  被执行了，，，");
            //放行
            chain.doFilter(request,response);
        }
    
        @Override
        public void destroy() {
        
    
        }
    }

#### 1.3 `Filter`执行流程 ####

![在这里插入图片描述][bbd8fa8b8dd84711b3a1bd246c17db8f.png_pic_center]

如上图是使用过滤器的流程，我们通过以下问题来研究过滤器的执行流程：

*  放行后访问对应资源，资源访问完成后，还会回到`Filter`中吗？
    
    从上图就可以看出肯定 会 回到`Filter`中
 *  如果回到`Filter`中，是重头执行还是执行放行后的逻辑呢？
    
    如果是重头执行的话，就意味着 `放行前逻辑` 会被执行两次，肯定不会这样设计了；所以访问完资源后，会回到 `放行后逻辑`，执行该部分代码。

通过上述的说明，我们就可以总结`Filter`的执行流程如下：![在这里插入图片描述][60f346681e9145198c4669291fa12a8a.png_pic_center]

接下来我们通过代码验证一下，在 `doFilter()` 方法前后都加上输出语句，如下

@Override
        public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
        
            System.out.println("FilterDemo  被执行了，，，");
            //1. 放行前，对 request数据进行处理
            System.out.println("1.FilterDemo...");
            //放行
            chain.doFilter(request,response);
    
            //2. 放行后，对Response 数据进行处理
            System.out.println("3.FilterDemo...");
        }

同时在 `hello.jsp` 页面加上输出语句，如下

执行访问该资源打印的顺序是按照我们标记的标号进行打印的话，说明我们上边总结出来的流程是没有问题的。启动服务器访问 `hello.jsp` 页面，在控制台打印的内容如下：

![在这里插入图片描述][599a5f9b93144f68b4882ea90ca80052.png_pic_center]

以后我们可以将对请求进行处理的代码放在放行之前进行处理，而如果请求完资源后还要对响应的数据进行处理时可以在放行后进行逻辑处理。

#### 1.4 `Filter`拦截路径配置 ####

拦截路径表示`Filter`会对请求的哪些资源进行拦截，使用 `@WebFilter` 注解进行配置。如：`@WebFilter("拦截路径")`

拦截路径有如下四种配置方式：

*  拦截具体的资源：`/index.jsp`：只有访问`index.jsp`时才会被拦截
 *  目录拦截：`/user/*`：访问`/user`下的所有资源，都会被拦截
 *  后缀名拦截：`*.jsp`：访问后缀名为`jsp`的资源，都会被拦截
 *  拦截所有：`/*`：访问所有资源，都会被拦截

通过上面拦截路径的介绍，大家会发现拦截路径的配置方式和 `Servlet` 的请求资源路径配置方式一样，但是表示的含义不同。

#### 1.5 过滤器链 ####

##### 1.5.1 概述 #####

过滤器链是指在一个`Web`应用，可以配置多个过滤器，这多个过滤器称为过滤器链。

如下图就是一个过滤器链，介绍过滤器链主要是介绍过滤器链执行的流程

![在这里插入图片描述][e4d773a15e9d4e50947352d3f5cb6677.png_pic_center]

上图中的过滤器链执行是按照以下流程执行：

1.  执行 `Filter1` 的放行前逻辑代码
2.  执行 `Filter1` 的放行代码
3.  执行 `Filter2` 的放行前逻辑代码
4.  执行 `Filter2` 的放行代码
5.  访问到资源
6.  执行 `Filter2` 的放行后逻辑代码
7.  执行 `Filter1` 的放行后逻辑代码

以上流程串起来就像一条链子，故称之为过滤器链。

##### 1.5.2 代码演示 #####

*  编写第一个过滤器 `FilterDemo` ，配置成拦截所有资源
    
        package com.dcxuexi.web.filter;
        
        import javax.servlet.*;
        import javax.servlet.annotation.WebFilter;
        import java.io.IOException;
        
        /***
         * @Title FilterDemo
         * @Description TOTD
         * @Auter DongChuang
         * @Date 2023/2/2 20:28
         * @Version 1.0.0
         */
        @WebFilter("/*")
        public class FilterDemo implements Filter {
              
            @Override
            public void init(FilterConfig filterConfig) throws ServletException {
              
        
            }
        
            @Override
            public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
              
                System.out.println("FilterDemo  被执行了，，，");
                //1. 放行前，对 request数据进行处理
                System.out.println("1.FilterDemo...");
                //放行
                chain.doFilter(request,response);
        
                //2. 放行后，对Response 数据进行处理
                System.out.println("5.FilterDemo...");
            }
        
            @Override
            public void destroy() {
              
        
            }
        }
 *  编写第二个过滤器 `FilterDemo2` ，配置拦截所有资源
    
        package com.dcxuexi.web.filter;
        
        import javax.servlet.*;
        import java.io.IOException;
        
        /***
         * @Title FilterDemo2
         * @Description TOTD
         * @Auter DongChuang
         * @Date 2023/2/2 20:58
         * @Version 1.0.0
         */
        @WebFilter("/*")
        public class FilterDemo2 implements Filter {
              
            @Override
            public void init(FilterConfig filterConfig) throws ServletException {
              
        
            }
        
            @Override
            public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {
              
                System.out.println("FilterDemo2  被执行了，，，");
                //1. 放行前，对 request数据进行处理
                System.out.println("2.FilterDemo2...");
                //放行
                chain.doFilter(request,response);
        
                //2. 放行后，对Response 数据进行处理
                System.out.println("4.FilterDemo2...");
            }
        
            @Override
            public void destroy() {
              
        
            }
        }
 *  修改 `hello.jsp` 页面中脚本的输出语句
    
        <%--
          Created by IntelliJ IDEA.
          User: DongChuang
          Date: 2023/2/2
          Time: 20:30
          To change this template use File | Settings | File Templates.
        --%>
        <%@ page contentType="text/html;charset=UTF-8" language="java" %>
        <html>
        <head>
            <title>hello</title>
        </head>
        <body>
            <h1>hello JSP~</h1>
            <%
                System.out.println("3.hello jsp");
            %>
        </body>
        </html>
 *  启动服务器，在浏览器输入 `http://localhost/filter-demo/hello.jsp` 进行测试，在控制台打印内容如下![在这里插入图片描述][05de291429ec4aeda4c1db783dca71ec.png_pic_center]
    
    从结果可以看到确实是按照我们之前说的执行流程进行执行的。

##### 1.5.3 问题 #####

上面代码中为什么是先执行 `FilterDemo` ，后执行 `FilterDemo2` 呢？

我们现在使用的是注解配置`Filter`，而这种配置方式的优先级是按照过滤器类名（字符串）的自然排序。

比如有如下两个名称的过滤器 ： `BFilterDemo` 和 `AFilterDemo` 。那一定是 `AFilterDemo` 过滤器先执行。

### 二、监听器`Listener` ###

#### 2.1 概述 ####

*  `Listener`表示监听器，是`JavaWeb`三大组件（`Servlet`、`Filter`、`Listener`）之一。
 *  监听器可以监听就是在 `application`，`session`，`request` 三个对象创建、销毁或者往其中添加修改删除属性时自动执行代码的功能组件。
    
    `request`和`session`我们介绍过。而 `application` 是 `ServletContext` 类型的对象。
    
    `ServletContext` 代表整个`web`应用，在服务器启动的时候，`tomcat`会自动创建该对象。在服务器关闭时会自动销毁该对象。

#### 2.2 分类 ####

`JavaWeb`提供了8个监听器：![在这里插入图片描述][8ec7872c7bbc4e959f327da6baf09009.png_pic_center]

这里面只有 `ServletContextListener` 这个监听器后期我们会接触到，`ServletContextListener` 是用来监听 `ServletContext` 对象的创建和销毁。

`ServletContextListener` 接口中有以下两个方法

*  `void contextInitialized(ServletContextEvent sce)`：`ServletContext` 对象被创建了会自动执行的方法
 *  `void contextDestroyed(ServletContextEvent sce)`：`ServletContext` 对象被销毁时会自动执行的方法

#### 2.3 代码演示 ####

我们演示一下 `ServletContextListener` 监听器

*  定义一个类，实现`ServletContextListener` 接口
 *  重写所有的抽象方法
 *  使用 `@WebListener` 进行配置

代码如下：

@WebListener
    public class ContextLoaderListener implements ServletContextListener {
        
        @Override
        public void contextInitialized(ServletContextEvent sce) {
        
            //加载资源
            System.out.println("ContextLoaderListener...");
        }
    
        @Override
        public void contextDestroyed(ServletContextEvent sce) {
        
            //释放资源
        }
    }

启动服务器，就可以在启动的日志信息中看到 `contextInitialized()` 方法输出的内容，同时也说明了 `ServletContext` 对象在服务器启动的时候被创建了。

![在这里插入图片描述][ec8cee2de4f943dda8fee17e5890b828.png_pic_center]

[41c9e6b5002c4223ab4912c68a887cd2.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/3381a708dcb24edd9816e76b4015125b.png
[f774087a13cb49f0be32f9e100cccc32.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/0fa1a9fcf66341c8a7446432889de918.png
[5e09deebea914a70b7613bf39d090802.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/3f5a87566df14c79bab14a2a02241d5b.png
[d55d55990247407a8b25792aafcf7c6c.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/3b62bde019624a509c9942b5b31984d3.png
[56bdc2dcb1f24b34906742575ec6eec9.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/00ae5835969243f38669ad98414947af.png
[4bd89e38b93f4f3b827056cdb1e97ace.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/7331c8d6f221405396d592b13aaa7fb9.png
[738ef754404541768f406c09d92e7725.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/6b89cec2f8f04a00904f0c7eaf38c88a.png
[bba8313f10014ee89e79460300a85269.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/07df3d53e99b43d399329e7f7aaf3141.png
[46418a38547144599cc873c8ddfac24f.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/27f48d8a9fb6464ebed66a201552397d.png
[6838bb8e28eb46728b76d2e581e6e443.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/6ab750ab117e4625995eaf515dcf1a30.png
[bbd8fa8b8dd84711b3a1bd246c17db8f.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/732b951bbeef4a93b24d9d6d3bd5c1f0.png
[60f346681e9145198c4669291fa12a8a.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/51ecc821224444819a960ede91583b3f.png
[599a5f9b93144f68b4882ea90ca80052.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/41b6e0c0b1dc4a1c8fe0ce8c120443de.png
[e4d773a15e9d4e50947352d3f5cb6677.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/8659d0a9a7d2425caf5fca5ec1ed6257.png
[05de291429ec4aeda4c1db783dca71ec.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/b4ed31ccff1d446695a51099aaf2a3fd.png
[8ec7872c7bbc4e959f327da6baf09009.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/31b4792973b14ca08572e5e5af57b3fe.png
[ec8cee2de4f943dda8fee17e5890b828.png_pic_center]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/b2cce0520e6e4cc69b6b5807e38ee631.png