@EventListener 是 Spring Framework 提供的用于处理事件监听的注解。它的工作原理基于观察者设计模式,其中有一个事件发布者(publisher)和一个或多个事件监听者(listener)。
当某个事件发生时,Spring 应用内的某个组件(通常是服务、控制器、或其他组件)会触发一个事件。
事件发布者并不直接调用事件监听者的方法,而是将事件封装成一个事件对象,并将该事件对象发布到 Spring 应用上下文。
事件发布者通常不关心哪些监听者在监听事件,只需将事件发布出去即可。
通过 @EventListener 注解,开发者可以在任何 Spring 管理的 Bean 方法上标注监听事件的方法。
当一个带有 @EventListener 注解的方法的参数类型与发布的事件类型匹配时,Spring 将自动调用该方法,将事件传递给它。
方法可以定义多个参数,每个参数表示一个事件类型,如果发布的事件类型匹配任一参数类型,方法就会被调用。
事件处理顺序:
默认情况下,Spring 会按照监听方法的注册顺序调用它们。
如果需要更加精细的控制,可以使用 @Order 注解来指定监听方法的执行顺序。
@EventListener 方法可以使用 @Async 注解,实现异步处理。这样,当事件触发时,监听方法将在独立的线程中执行,不会阻塞主线程。
需要在主程序类上添加 @EnableAsync 注解启用 Spring 的异步处理。
import org.springframework.context.ApplicationEvent;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
@Component
public class MyEventListener {
@EventListener
public void handleEvent(MyEvent event) {
// 处理 MyEvent 事件
System.out.println("Event handled: " + event.getMessage());
}
}
public class MyEvent extends ApplicationEvent {
private String message;
public MyEvent(Object source, String message) {
super(source);
this.message = message;
}
public String getMessage() {
return message;
}
}
MyEvent 是自定义的事件对象,MyEventListener 中的 handleEvent 方法使用 @EventListener 注解监听 MyEvent 事件。当 MyEvent 事件被发布时,handleEvent 方法将会被自动调用,执行事件处理逻辑。