【教程】JavaWeb之Listener技术

ゞ浴缸里的玫瑰 2022-12-21 03:28 153阅读 0赞

## 1.基本概念 ##

在谍战中，谍报人员每天做的事情，实际上就是监听，监听敌方有无发报，发报能否被拦截，报文是否能够解析。而 java web中，也有监听器——Listener。

*  Listener监听器，作为javaWeb的3大组件之一，用来监听Servlet容器产生的事件并进行相应的处理。
 *  容器产生的事件分类如下：  
    生命周期相关的事件。 – 如 对象的创建或者销毁等  
    属性状态相关的事件。 – attribute属性的增删改  
    存值状态相关的事件。 – 如 对象和session的绑定和解绑
 *  底层原理是采用接口回调的方式实现。

## 2.基本分类 ##

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_70]  
HttpSessionBindingListener用于监听存值状态相关的事件。  
所谓钝化，其实就是序列化操作（对象转换为字节序列），由内存写入到硬盘；  
所谓活化，就是反序列化（字节序列转换成对象），指的是从硬盘到内存的过程。

## 3.监听器详解 ##

**（1）ServletRequestListener监听器**  
在ServletRequest创建和关闭时都会通知ServletRequestListener监听器。  
常用方法如下：  
![在这里插入图片描述][20201116215329854.png]  
自定义监听器：MyRequestListener.java

public class MyRequestListener implements ServletRequestListener { 
        @Override
        public void requestDestroyed(ServletRequestEvent servletRequestEvent) { 
            System.out.println("请求销毁了...");
        }
    
        @Override
        public void requestInitialized(ServletRequestEvent servletRequestEvent) { 
            System.out.println("创建请求...");
        }
    }

web.xml配置监听器

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd" version="4.0">
      
      <listener>
            <listener-class>com.lagou.demo03.MyRequestListener</listener-class>
        </listener>
    </web-app>

运行效果；  
![在这里插入图片描述][20201116215821716.png]  
只要在网页发起了请求，就会调用这个监听器的两个回调方法。  
**（2）ServletRequestAttributeListener监听器**  
向ServletRequest添加、删除或者替换一个属性的时候，将会通知  
ServletRequestAttributeListener监听器。  
常用方法如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_70 1]  
MyRequestAttributeListener.java

public class MyRequestAttributeListener implements ServletRequestAttributeListener { 
        @Override
        public void attributeAdded(ServletRequestAttributeEvent servletRequestAttributeEvent) { 
            System.out.println("增加了属性" + servletRequestAttributeEvent.getName());
        }
    
        @Override
        public void attributeRemoved(ServletRequestAttributeEvent servletRequestAttributeEvent) { 
            System.out.println("属性" + servletRequestAttributeEvent.getName() + "被删除了" );
        }
    
        @Override
        public void attributeReplaced(ServletRequestAttributeEvent servletRequestAttributeEvent) { 
            System.out.println("修改属性" + servletRequestAttributeEvent.getName());
        }
    }

web.xml

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd" version="4.0">
    
    <listener>
        <listener-class>com.example.demo03.MyRequestAttributeListener</listener-class>
    </listener>
    </web-app>

requestAttribute.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
        <title>实现请求中属性状态的改变</title>
    </head>
    <body>
    <%
        // 实现属性的添加
        request.setAttribute("name", "zhangfei");
        // 实现属性的修改
        request.setAttribute("name", "guanyu");
        // 实现属性的删除
        request.removeAttribute("name");
    %>
    </body>
    </html>

在浏览器请求requestAttribute.jsp  
![在这里插入图片描述][20201120213659738.png]  
打印输出：  
![在这里插入图片描述][20201120213748496.png]  
**（3）HttpSessionListener监听器**  
当一个HttpSession刚被创建或者失效（invalidate）的时候，将会通知HttpSessionListener监听  
器。  
常用方法如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_70 2]  
MySessionListener.java

public class MySessionListener implements HttpSessionListener { 
        @Override
        public void sessionCreated(HttpSessionEvent httpSessionEvent) { 
            System.out.println("创建了session...");
        }
    
        @Override
        public void sessionDestroyed(HttpSessionEvent httpSessionEvent) { 
            System.out.println("session销毁！");
        }
    }

web.xml

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd" version="4.0">
    
    <listener>
        <listener-class>com.example.demo03.MySessionListener</listener-class>
    </listener>
    
    <session-config>
        <session-timeout>3</session-timeout>
    </session-config>
    </web-app>

这里配置了session的超时时间为3分钟，不然浏览器的session默认超时时间是30分钟，比较难等。  
浏览器直接请求index.jsp，就会看到日志输出：  
![在这里插入图片描述][20201120214640365.png]  
**（4）HttpSessionAttributeListener监听器**  
HttpSession中添加、删除或者替换一个属性的时候，将会通知HttpSessionAttributeListener监  
听器。  
常用方法如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_70 3]  
MySessionAttributeListener.java

public class MySessionAttributeListener implements HttpSessionAttributeListener { 
        @Override
        public void attributeAdded(HttpSessionBindingEvent httpSessionBindingEvent) { 
            System.out.println("增加了属性" + httpSessionBindingEvent.getName());
        }
    
        @Override
        public void attributeRemoved(HttpSessionBindingEvent httpSessionBindingEvent) { 
            System.out.println("属性" + httpSessionBindingEvent.getName() + "被删除！");
        }
    
        @Override
        public void attributeReplaced(HttpSessionBindingEvent httpSessionBindingEvent) { 
            System.out.println("修改属性" + httpSessionBindingEvent.getName());
        }
    }

web.xml

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd" version="4.0">
    
    <listener>
        <listener-class>com.example.demo03.MySessionAttributeListener</listener-class>
    </listener>
    </web-app>

sessionAttribute.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
        <title>实现会话中属性状态的改变</title>
    </head>
    <body>
    <%
        // 增加属性
        session.setAttribute("name", "caocao");
        // 修改属性
        session.setAttribute("name", "caoren");
        // 删除属性
        session.removeAttribute("name");
    %>
    </body>
    </html>

在浏览器访问sessionAttribute.jsp，可以看到日志输出：  
![在这里插入图片描述][20201120215914877.png]  
**（5）ServletContextListener监听器**  
在ServletContext创建和关闭时都会通知ServletContextListener监听器。  
常用方法如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_70 4]  
MyContextListener.java

public class MyContextListener implements ServletContextListener { 
        @Override
        public void contextInitialized(ServletContextEvent servletContextEvent) { 
            System.out.println("ServletContext对象创建了...");
        }
    
        @Override
        public void contextDestroyed(ServletContextEvent servletContextEvent) { 
            System.out.println("销毁ServletContext对象...");
        }
    }

web.xml

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd" version="4.0">
    
    <listener>
        <listener-class>com.example.demo03.MyContextListener</listener-class>
    </listener>
    </web-app>

ServletContext对象随着服务器的启动而创建 ，随着服务器的关闭而销毁，对应整个web项目。  
![在这里插入图片描述][20201120220549783.png]![在这里插入图片描述][20201120220516391.png]  
**（6）ServletContextAttributeListener监听器**  
向ServletContext添加、删除或者替换一个属性的时候，将会通知  
ServletContextAttributesListener监听器  
常用方法如下：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_7]  
MyContextAttributeListener.java

public class MyContextAttributeListener implements ServletContextAttributeListener { 
        @Override
        public void attributeAdded(ServletContextAttributeEvent servletContextAttributeEvent) { 
            System.out.println("增加了属性" + servletContextAttributeEvent.getName());
        }
    
        @Override
        public void attributeRemoved(ServletContextAttributeEvent servletContextAttributeEvent) { 
            System.out.println("属性" + servletContextAttributeEvent.getName() + "被删除！");
        }
    
        @Override
        public void attributeReplaced(ServletContextAttributeEvent servletContextAttributeEvent) { 
            System.out.println("修改属性" + servletContextAttributeEvent.getName());
        }
    }

web.xml

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd" version="4.0">
    
    <listener>
        <listener-class>com.lagou.demo03.MyContextAttributeListener</listener-class>
    </listener>
    </web-app>

contextAttribute.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
        <title>实现ServletContext对象属性的改变</title>
    </head>
    <body>
    <%
        // 增加属性
        application.setAttribute("name", "sunquan");
        // 修改属性
        application.setAttribute("name", "zhouyu");
        // 删除属性
        application.removeAttribute("name");
    %>
    </body>
    </html>

在浏览器访问contextAttribute.jsp，可以看到日志输出：  
![在这里插入图片描述][20201120221221252.png]  
**（7）HttpSessionBindingListener监听器**  
HttpSession中绑定和解除绑定时，将会通知HttpSessionListener监听器。  
常用方法如下：  
![在这里插入图片描述][20201120221801329.png]  
要想实现session绑定对象的监听，需要建立一个实体类，还需要这个类和HttpSessionBindingListener接口关联。

Person.java

public class Person implements HttpSessionBindingListener { 
        private String name;
        private int age;
    
        public Person() { 
        }
    
        public Person(String name, int age) { 
            this.name = name;
            this.age = age;
        }
    
        public String getName() { 
            return name;
        }
    
        public void setName(String name) { 
            this.name = name;
        }
    
        public int getAge() { 
            return age;
        }
    
        public void setAge(int age) { 
            this.age = age;
        }
    
        @Override
        public String toString() { 
            return "Person{" +
                    "name='" + name + '\'' +
                    ", age=" + age +
                    '}';
        }
    
        @Override
        public void valueBound(HttpSessionBindingEvent httpSessionBindingEvent) { 
            System.out.println("对象绑定到session中了" + httpSessionBindingEvent.getName());
        }
    
        @Override
        public void valueUnbound(HttpSessionBindingEvent httpSessionBindingEvent) { 
            System.out.println("解除绑定成功！");
        }
    }

sessionBind.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
        <title>实现session中对象的绑定和解除</title>
    </head>
    <body>
    <%
        // 准备一个Person类型的对象
        Person person = new Person();
        person.setName("zhangfei");
        person.setAge(30);
        // 将对象与session对象进行绑定
        session.setAttribute("person", person);
        // 解除绑定
        session.removeAttribute("person");
    %>
    </body>
    </html>

注意，这个监听器不需要在web.xml中配置了，因为它和类绑定到一起了。

**（8）HttpSessionActivationListener监听器**  
当有session数值的钝化和活化操作时，将会通知HttpSessionActivationListener监听器。  
常用方法如下：  
![在这里插入图片描述][20201120222211213.png]  
Student.java

public class Student implements Serializable, HttpSessionActivationListener { 
        private String name;
    
        public Student() { 
        }
    
        public Student(String name) { 
            this.name = name;
        }
    
        public String getName() { 
            return name;
        }
    
        public void setName(String name) { 
            this.name = name;
        }
    
        @Override
        public String toString() { 
            return "Student{" +
                    "name='" + name + '\'' +
                    '}';
        }
    
        @Override
        public void sessionWillPassivate(HttpSessionEvent httpSessionEvent) { 
            System.out.println("执行了钝化操作..." + httpSessionEvent.getSession());
        }
    
        @Override
        public void sessionDidActivate(HttpSessionEvent httpSessionEvent) { 
            System.out.println("活化操作进行中...");
        }
    }

既然涉及序列化，所以实体类需要实现 Serializable接口。

sessionActivate.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
        <title>实现session中数据的钝化和活化操作</title>
    </head>
    <body>
    <%
        // 创建Student类型的对象
        Student student = new Student();
        student.setName("zhangfei");
        // 将数据放入到session中
        session.setAttribute("student", student);
    %>
    
    </body>
    </html>

同样不需要在web.xml中配置，因为Student类已经和监听器关联了。  
启动项目后，在浏览器中请求sessionActivate.jsp，再将服务器关闭或者重启服务器，可以看到日志输出：  
![在这里插入图片描述][20201120224027231.png]  
此时执行了钝化操作，选中tomcat临时路径，硬盘中去访问此路径，  
![在这里插入图片描述][20201120224211312.png]  
然后进入work目录，找到自己的项目文件，可以看到多了一个session.ser文件，这个文件就是进行钝化操作所存储的文件。  
![在这里插入图片描述][20201120224310231.png]  
![在这里插入图片描述][20201120224440287.png]  
ideal有个特性，启动服务的时候，会把work目录下的文件清空。如果想在下次启动项目的时候，执行活化操作（即把session保存的数据读取到内存），则需要进行session钝化文件目录的重新配置。  
配置context.xml文件的方式如下：

将上面的配置加在tomacat安装目录的context.xml文件中  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_70 5]  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_70 6]  
根据这个配置，就把session钝化文件存放的目录改成了C:\\session。  
再次启动项目进行钝化，可以看到，重新生成了一个.session文件在新目录。  
![在这里插入图片描述][20201120225329371.png_pic_center]  
现在可以进行活化操作了，  
新建一个sessionGet.jsp用于访问session钝化的数据。

重启项目，访问sessionGet.jsp，可以看到打印输出：  
![在这里插入图片描述][20201120225711179.png]  
session数据活化成功。

## 4.实战案例 ##

实现一个监听实时用户在线人数的小例子：  
自定义类实现监听器接口并重写相关的方法  
OnlineUser.java

public class OnlineUser implements HttpSessionListener, ServletContextListener { 
        // 声明一个ServletContex类型的引用负责作为全局对象来记录当前在线用户的数量，通过属性记录
        private ServletContext servletContext = null;
    
        @Override
        public void contextInitialized(ServletContextEvent servletContextEvent) { 
            servletContext = servletContextEvent.getServletContext();
        }
    
        @Override
        public void contextDestroyed(ServletContextEvent servletContextEvent) { 
            servletContext = null;
        }
    
        @Override
        public void sessionCreated(HttpSessionEvent httpSessionEvent) { 
            System.out.println("有新用户上线了...");
            Object count = servletContext.getAttribute("count");
            // 若当前用户为第一个用户，则将全局对象中的属性值设置为1即可
            if (null == count) { 
                servletContext.setAttribute("count", 1);
            }
            // 若当前用户不是第一个用户，则将全局对象中原有的数据取出来加1后再设置进去
            else { 
                Integer integer = (Integer)count;
                integer++;
                servletContext.setAttribute("count", integer);
            }
            System.out.println("当前在线用户数量为：" + servletContext.getAttribute("count"));
        }
    
        @Override
        public void sessionDestroyed(HttpSessionEvent httpSessionEvent) { 
            System.out.println("有用户已下线...");
        }
    }

web.xml配置监听器

<?xml version="1.0" encoding="UTF-8"?>
    <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_4_0.xsd" version="4.0">
        
        <listener>
            <listener-class>com.example.demo04.OnlineUser</listener-class>
        </listener>
    </web-app>

创建jsp页面显示在线人数  
onlineUser.jsp

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
    <html>
    <head>
        <title>实现当前在线的用户数量</title>
    </head>
    <body>
    <h1>当前在线用户人数为：${applicationScope.count}</h1>
    </body>
    </html>

运行效果  
![在这里插入图片描述][20201120231307923.png]  
可以再打开一个浏览器请求  
![在这里插入图片描述][20201120231327806.png]  
![在这里插入图片描述][20201120231448728.png]

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_70]: /images/20221120/01d6c873466d4802ac95f4b35e632111.png
[20201116215329854.png]: /images/20221120/d6b62ac1efce4efba7190e8a31bf074b.png
[20201116215821716.png]: /images/20221120/1fb72ca5ce06474e98b4094a3eebda79.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_70 1]: /images/20221120/87e1dde4f4194813872e0cf92a18d12e.png
[20201120213659738.png]: /images/20221120/2d0a360e89d14f1db4c5c05ea10162b1.png
[20201120213748496.png]: /images/20221120/ab3c402917c544868269a34e9ba6a681.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_70 2]: /images/20221120/bd2a07645bde4ed68a1b5aa81298a9ce.png
[20201120214640365.png]: /images/20221120/50c49e91e6ff4ad3a14ae419f7e19fe3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_70 3]: /images/20221120/a92a4a6cce83405baa99f9f5dd4592d9.png
[20201120215914877.png]: /images/20221120/06bf018997804bdabab99d7a9c6eaacb.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_70 4]: /images/20221120/104a06dbab5547afaac1aa868d6291b6.png
[20201120220549783.png]: https://img-blog.csdnimg.cn/20201120220549783.png
[20201120220516391.png]: /images/20221120/71f43d043758457886ff4706fe31df22.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_7]: /images/20221120/710a0a5e0bd94aefa5ca0b4975d8576f.png
[20201120221221252.png]: /images/20221120/4fd67592eeba4c309ae09d6cd489bad6.png
[20201120221801329.png]: /images/20221120/eff5e6a0f18342229b967d8d2c971f05.png
[20201120222211213.png]: /images/20221120/980aeaa72f5d4f11ac7efd1709c93c63.png
[20201120224027231.png]: /images/20221120/52d885e5ae994f8c95ff6da96dc39906.png
[20201120224211312.png]: /images/20221120/82bfb6db66da4132af37c88017f10e2b.png
[20201120224310231.png]: /images/20221120/cb443cab45204602ad2b415cc8564052.png
[20201120224440287.png]: /images/20221120/8cb77d1ec48d4e8e8196a99b2ff60cf1.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_70 5]: /images/20221120/9134037d88524f868af7be441266533c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3UwMTI2NjA0NjQ_size_16_color_FFFFFF_t_70 6]: /images/20221120/9e951d9c17bc4384b4f9c3958fb67694.png
[20201120225329371.png_pic_center]: /images/20221120/677dde519db94f01a5f329e47b94fb1c.png
[20201120225711179.png]: /images/20221120/557dc274e9504f62a30af3002488a25d.png
[20201120231307923.png]: /images/20221120/150acd8c41654c179c5485c07caca8cd.png
[20201120231327806.png]: /images/20221120/82e683308038487182235632b569ece5.png
[20201120231448728.png]: /images/20221120/035242dae3e2489fbe70e8de12bbbea9.png