Spring Events 最新详解(spring4.2前后变化）

devtools/2024/11/29 8:30:39/

事件驱动设计模式，也可能通过Spring来实现。

围绕事件的三个角色：

  • 事件（Event）
  • 事件发布者（Publisher）
  • 事件监听者（Listener）

文章内容：

Spring Event.jpg

1. Demo-01: Spring 4.2版本前

  • 在Spring4.2之前，Event 需要继承ApplicationEvent类。
  • Publisher 需要注入类：ApplicationEventPublisher.
  • Listener 需要实现接口ApplicationListener。

默认情况下，事件的发布和执行都是同步的，这样做的好处是监听的方法也可以参与到发布事件类的transaction中。

1.1 先是Event类：

@Getter
public class UserCreateEvent extends ApplicationEvent {private String userId;public UserCreateEvent(Object source, String userId) {super(source);this.userId = userId;}
}
1.2 Publisher类：

有两种方式可以实现：

  1. 如示例中的代码，注入ApplicationEventPublisher对象。
  2. 可以实现接口ApplicationEventPublisher。

@Slf4j
@Service
public class UserCreateService {@Autowiredpublic ApplicationEventPublisher applicationEventPublisher;public boolean addUser(String userId) {log.info("Start to add user.");applicationEventPublisher.publishEvent(new UserCreateEvent(this, userId));log.info("Add user done.");return true;}
}
1.3 Listener类：

@Slf4j
@Component
public class UserCreateListener implements ApplicationListener<UserCreateEvent> {public void onApplicationEvent(UserCreateEvent userCreateEvent) {String userId = userCreateEvent.getUserId();log.info("Start to notify user.");// mock service, cost 3 second to send email:ThreadUtils.sleep(3000L);log.info("Finished notifying user for userId = " + userId);}
}
1.4 Test类：

@SpringBootTest
public class UserCreateServiceTest {@Autowiredprivate UserCreateService userCreateService;@Testpublic void addUserTest() {userCreateService.addUser("testUser1");}
}

打印结果：可以看到Listener的代码是同步的，Add user done等到Listener代码执行后才打印：

2022-04-17 15:24:56.857 INFO 21545 --- [ main] UserCreateService : Start to add user.
2022-04-17 15:24:56.858 INFO 21545 --- [ main] UserCreateListener : Start to notify user.
2022-04-17 15:24:59.863 INFO 21545 --- [ main] UserCreateListener : Finished notifying user for userId = testUser1
2022-04-17 15:24:59.864 INFO 21545 --- [ main] UserCreateService : Add user done.

2. Demo-02：在Spring 4.2版本前，想要异步事件，需要额外定义BeanApplicationEventMulticaster：

@Configuration
public class AsynchronousSpringEventsConfig {@Bean(name = "applicationEventMulticaster")public ApplicationEventMulticaster simpleApplicationEventMulticaster() {SimpleApplicationEventMulticaster eventMulticaster = new SimpleApplicationEventMulticaster();eventMulticaster.setTaskExecutor(new SimpleAsyncTaskExecutor());return eventMulticaster;}
}
Test类：

@SpringBootTest
public class UserCreateServiceTest {@Autowiredprivate UserCreateService userCreateService;@Testpublic void addUserTest() {userCreateService.addUser("testUser1");ThreadUtils.sleep(5000L); //等5秒，为了等Listener执行完毕}
}

打印结果：可以看到Listener的代码是异步的，Add user done没有等到Listener代码执行后才打印，并且线程池名称也能看出Listener用的不是Main主线程：

2022-04-17 15:30:03.329 INFO 21549 --- [ main] UserCreateService : Start to add user.
2022-04-17 15:30:03.331 INFO 21549 --- [TaskExecutor-18] UserCreateListener : Start to notify user.
2022-04-17 15:30:03.331 INFO 21549 --- [ main] UserCreateService : Add user done.
2022-04-17 15:30:06.336 INFO 21549 --- [TaskExecutor-18] UserCreateListener : Finished notifying user for userId = testUser1

3. demo-03: Spring 4.2版本后，基于Annotation注解的事件驱动模型：

3.1 @EventListener

Listener不需要再实现接口ApplicationListener，而是可以直接在方法上加注解@EventListener:

@Slf4j
@Component
public class UserCreateListenerWithAnnotation {@EventListenerpublic void onApplicationEvent(UserCreateEvent userCreateEvent) {// 实现同UserCreateListener}
}
3.2 @Async

异步事件可以使用@Async注解：

@Slf4j
@Component
public class UserCreateListenerWithAnnotation {@Async@EventListenerpublic void onApplicationEvent(UserCreateEvent userCreateEvent) {// 实现同UserCreateListener}

使用@Async需要开启：@EnableAsync

@SpringBootApplication
@EnableAsync
public class SpringProjectApplication {public static void main(String[] args) {SpringApplication.run(SpringProjectApplication.class, args);}
}
3.3 Event类支持泛型，且不需要继承ApplicationEvent:

注：在做测试的时候，别忘记给新的GenericUserCreateEvent类加上Publisher。

@Getter
public class GenericUserCreateEvent<T> {private T userId;private boolean success;public GenericUserCreateEvent(T userId, boolean success) {this.userId = userId;this.success = success;}
}
3.4 Listener支持condition，使用SpEL表达式来定义触发的条件：

以下示例是condition结合支持泛型的Event类：

@Slf4j
@Component
public class UserCreateListenerWithAnnotation {@EventListener(condition = "#event.success")public void onApplicationEvent(GenericUserCreateEvent event) {String userId = (String)event.getUserId();log.info("Finished notifying user for userId = " + userId);}}

举例：

  • condition = "#event.success": 匹配event.getSuccess() == true时，才会触发。
  • condition = "#event.type eq 'email'": 匹配event.getType()等于email时，才会触发。
  • condition = "#event.type ne 'email'": 匹配event.getType()不等于email时，才会触发。

3.5 还可以监听多个事件：

@EventListener(classes = { ContextStartedEvent.class, ContextStoppedEvent.class })

4. 扩展

4.1 Spring自带的Event：

除了自定义Event类，Spring框架也定义了一系列的Event，我们可以自定义Listener来监听这些事件，例如：

  • ContextRefreshedEvent：执行了ConfigurableApplicationContext#refresh()方法
  • ContextStartedEvent：执行了ConfigurableApplicationContext#start()方法
  • ContextStoppedEvent：执行了ConfigurableApplicationContext#stop()方法
  • ContextClosedEvent：执行了ConfigurableApplicationContext#close()方法
4.2 @TransactionalEventListener

Spring 4.2版本后，新定义了一个注解叫@TransactionalEventListener，是@EventListener的扩展，从名字也可以看出，这个注解跟事务有关。

我们可以定义不同的phase（阶段）：

  1. AFTER_COMMIT (默认)：在事务成功提交后执行。
  2. AFTER_ROLLBACK：事件被rollback后执行。
  3. AFTER_COMPLETION – 事务完成后提交 (包含上述#1 #2两个阶段)。
  4. BEFORE_COMMIT：在事件提交前执行。

示例：

@Slf4j
@Service
public class UserCreateListenerTransaction {@TransactionalEventListener(phase = TransactionPhase.BEFORE_COMMIT)public void onApplicationEvent(GenericUserCreateEvent event) {// 实现同UserCreateListenerWithAnnotation}}

上述的Listener代码何时被触发？当publisher代码有事务被且将要被提交时才会触发。

Publisher示例，可以看到addUserOnlySuccessNotify方法需要加上@Transactional才可以触发上述的UserCreateListenerTransaction#onApplicationEvent()方法：

@Slf4j
@Service
public class UserCreateService {@Autowiredpublic ApplicationEventPublisher applicationEventPublisher;@Transactionalpublic boolean addUser(String userId) {log.info("Start to add user.");applicationEventPublisher.publishEvent(new GenericUserCreateEvent(userId, true));log.info("Add user done.");return true;}
}

执行Test类后，打印如下，注意打印顺序，addUser先执行后再执行Listener：

2022-04-17 17:41:31.334 INFO 21729 --- [ main] UserCreateService : Start to add user.
2022-04-17 17:41:31.335 INFO 21729 --- [ main] UserCreateService : Add user done.
2022-04-17 17:41:31.336 INFO 21729 --- [ main] UserCreateListenerTransaction : Start to notify user.
2022-04-17 17:41:34.341 INFO 21729 --- [ main] UserCreateListenerTransaction : Finished notifying user for userId = testUser2

也就是说，如果Publisher方法没有事务，Listener中的方法将不会被触发。除非加上fallbackExecution = true
即：

@TransactionalEventListener(phase = TransactionPhase.BEFORE_COMMIT, fallbackExecution = true)

改成上述的注解后，即便Publisher方法没有事务，Listener也会执行。


http://www.ppmy.cn/devtools/137876.html

相关文章

15 go语言（golang） - 并发编程goroutine原理及数据安全

15 go语言（golang） - 并发编程goroutine原理及数据安全

底层原理 Go 的 goroutine 是一种轻量级的线程实现&#xff0c;允许我们在程序中并发地执行函数。与传统的操作系统线程相比&#xff0c;goroutine 更加高效和易于使用。 轻量级调度 用户态调度&#xff1a;Go 运行时提供了自己的调度器&#xff0c;这意味着 goroutine 的创建…
阅读更多...
C++：探索哈希表秘密之哈希桶实现哈希

C++：探索哈希表秘密之哈希桶实现哈希

文章目录 前言一、链地址法概念二、哈希表扩容三、哈希桶插入逻辑四、析构函数五、删除逻辑六、查找七、链地址法代码实现总结 前言 前面我们用开放定址法代码实现了哈希表&#xff1a; C&#xff1a;揭秘哈希&#xff1a;提升查找效率的终极技巧_1 对于开放定址法来说&#…
阅读更多...
JavaScript 对象

JavaScript 对象

JavaScript 对象 一、对象是什么 JavaScript 对象是一种复合数据类型&#xff0c;它将相关的数据&#xff08;属性&#xff09;和操作这些数据的方法&#xff08;函数&#xff09;组合在一起。 二、特点 属性多样性&#xff1a;可以包含各种类型的数据作为属性。方法灵活性…
阅读更多...
自动控制原理——BliBli站_DR_CAN

自动控制原理——BliBli站_DR_CAN

自动控制 2 稳定性分析 极点在左半平面 输入为单位冲击&#xff0c;而拉普拉斯变换为1&#xff1b;因此&#xff0c;开环和闭环系统&#xff0c;研究其传递函数的稳定性就可以了 2.5_非零初始条件下的传递函数_含有初始条件的传递函数 如果一个系统的初始条件不为0&#xff0…
阅读更多...
蓝桥杯嵌入式入门指南-按键KEY(TIM6)【3】

蓝桥杯嵌入式入门指南-按键KEY(TIM6)【3】

在bsp文件夹中新建key.c和key.h PB0 PB1 PB2 PA0设置为GPIO_input&#xff0c;模式为上拉 打开TIM 输入频率/(PSC*Counter)中断频率 设置为1ms的中断 tips:一定要记得开NVIC中断 点击生成代码 将key.c添加到User文件夹 记得在all.h中添加key.h,tim.h头文件 key.c #include…
阅读更多...
【CSS】clip-path 属性（剪裁显示区域）

【CSS】clip-path 属性（剪裁显示区域）

文章目录 属性用法&#xff1a; 使用背景&#xff1a;遇到这样一个需求&#xff0c;嵌入一个网页到系统&#xff0c;但是不需要他顶部的导航栏&#xff0c;这时候就可以使用clip-path 属性剪裁到顶部导航栏&#xff0c;把网页相当于照片&#xff0c;把不想要的部分剪掉就好了 使…
阅读更多...
【机器学习】——朴素贝叶斯模型

【机器学习】——朴素贝叶斯模型

&#x1f4bb;博主现有专栏&#xff1a; C51单片机&#xff08;STC89C516&#xff09;&#xff0c;c语言&#xff0c;c&#xff0c;离散数学&#xff0c;算法设计与分析&#xff0c;数据结构&#xff0c;Python&#xff0c;Java基础&#xff0c;MySQL&#xff0c;linux&#xf…
阅读更多...
Java 异常处理

Java 异常处理

目录&#xff1a; 碎碎念&#xff1a; 题目&#xff1a; 问题描述 原因分析&#xff1a; 解决方案&#xff1a; 碎碎念&#xff1a; 我知道我是低代码&#xff0c;但是只是完成个作业&#xff0c;所以就随便写了&#xff0c;能过测试点就行&#xff0c;没想到有个测试点死…
阅读更多...
最新文章

Copyright @ 2022~2023