Java Spring 之监听器（Listener）详解与实战

在 Spring 框架中，监听器（Listener）是一种用于监听特定事件的强大工具。通过监听器，我们可以在事件发生时执行自定义的逻辑，例如在应用启动、会话创建、请求处理等关键节点记录日志、进行统计或触发其他业务操作。本文将深入探讨 Spring 监听器的使用方法，并提供具体的代码示例。

一、监听器的作用

1.1 应用生命周期管理

监听应用的启动、停止等事件，执行初始化或清理操作。例如，在应用启动时加载配置文件，在应用停止时释放资源。

1.2 会话管理

监听会话的创建和销毁事件，执行相关的业务逻辑。例如，在会话创建时记录用户登录信息，在会话销毁时更新用户状态。

1.3 请求处理监控

监控请求的处理过程，记录请求信息或进行性能分析。例如，在请求处理前记录请求时间，在请求处理后计算处理时间。

二、创建监听器

2.1 Servlet 容器监听器

实现 ServletContextListener 接口，监听 Servlet 容器的初始化和销毁事件。

import javax.servlet.ServletContextEvent;
import javax.servlet.ServletContextListener;
import javax.servlet.annotation.WebListener;

@WebListener
public class AppInitListener implements ServletContextListener {

    @Override
    public void contextInitialized(ServletContextEvent sce) {
        System.out.println("应用初始化完成");
        // 执行应用初始化逻辑，例如加载配置文件
    }

    @Override
    public void contextDestroyed(ServletContextEvent sce) {
        System.out.println("应用销毁");
        // 执行应用销毁逻辑，例如释放资源
    }
}

2.2 HttpSession 监听器

实现 HttpSessionListener 接口，监听会话的创建和销毁事件。

import javax.servlet.http.HttpSessionEvent;
import javax.servlet.http.HttpSessionListener;
import javax.servlet.annotation.WebListener;

@WebListener
public class SessionListener implements HttpSessionListener {

    @Override
    public void sessionCreated(HttpSessionEvent se) {
        System.out.println("会话创建，ID: " + se.getSession().getId());
        // 执行会话创建逻辑，例如记录用户登录信息
    }

    @Override
    public void sessionDestroyed(HttpSessionEvent se) {
        System.out.println("会话销毁，ID: " + se.getSession().getId());
        // 执行会话销毁逻辑，例如更新用户状态
    }
}

2.3 请求处理监听器

实现 ServletRequestListener 接口，监听请求的初始化和销毁事件。

import javax.servlet.ServletRequestEvent;
import javax.servlet.ServletRequestListener;
import javax.servlet.annotation.WebListener;

@WebListener
public class RequestListener implements ServletRequestListener {

    @Override
    public void requestInitialized(ServletRequestEvent sre) {
        System.out.println("请求初始化，URI: " + sre.getServletRequest().getRequestURI());
        // 执行请求初始化逻辑，例如记录请求开始时间
    }

    @Override
    public void requestDestroyed(ServletRequestEvent sre) {
        System.out.println("请求销毁，URI: " + sre.getServletRequest().getRequestURI());
        // 执行请求销毁逻辑，例如记录请求处理时间
    }
}

三、Spring 应用事件监听器

3.1 定义自定义事件

创建一个继承自 ApplicationEvent 的类，定义自定义事件。

import org.springframework.context.ApplicationEvent;

public class CustomEvent extends ApplicationEvent {
    private String message;

    public CustomEvent(Object source, String message) {
        super(source);
        this.message = message;
    }

    public String getMessage() {
        return message;
    }
}

3.2 创建事件监听器

实现 ApplicationListener 接口，监听自定义事件。

import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;

@Component
public class CustomEventListener implements ApplicationListener<CustomEvent> {

    @Override
    public void onApplicationEvent(CustomEvent event) {
        System.out.println("接收到自定义事件: " + event.getMessage());
        // 执行自定义事件的处理逻辑
    }
}

3.3 发布事件

在应用中发布自定义事件。

import org.springframework.context.ApplicationEventPublisher;
import org.springframework.context.ApplicationEventPublisherAware;
import org.springframework.stereotype.Component;

@Component
public class CustomEventPublisher implements ApplicationEventPublisherAware {

    private ApplicationEventPublisher publisher;

    @Override
    public void setApplicationEventPublisher(ApplicationEventPublisher publisher) {
        this.publisher = publisher;
    }

    public void publishCustomEvent(String message) {
        CustomEvent event = new CustomEvent(this, message);
        publisher.publishEvent(event);
    }
}

四、总结

Spring 提供了多种监听器机制，可以用于监听应用生命周期、会话生命周期和请求处理过程中的事件。通过实现相应的监听器接口并注册到 Spring 容器中，我们可以在这些关键节点执行自定义逻辑。监听器在应用初始化、会话管理、请求监控等场景中有着广泛的应用。希望本文的示例和讲解能够帮助你更好地理解和使用 Spring 监听器。