在 Java Web 应用程序中，监听器（Listener）是一种强大的机制，用于在 Web 容器中监听和响应各种事件。通过监听器，我们可以在应用程序生命周期中执行特定的任务，如在应用启动时初始化资源，在会话创建或销毁时执行特定操作，监听请求的属性变化等。
在本文中，我们将深入探讨 Java Listener 的基本概念、常见类型以及如何使用它们来增强你的 Web 应用程序。
1. Listener 基础概念
1.1 什么是 Listener？
Listener 是 Java Servlet 规范中的一部分，它提供了一种机制，使开发者能够编写监听器类来监听容器事件，并在事件发生时执行相应的逻辑。这样的机制使得我们能够在不修改源代码的情况下，通过监听器对现有应用程序进行扩展或增强。
1.2 Listener 类型
Java 提供了几种类型的 Listener，其中最常见的有以下三种：
- ServletContextListener（上下文监听器）：用于监听 Web 应用程序的启动和关闭事件。
- HttpSessionListener（会话监听器）：用于监听会话的创建和销毁事件。
- ServletRequestListener（请求监听器）：用于监听请求的创建和销毁事件。
2. 示例代码
为了更好地理解 Listener 的使用，让我们通过一些简单的示例代码来演示它们的基本用法。
2.1 ServletContextListener 示例
ServletContextListener 用于监听 Web 应用程序的启动和关闭事件。我们可以在 contextInitialized 方法中执行一些初始化操作，在 contextDestroyed 方法中执行清理操作。
import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;
@WebListener
public class MyAppContextListener implements ServletContextListener {
@Override
public void contextInitialized(ServletContextEvent sce) {
// 在应用程序启动时执行初始化操作
System.out.println("Web应用程序初始化...");
}
@Override
public void contextDestroyed(ServletContextEvent sce) {
// 在应用程序关闭时执行清理操作
System.out.println("Web应用程序销毁...");
}
}2.2 HttpSessionListener 示例
HttpSessionListener 用于监听会话的创建和销毁事件。我们可以在 sessionCreated 方法中执行一些初始化操作，在 sessionDestroyed 方法中执行清理操作。
import javax.servlet.annotation.WebListener;
import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;
@WebListener
public class MySessionListener implements HttpSessionListener {
@Override
public void sessionCreated(HttpSessionEvent se) {
// 在会话创建时执行初始化操作
System.out.println("会话创建：" se.getSession().getId());
}
@Override
public void sessionDestroyed(HttpSessionEvent se) {
// 在会话销毁时执行清理操作
System.out.println("会话销毁：" se.getSession().getId());
}
}2.3 ServletRequestListener 示例
ServletRequestListener 用于监听请求的创建和销毁事件。我们可以在 requestInitialized 方法中执行一些初始化操作，在 requestDestroyed 方法中执行清理操作。
import javax.servlet.ServletRequestEvent;
import javax.servlet.ServletRequestListener;
import javax.servlet.annotation.WebListener;
@WebListener
public class MyRequestListener implements ServletRequestListener {
@Override
public void requestInitialized(ServletRequestEvent sre) {
// 在请求创建时执行初始化操作
System.out.println("请求创建：" sre.getServletRequest().getRemoteAddr());
}
@Override
public void requestDestroyed(ServletRequestEvent sre) {
// 在请求销毁时执行清理操作
System.out.println("请求销毁：" sre.getServletRequest().getRemoteAddr());
}
}3. Listener 配置
在上面的示例中，我们使用了 @WebListener 注解来配置 Listener。这种方式适用于 Servlet 3.0 及以上版本的容器。如果你使用的是较旧的容器，你需要在 web.xml 文件中进行 Listener 的配置。
以下是 web.xml 文件中配置 Listener 的示例：
<!-- web.xml -->
<web-app>
<!-- 配置 ServletContextListener -->
<listener>
<listener-class>com.example.MyAppContextListener</listener-class>
</listener>
<!-- 配置 HttpSessionListener -->
<listener>
<listener-class>com.example.MySessionListener</listener-class>
</listener>
<!-- 配置 ServletRequestListener -->
<listener>
<listener-class>com.example.MyRequestListener</listener-class>
</listener>
</web-app>通过以上配置，容器将会在相应事件发生时调用监听器的方法。
4. Listener 生命周期
Listener 的生命周期由容器管理，容器会在适当的时机调用监听器的方法。让我们简要了解一下这些生命周期方法。
4.1 ServletContextListener 生命周期
ServletContextListener 接口定义了两个方法：
- contextInitialized(ServletContextEvent sce)：在 Web 应用程序初始化时被调用。
- contextDestroyed(ServletContextEvent sce)：在 Web 应用程序销毁时被调用。
4.2 HttpSessionListener 生命周期
HttpSessionListener 接口也定义了两个方法：
- sessionCreated(HttpSessionEvent se)：在会话创建时被调用。
- sessionDestroyed(HttpSessionEvent se)：在会话销毁时被调用。
4.3 ServletRequestListener 生命周期
ServletRequestListener 接口同样定义了两个方法：
- requestInitialized(ServletRequestEvent sre)：在请求创建时被调用。
- requestDestroyed(ServletRequestEvent sre)：在请求销毁时被调用。
5. 小结
通过本文的学习，我们深入了解了 Java Listener 的基本概念、常见类型以及示例代码。Listener 提供了一种灵活的扩展机制，使我们能够更好地控制和定制 Web 应用程序的行为。在实际应用中，合理使用 Listener 可以提高代码的可维护性和灵活性，是 Java Web 开发中的重要组成部分。
作者信息 作者 ： 繁依Fanyi CSDN： https://techfanyi.blog.csdn.net 掘金：https://juejin.cn/user/4154386571867191 |
|---|
