JavaWeb Listener 详解

empti_

于 2025-07-10 18:27:15 发布

阅读量897

点赞数 18

CC 4.0 BY-SA版权

分类专栏： Servlet 文章标签： servlet

本文链接：https://blog.csdn.net/echo_123qq/article/details/149256291

Servlet 专栏收录该内容

17 篇文章

订阅专栏

JavaWeb Listener 详解

一、Listener 概述

Listener（监听器）是 JavaWeb 三大组件之一（Servlet、Filter、Listener），用于监听 Web 应用中某些对象、信息的创建、销毁、增加、修改、删除等动作的发生，然后作出相应的响应处理。

二、Listener 分类

JavaWeb 中的监听器主要分为三类：

1. ServletContext 监听器

ServletContextListener：监听 ServletContext 对象的创建和销毁
ServletContextAttributeListener：监听 ServletContext 范围属性的变化

2. Session 监听器

HttpSessionListener：监听 HttpSession 对象的创建和销毁
HttpSessionAttributeListener：监听 HttpSession 范围属性的变化
HttpSessionActivationListener：监听 HttpSession 的活化和钝化
HttpSessionBindingListener：监听对象绑定到 Session 或从 Session 解绑

3. Request 监听器

ServletRequestListener：监听 ServletRequest 对象的创建和销毁
ServletRequestAttributeListener：监听 ServletRequest 范围属性的变化

三、常用 Listener 详解

1. ServletContextListener

作用：监听 Web 应用的启动和关闭

方法：

contextInitialized(ServletContextEvent sce)：Web 应用启动时调用
contextDestroyed(ServletContextEvent sce)：Web 应用关闭时调用

示例：

public class MyServletContextListener implements ServletContextListener {
    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("Web应用启动...");
        // 初始化工作，如加载配置文件、创建数据库连接池等
    }
    
    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("Web应用关闭...");
        // 清理工作，如关闭数据库连接池等
    }
}

配置：

<!-- web.xml 中配置 -->
<listener>
    <listener-class>com.example.MyServletContextListener</listener-class>
</listener>

2. HttpSessionListener

作用：监听 Session 的创建和销毁

方法：

sessionCreated(HttpSessionEvent se)：Session 创建时调用
sessionDestroyed(HttpSessionEvent se)：Session 销毁时调用

示例：

public class MyHttpSessionListener implements HttpSessionListener {
    @Override
    public void sessionCreated(HttpSessionEvent se) {
        System.out.println("Session创建，ID: " + se.getSession().getId());
    }
    
    @Override
    public void sessionDestroyed(HttpSessionEvent se) {
        System.out.println("Session销毁，ID: " + se.getSession().getId());
    }
}

3. ServletRequestListener

作用：监听 Request 的创建和销毁

方法：

requestInitialized(ServletRequestEvent sre)：Request 创建时调用
requestDestroyed(ServletRequestEvent sre)：Request 销毁时调用

示例：

public class MyServletRequestListener implements ServletRequestListener {
    @Override
    public void requestInitialized(ServletRequestEvent sre) {
        System.out.println("Request创建，来自IP: " + 
            ((HttpServletRequest)sre.getServletRequest()).getRemoteAddr());
    }
    
    @Override
    public void requestDestroyed(ServletRequestEvent sre) {
        System.out.println("Request销毁");
    }
}

四、属性监听器

1. ServletContextAttributeListener

作用：监听 ServletContext 中属性的变化（添加、移除、替换）

方法：

attributeAdded(ServletContextAttributeEvent scae)：当向ServletContext中添加属性时调用
attributeRemoved(ServletContextAttributeEvent scae)：当从ServletContext中移除属性时调用
attributeReplaced(ServletContextAttributeEvent scae)：当ServletContext中的属性被替换时调用

示例：

public class MyServletContextAttributeListener implements ServletContextAttributeListener {
    @Override
    public void attributeAdded(ServletContextAttributeEvent scae) {
        System.out.println("ServletContext添加属性: " + scae.getName() + "=" + scae.getValue());
    }
    
    @Override
    public void attributeRemoved(ServletContextAttributeEvent scae) {
        System.out.println("ServletContext移除属性: " + scae.getName());
    }
    
    @Override
    public void attributeReplaced(ServletContextAttributeEvent scae) {
        System.out.println("ServletContext替换属性: " + scae.getName() + 
                         ", 旧值=" + scae.getValue() + 
                         ", 新值=" + scae.getServletContext().getAttribute(scae.getName()));
    }
}

2. HttpSessionAttributeListener

作用：监听 HttpSession 中属性的变化（添加、移除、替换）

方法：

attributeAdded(HttpSessionBindingEvent se)：当向Session中添加属性时调用
attributeRemoved(HttpSessionBindingEvent se)：当从Session中移除属性时调用
attributeReplaced(HttpSessionBindingEvent se)：当Session中的属性被替换时调用

示例：

public class MyHttpSessionAttributeListener implements HttpSessionAttributeListener {
    @Override
    public void attributeAdded(HttpSessionBindingEvent se) {
        System.out.println("Session添加属性: " + se.getName() + "=" + se.getValue() + 
                          ", SessionID=" + se.getSession().getId());
    }
    
    @Override
    public void attributeRemoved(HttpSessionBindingEvent se) {
        System.out.println("Session移除属性: " + se.getName() + 
                          ", SessionID=" + se.getSession().getId());
    }
    
    @Override
    public void attributeReplaced(HttpSessionBindingEvent se) {
        System.out.println("Session替换属性: " + se.getName() + 
                          ", 旧值=" + se.getValue() + 
                          ", 新值=" + se.getSession().getAttribute(se.getName()) +
                          ", SessionID=" + se.getSession().getId());
    }
}

3. ServletRequestAttributeListener

作用：监听 ServletRequest 中属性的变化（添加、移除、替换）

方法：

attributeAdded(ServletRequestAttributeEvent srae)：当向Request中添加属性时调用
attributeRemoved(ServletRequestAttributeEvent srae)：当从Request中移除属性时调用
attributeReplaced(ServletRequestAttributeEvent srae)：当Request中的属性被替换时调用

示例：

public class MyServletRequestAttributeListener implements ServletRequestAttributeListener {
    @Override
    public void attributeAdded(ServletRequestAttributeEvent srae) {
        System.out.println("Request添加属性: " + srae.getName() + "=" + srae.getValue());
    }
    
    @Override
    public void attributeRemoved(ServletRequestAttributeEvent srae) {
        System.out.println("Request移除属性: " + srae.getName());
    }
    
    @Override
    public void attributeReplaced(ServletRequestAttributeEvent srae) {
        System.out.println("Request替换属性: " + srae.getName() + 
                         ", 旧值=" + srae.getValue() + 
                         ", 新值=" + srae.getServletRequest().getAttribute(srae.getName()));
    }
}

五、特殊监听器

1. HttpSessionBindingListener

特点：

不需要在 web.xml 中配置
由 JavaBean 实现，当该对象被绑定到 Session 或从 Session 解绑时触发

方法：

valueBound(HttpSessionBindingEvent event)：绑定到 Session 时调用
valueUnbound(HttpSessionBindingEvent event)：从 Session 解绑时调用

示例：

public class User implements HttpSessionBindingListener {
    private String name;
    
    // 构造方法、getter、setter 省略
    
    @Override
    public void valueBound(HttpSessionBindingEvent event) {
        System.out.println(this.name + "被绑定到Session");
    }
    
    @Override
    public void valueUnbound(HttpSessionBindingEvent event) {
        System.out.println(this.name + "从Session解绑");
    }
}

2. HttpSessionActivationListener

作用：监听 Session 的钝化和活化（用于分布式环境）

方法：

sessionWillPassivate(HttpSessionEvent se)：Session 即将钝化时调用
sessionDidActivate(HttpSessionEvent se)：Session 活化后调用

六、Listener 的应用场景

初始化工作：在 Web 应用启动时加载配置文件、初始化数据库连接池等
统计在线人数：通过 Session 监听器统计在线用户数量
资源清理：在 Web 应用关闭时释放资源
日志记录：记录重要事件的发生
权限检查：在请求到达时进行权限验证

七、Listener 的注册方式

1. web.xml 配置

<listener>
    <listener-class>com.example.MyListener</listener-class>
</listener>

2. 注解方式（Servlet 3.0+）

@WebListener
public class MyListener implements ServletContextListener {
    // 实现方法
}

八、注意事项

监听器的执行顺序与在 web.xml 中的配置顺序有关
监听器是单例的，整个应用只有一个实例
监听器中的代码要尽量高效，避免影响应用性能
对于分布式环境，要考虑监听器的同步问题