如何在个人web项目中使用Servlet监听器？

分手后的思念是犯贱 2023-10-01 00:24 8阅读 0赞

> 编译软件：IntelliJ IDEA 2019.2.4 x64  
> 操作系统：win10 x64 位 家庭版  
> 服务器软件：apache-tomcat-8.5.27

--------------------

#### 目录 ####

*  一. Servlet监听器是什么？
 *  二. Servlet监听器有哪些作用?
 *   *  2.1 监听域对象的创建和销毁
     *   *  2.1.1 ServletContextListener接口
         *  2.1.2 HttpSessionListener接口
         *  2.1.3 ServletRequestListener接口
     *  2.2 监听域对象内共享数据的添加、修改、删除
     *   *  2.2.1 ServletContextAttributeListener接口
         *  2.2.2 HttpSessionAttributeListener接口
         *  2.2.3 ServletRequestAttributeListener接口
 *  三. 怎样创建一个Servlet监听器？
 *  四. 练手案例

--------------------

## 一. Servlet监听器是什么？ ##

用官方一点的说法来说，“它是基于Java Servlet 规范的对象，主要用于监听Web应用程序中的**ServletContext，HttpSession 和HttpServletRequest等域对象的创建与销毁事件**，以及监听这些域对象中的**属性发生修改**的事件”，非常精辟的表述。

但这些话可能对新手小白来说不是很理解。莫急，个人理解，它就像我们现实生活中的**窃听器**一样，**对某些特定的群体进行窃听，基于监听目标的特定行为事件进行相应的反应**，比如臭名昭著的美国棱镜门窃听事件。

--------------------

## 二. Servlet监听器有哪些作用? ##

### 2.1 监听域对象的创建和销毁 ###

#### 2.1.1 ServletContextListener接口 ####

作用：

> **监听ServletContext对象（全局上下文对象）的创建与销毁**

<table> 
 <thead> 
  <tr> 
   <th>方法名</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>contextInitialized(ServletContextEvent sce)</td> 
   <td>ServletContext创建时调用</td> 
  </tr> 
  <tr> 
   <td>contextDestroyed(ServletContextEvent sce)</td> 
   <td>ServletContext销毁时调用</td> 
  </tr> 
 </tbody> 
</table>

附注：

> `ServletContext对象`是在 **web项目被加载时（Tomcat服务器开机）创建，但在web项目卸载时销毁（Tomcat服务器关机）**

#### 2.1.2 HttpSessionListener接口 ####

作用：

> **监听HttpSession对象（会话域对象）的创建与销毁**

<table> 
 <thead> 
  <tr> 
   <th>方法名</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>sessionCreated(HttpSessionEvent hse)</td> 
   <td>HttpSession对象创建时调用</td> 
  </tr> 
  <tr> 
   <td>sessionDestroyed(HttpSessionEvent hse)</td> 
   <td>HttpSession对象销毁时调用</td> 
  </tr> 
 </tbody> 
</table>

附注：

> `HttpSession对象`是在**第一次调用getSession方法时创建**，但在**客户端关闭，强制失效，达到最大空闲时间时自动失效等三类情形下销毁对象。**

#### 2.1.3 ServletRequestListener接口 ####

作用：

> **监听ServletRequest对象（请求域对象）的创建与销毁**

<table> 
 <thead> 
  <tr> 
   <th>方法名</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>requestInitialized(ServletRequestEvent sre)</td> 
   <td>ServletRequest对象创建时调用</td> 
  </tr> 
  <tr> 
   <td>requestDestroyed(ServletRequestEvent sre)</td> 
   <td>ServletRequest对象销毁时调用</td> 
  </tr> 
 </tbody> 
</table>

附注：

> `ServletRequest对象`是在**有请求就创建**，但在**响应结束时就销毁。**

### 2.2 监听域对象内共享数据的添加、修改、删除 ###

#### 2.2.1 ServletContextAttributeListener接口 ####

作用：

> **监听ServletContext对象中属性的添加、移除和修改**

<table> 
 <thead> 
  <tr> 
   <th>方法名</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>attributeAdded(ServletContextAttributeEvent scab)</td> 
   <td>向ServletContext中添加属性时调用</td> 
  </tr> 
  <tr> 
   <td>attributeRemoved(ServletContextAttributeEvent scab)</td> 
   <td>从ServletContext中移除属性时调用</td> 
  </tr> 
  <tr> 
   <td>attributeReplaced(ServletContextAttributeEvent scab)</td> 
   <td>当ServletContext中的属性被修改时调用</td> 
  </tr> 
 </tbody> 
</table>

ServletContextAttributeEvent对象代表属性变化事件，它包含的方法如下：

<table> 
 <thead> 
  <tr> 
   <th>方法名</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>getName()</td> 
   <td>获取修改或添加的属性名</td> 
  </tr> 
  <tr> 
   <td>getValue()</td> 
   <td>获取被修改或添加的属性值</td> 
  </tr> 
  <tr> 
   <td>getServletContext()</td> 
   <td>获取ServletContext对象</td> 
  </tr> 
 </tbody> 
</table>

#### 2.2.2 HttpSessionAttributeListener接口 ####

作用：

> **监听HttpSession对象中属性的添加、移除和修改**

<table> 
 <thead> 
  <tr> 
   <th>方法名</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>attributeAdded(HttpSessionBindingEvent se)</td> 
   <td>向HttpSession中添加属性时调用</td> 
  </tr> 
  <tr> 
   <td>attributeRemoved(HttpSessionBindingEvent se)</td> 
   <td>从HttpSession中移除属性时调用</td> 
  </tr> 
  <tr> 
   <td>attributeReplaced(HttpSessionBindingEvent se)</td> 
   <td>当HttpSession中的属性被修改时调用</td> 
  </tr> 
 </tbody> 
</table>

HttpSessionBindingEvent对象代表属性变化事件，它包含的方法如下：

<table> 
 <thead> 
  <tr> 
   <th>方法名</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>getName()</td> 
   <td>获取修改或添加的属性名</td> 
  </tr> 
  <tr> 
   <td>getValue()</td> 
   <td>获取被修改或添加的属性值</td> 
  </tr> 
  <tr> 
   <td>getSession()</td> 
   <td>获取触发事件的HttpSession对象</td> 
  </tr> 
 </tbody> 
</table>

#### 2.2.3 ServletRequestAttributeListener接口 ####

作用：

> **监听ServletRequest对象中属性的添加、移除和修改**

<table> 
 <thead> 
  <tr> 
   <th>方法名</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>attributeAdded(ServletRequestAttributeEvent srae)</td> 
   <td>向ServletRequest中添加属性时调用</td> 
  </tr> 
  <tr> 
   <td>attributeRemoved(ServletRequestAttributeEvent srae)</td> 
   <td>从ServletRequest中移除属性时调用</td> 
  </tr> 
  <tr> 
   <td>attributeReplaced(ServletRequestAttributeEvent srae)</td> 
   <td>当ServletRequest中的属性被修改时调用</td> 
  </tr> 
 </tbody> 
</table>

ServletRequestAttributeEvent对象代表属性变化事件，它包含的方法如下：

<table> 
 <thead> 
  <tr> 
   <th>方法名</th> 
   <th>作用</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>getName()</td> 
   <td>获取修改或添加的属性名</td> 
  </tr> 
  <tr> 
   <td>getValue()</td> 
   <td>获取被修改或添加的属性值</td> 
  </tr> 
  <tr> 
   <td>getServletRequest ()</td> 
   <td>获取触发事件的ServletRequest对象</td> 
  </tr> 
 </tbody> 
</table>

--------------------

## 三. 怎样创建一个Servlet监听器？ ##

步骤：

**①创建一个类**

**②实现一个接口**

> 根据业务场景需要可参选实现三者（ServletContextListener，HttpSessionListener，或ServletRequestListener）之一的接口使用

**③实现接口中的抽象方法**

**④注册监听器（最原始的做法）**

位置：

> **在web.xml中注册**

代码示例如下：

//注册刚创建的监听器MyListener
    <listener>
        <listener-class>Listenner.MyListener</listener-class>
    </listener>

--------------------

## 四. 练手案例 ##

> 案例：创建监听器MyListener类，继承ServletContextListener接口，用于监听全局上下文对象的创建与销毁情况，并在web.xml中注册该监听器。演示监听器观察全局上下文对象的创建与销毁。

> **①创建MyListener类，继承ServletContextListener接口**

代码示例如下：

import javax.servlet.ServletContextEvent;
    import javax.servlet.ServletContextListener;
    
    //监听ServletContext应用域对象
    public class MyListener implements ServletContextListener {
        
        @Override
        public void contextInitialized(ServletContextEvent servletContextEvent) {
        
            System.out.println("ServletContext对象创建后执行");
        }
    
        @Override
        public void contextDestroyed(ServletContextEvent servletContextEvent) {
        
            System.out.println("ServletContext对象销毁后执行");
        }
    }

> **②在web.xml里注册该监听器**

代码示例如下：

<listener>
        <listener-class>Listener.MyListener</listener-class>
    </listener>

![在这里插入图片描述][0b9a7fe19a99488bb9cd2660b662af12.png]

[0b9a7fe19a99488bb9cd2660b662af12.png]: https://img-blog.csdnimg.cn/0b9a7fe19a99488bb9cd2660b662af12.png