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

ops/2024/11/30 0:34:49/

事件驱动设计模式，也可能通过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/ops/137783.html

相关文章

LeetCode 力扣 热题 100道（十）回文链表（C++）

LeetCode 力扣 热题 100道（十）回文链表（C++）

回文链表 给你一个单链表的头节点 head &#xff0c;请你判断该链表是否为回文链表。如果是&#xff0c;返回 true &#xff1b;否则&#xff0c;返回 false 。 回文序列&#xff1b;回文 序列是向前和向后读都相同的序列。 /*** Definition for singly-linked list.* struct…
阅读更多...
国产FPGA+DSP 双FMC 6U VPX处理板

国产FPGA+DSP 双FMC 6U VPX处理板

高性能国产化信号处理平台采用6U VPX架构&#xff0c;双FMC接口国产V7 FPGA 国产多核 DSP 的硬件架构&#xff0c;可以完成一体化电子系统、有源相控阵雷达、电子侦察、MIMO 通信、声呐等领域的高速实时信号处理。 信号处理平台的组成框图如图 1 所示&#xff0c; DSP处理器采…
阅读更多...
【网络安全 | 漏洞挖掘】绕过SAML认证获得管理员面板访问权限

【网络安全 | 漏洞挖掘】绕过SAML认证获得管理员面板访问权限

未经许可，不得转载。 文章目录 什么是SAML认证？SAML是如何工作的？SAML响应结构漏洞结果什么是SAML认证？ SAML（安全断言标记语言）用于单点登录（SSO）。它是一种功能，允许用户在多个服务之间切换时无需多次登录。例如，如果你已经登录了facebook.com，就不需要再次输入凭…
阅读更多...
路由策略与路由控制实验

路由策略与路由控制实验

AR1、AR2、AR3在互联接口、Loopback0接口上激活OSPF。AR3、AR4属于IS-IS Area 49.0001&#xff0c;这两者都是Level-1路由器&#xff0c;AR3、AR4的系统ID采用0000.0000.000x格式&#xff0c;其中x为设备编号 AR1上存在三个业务网段A、B、C&#xff08;分别用Loopback1、2、3接…
阅读更多...
【附录】Rust国内镜像设置

【附录】Rust国内镜像设置

目录 前言 &#xff08;1&#xff09;设置环境变量 &#xff08;2&#xff09;安装Rust &#xff08;3&#xff09;设置crates镜像 前言 本节课来介绍下如何在国内高速下载安装Rust和Rust依赖&#xff0c;由于网络原因&#xff0c;我们在安装Rust和下载项目依赖时都很慢&am…
阅读更多...
PostgreSQL 9.4 引入的一个特性生成列（Generated Columns）

PostgreSQL 9.4 引入的一个特性生成列（Generated Columns）

Generated Columns&#xff08;生成列&#xff09;是 PostgreSQL 9.4 引入的一个特性&#xff0c;它允许你在表中定义一个列&#xff0c;其值是根据其他列的值自动计算生成的。 以下是关于 PostgreSQL 生成列的一些要点&#xff1a; 一、定义生成列 语法如下&#xff1a; CR…
阅读更多...
vue基础之1：Vue简介

vue基础之1：Vue简介

欢迎来到“雪碧聊技术”CSDN博客&#xff01; 在这里&#xff0c;您将踏入一个专注于Java开发技术的知识殿堂。无论您是Java编程的初学者&#xff0c;还是具有一定经验的开发者&#xff0c;相信我的博客都能为您提供宝贵的学习资源和实用技巧。作为您的技术向导&#xff0c;我将…
阅读更多...
实现实时CPS安全的动态目标防御

实现实时CPS安全的动态目标防御

论文标题&#xff1a;Enabling Moving Target Defense for Real-Time CPS Security&#xff08;实现实时CPS安全的动态目标防御&#xff09; 作者信息&#xff1a; Rajarshi Mukherjee&#xff0c;弗吉尼亚理工大学&#xff0c;电气与计算机工程系&#xff0c;阿灵顿&#xf…
阅读更多...
最新文章

Copyright @ 2022~2023