Spring框架事件驱动架构核心注解之@EventListener

Spring框架事件驱动架构核心注解之@EventListener - 指南

news/2025/9/19 20:58:41/文章来源:https://www.cnblogs.com/wzzkaifa/p/19101692

Spring框架事件驱动架构核心注解之@EventListener

Spring框架事件驱动架构核心注解之@EventListener
- 1、概述
- 2、Spring事件机制核心组件
- - （1）事件(Event)
  - （2）发布者(Publisher)
  - （3）监听器 (Listener)
- 3、高阶特性
- - （1）异步事件
  - （2）多事件监听
  - （3）条件监听
  - （4）监听器排序
- 4、总结

Spring框架事件驱动架构核心注解之@EventListener

1、概述

@EventListener 是 Spring 框架中用于实现事件驱动编程模型的核心注解。它允许应用程序的不同部分以一种松散耦合的方式进行通信。一个组件（发布者）发布一个事件，而其他组件（监听者）可以监听并响应该事件，而发布者无需知道谁是监听者。

@EventListener 注解用于将一个普通方法标记为事件监听器，监听指定类型的事件。
示例：

@Component
public class MyEventListener
{
@EventListener
public void handleEvent(MyCustomEvent event) {
System.out.println("Received event: " + event.getMessage());
}
}

2、Spring事件机制核心组件

（1）事件(Event)

任何继承自 ApplicationEvent 的类都是一个event，在Spring 4.2+ 版本后，一个普通的 POJO 类也可以是一个event，不需要再继承 ApplicationEvent。事件封装了事件源和要传递的信息。
例如：ContextRefreshedEvent（容器刷新事件）、ContextStartedEvent（容器启动事件）等是 Spring 内置的事件。
而自定义事件通常是一个简单的数据对象，用于携带信息。

// 自定义用户注册成功事件，只是一个简单的数据对象
@Data
@NoArgsConstructor
@AllArgsConstructor
public class UserRegisteredEvent
{
private String username;
}

（2）发布者(Publisher)

负责发布事件的组件。它通过 ApplicationEventPublisher 接口的 publishEvent() 方法来发布事件。

@Service
public class UserService
{
// 注入事件发布器
@Autowired
private ApplicationEventPublisher applicationEventPublisher;
public void registerUser(String username, String password) {
// 1. 模拟用户注册逻辑（如保存到数据库）
System.out.println("用户 " + username + " 注册成功，已保存至数据库。");
// 2. 发布一个『用户注册成功』事件
// 事件对象中包含了刚刚注册的用户名信息
applicationEventPublisher.publishEvent(new UserRegisteredEvent(username));
}
}

（3）监听器 (Listener)

负责接收并处理事件的组件。它可以通过两种方式定义：

实现 ApplicationListener 接口（不推荐）：实现 onApplicationEvent(E event) 方法。这种方式会监听所有类型为 E 及其子类的事件；
使用 @EventListener 注解：更现代、更灵活的方式。将一个普通方法标记为事件监听器，该方法通过其参数来声明它要监听的事件类型。

@Component
public class EmailService
{
// 通过方法参数声明要监听的事件类型
@EventListener
public void sendWelcomeEmail(UserRegisteredEvent event) {
String username = event.getUsername();
System.out.println("【邮件服务】正在向 " + username + " 发送欢迎邮件...");
}
}

3、高阶特性

（1）异步事件

默认情况下，事件是同步发布的。这意味着发布者会阻塞，直到所有监听器都处理完事件。可以搭配 @Async 和 @EnableAsync 注解实现异步事件监听。
具体方法：

在主配置类上开启异步支持
在监听器方法上添加 @Async 注解

（2）多事件监听

在一个处理方法中对多个事件处理。
示例：

@Component
public class GenericEventListener
{
// 监听多种事件
@EventListener({
UserRegisteredEvent.class,
UserLoginEvent.class
})
public void handleUserEvent(Object event) {
if (event instanceof UserRegisteredEvent) {
// ... 处理注册事件
} else if (event instanceof UserLoginEvent) {
// ... 处理登录事件
}
}

（3）条件监听

可以使用 SpEL 表达式来设置触发条件。
示例：

@Component
public class GenericEventListener
{
// 条件化监听：只有当事件中的username是"admin"时才处理
@EventListener(condition = "#event.username == 'admin'")
public void handleAdminEvent(UserRegisteredEvent event) {
System.out.println("检测到管理员用户注册，进行特殊处理...");
}
}

（4）监听器排序

使用 @Order 注解可以指定监听器执行的顺序。数字越小，优先级越高。
示例：

@Component
public class LogService
{
@Order(1) // 优先级最高，最先执行
@EventListener
public void logEvent(UserRegisteredEvent event) {
System.out.println("【日志服务】记录用户注册事件...");
}
}