【Spring源码】Spring Event事件

目录

1、前言

2、什么是Spring Event？

3、基本使用

3.1、定义事件

3.2、发布事件

3.3、监听事件

3.3.1、继承ApplicationListener

3.3.2、使用@EventListener注解

4、Spring Event是同步还是异步？

4.1、源码实现

4.2、如何实现异步

4.2.1、使用@Async注解

4.2.2、手动实现异步线程池

4.2.3、自定义ApplicationEventMulticaster

5、@TransactionalEventListener

5.1、基本使用

1、前言

事件发布/订阅机制在实际项目中很经常用到，一方面可以很容易让我们的代码进行解耦，另一方面可以很方便的进行一对一或一对多的消息通信，是一种常见的观察者设计模式，具有很好的扩展性。今天就来讲一下Spring的事件机制。

2、什么是Spring Event？

Spring框架中的事件是一种观察者设计模式的实现，用于在应用程序中处理各种状态变化。事件驱动编程是一种流行的编程范式，其中组件之间的通信是通过事件（或消息）进行的。Spring的事件机制允许对象在状态发生变化时发布事件，其他对象则可以订阅这些事件并在事件发生时执行特定的操作。

3、基本使用

Spring Event的使用基本有以下几个步骤：定义事件，发布事件，监听事件。

3.1、定义事件

先定义一个事件Event，继承Spring的ApplicationEvent，声明构造函数将需要传递的事件信息包装为业务事件类。如：

/*** 这里定义事件DamIllegalDataEvent。*/
public class DamIllegalDataEvent extends ApplicationEvent {// 声明构造函数，接收DamIllegalDataDto集合传递到事件中public DamIllegalDataEvent(List<DamIllegalDataDto> list) {super(list);}
}

3.2、发布事件

发布事件时可以注入ApplicationEventPublisher，也可以获取到ApplicationContext，然后调用publisherEvent()方法推送事件。

@RestController
@RequestMapping("anno/dam")
public class DamTestController {@Autowiredprivate ApplicationEventPublisher applicationPushBuilder;@GetMapping("test_audit")public String test_audit(){DamIllegalDataDto build = DamIllegalDataDto.builder().illegalData("11111").source("2222").functionDesc("数据清理中错误了").functionName("333").build();// 注入applicationPushBuilderapplicationPushBuilder.publishEvent(new DamIllegalDataEvent(Collections.singletonList(build)));// 这里也可以直接使用hutool工具类直接发布SpringUtil.publishEvent(new DamIllegalDataEvent(Collections.singletonList(build)));return "ok";}
}

3.3、监听事件

监听事件也可称为订阅事件，即当事件发布了之后，需要监听该事件并进行消费。Spring里面提供了两种事件订阅的方式：

  • 继承ApplicationListener，并实现onApplicationEvent方法。
  • 使用@EventListener注解方法。

3.3.1、继承ApplicationListener

创建一个监听器DamIllegalDataEventListener继承ApplicationListener，通过泛型指定需要监听的事件类。如：

@Slf4j
@Component
public class DamIllegalDataEventListener implements ApplicationListener<DamIllegalDataEvent> {@Autowiredprivate DamIllegalDataAuditService damIllegalDataAuditService;@Overridepublic void onApplicationEvent(DamIllegalDataEvent event) {LOGGER.info("异常数据审计事件开始执行...");List<DamIllegalDataDto> damIllegalDataDtos = (List<DamIllegalDataDto>) event.getSource();// todo......doSomething();}
}

3.3.2、使用@EventListener注解

使用@EventListener注解方法，将其包装为事件处理器。它适用于：1. 不想为每个事件处理都创建一个ApplicationListener实现类；2. 希望支持更复杂的事件条件过滤。@EventListener的classes属性可以过滤事件类型，而condition属性可以根据事件对象是否满足条件表达式来过滤事件。

@Slf4j
@Component
public class DamIllegalDataEventListener {/*** EventListener注解定义事件处理器，并指定监听事件为DamIllegalDataEvent。* condition声明只有事件的code==200时，才进入该事件*/@EventListener(classes = {DamIllegalDataEvent.class}, condition="#event.code==200")public void onApplicationEvent(DamIllegalDataEvent event) {LOGGER.info("异常数据审计事件开始执行...");List<DamIllegalDataDto> damIllegalDataDtos = (List<DamIllegalDataDto>) event.getSource();// todo......doSomething();}
}

4、Spring Event是同步还是异步？

默认情况下 Spring Event是同步执行的。你怎么这么确定？我们先来演示下上面的demo。先实现一个测试接口，该接口发布了一个事件，发布完后打印一行日志：

@GetMapping("test_audit")
public String test_audit(){DamIllegalDataDto build = DamIllegalDataDto.builder().illegalData("11111").source("2222").functionDesc("数据清理中错误了").functionName("333").build();SpringUtil.publishEvent(new DamIllegalDataEvent(Collections.singletonList(build)));System.out.println("接口请求完成......");return "ok";
}

事件监听中打印一行日志，并睡眠5s：

@Slf4j
@Component
public class DamIllegalDataEventListener implements ApplicationListener<DamIllegalDataEvent> {@Overridepublic void onApplicationEvent(DamIllegalDataEvent event) {LOGGER.info("异常数据审计事件开始执行...");ThreadUtil.sleep(5000);}
}

执行查看结果，可以发现不管如何请求，日志打印总是按顺序执行，并且会间隔5S。

4.1、源码实现

如果还是不信？那我们来看源码：org.springframework.context.ApplicationEventPublisher#publishEvent(java.lang.Object)，断点跟进到org.springframework.context.support.AbstractApplicationContext#publishEvent(java.lang.Object, org.springframework.core.ResolvableType)。

protected void publishEvent(Object event, @Nullable ResolvableType eventType) {// 包装ApplicationEventApplicationEvent applicationEvent;if (event instanceof ApplicationEvent) {applicationEvent = (ApplicationEvent) event;}else {applicationEvent = new PayloadApplicationEvent<>(this, event);if (eventType == null) {eventType = ((PayloadApplicationEvent<?>) applicationEvent).getResolvableType();}}// 考虑到部分事件在Listener注册之前就发布了，因此先保存起来if (this.earlyApplicationEvents != null) {this.earlyApplicationEvents.add(applicationEvent);}else {// 重点是这里// 铜通过getApplicationEventMulticaster()获取事件发布器；// 调用multicastEvent方法发布事件getApplicationEventMulticaster().multicastEvent(applicationEvent, eventType);}// 同时给父容器发布事件if (this.parent != null) {if (this.parent instanceof AbstractApplicationContext) {((AbstractApplicationContext) this.parent).publishEvent(event, eventType);}else {this.parent.publishEvent(event);}}
}

跟进multicastEvent()方法，org.springframework.context.event.SimpleApplicationEventMulticaster#multicastEvent(org.springframework.context.ApplicationEvent, org.springframework.core.ResolvableType)：

@Override
public void multicastEvent(final ApplicationEvent event, @Nullable ResolvableType eventType) {ResolvableType type = (eventType != null ? eventType : resolveDefaultEventType(event));Executor executor = getTaskExecutor();for (ApplicationListener<?> listener : getApplicationListeners(event, type)) {// 这里可以看出，如果有指定任务执行器，那么就异步执行；否则直接调用，也就是同步执行。if (executor != null) {executor.execute(() -> invokeListener(listener, event));}else {invokeListener(listener, event);}}
}

4.2、如何实现异步

实现异步方式，可以有3中实现：

  • 使用@Async 注解
  • 手动实现异步线程池
  • 自定义ApplicationEventMulticaster

4.2.1、使用@Async注解

使用这个很简单，只要在事件监听方法上添加@Async注解即可，springboot的启动器需要开启异步@EnableAsync。

@Async
@Override
public void onApplicationEvent(DamIllegalDataEvent event) {LOGGER.info("异常数据审计事件开始执行...");ThreadUtil.sleep(5000);
}

注意：

使用@Async时，最好自己配置相应的线程池核心数以及延迟队列等等。由于Spring中使用@Async异步线程每次都会创建一个新线程执行，如果滥用 它，可能会有内存问题。

4.2.2、手动实现异步线程池

顾名思义就是手动创建一个线程池执行，与@Async类似。

@Slf4j
@Component
public class DamIllegalDataEventListener implements ApplicationListener<DamIllegalDataEvent> {@Overridepublic void onApplicationEvent(DamIllegalDataEvent event) {ThreadUtil.execAsync(() -> {LOGGER.info("异常数据审计事件开始执行...");ThreadUtil.sleep(5000);});}
}

4.2.3、自定义ApplicationEventMulticaster

由于Spring容器会优先使用beanName为applicationEventMulticater 的bean作为事件转发处理器，如果不存在则默认使用SimpleApplicationEventMulticaster作为事件转发处理器，它默认是同步执行的。但它支持设置Executor，那么我们可以将自定义的线程池处理器作为Executor，以此来支持异步执行。

@Configuration
public class DamEventConfig {@Bean(AbstractApplicationContext.APPLICATION_EVENT_MULTICASTER_BEAN_NAME)public SimpleApplicationEventMulticaster eventMulticaster(){SimpleApplicationEventMulticaster simpleApplicationEventMulticaster = new SimpleApplicationEventMulticaster();simpleApplicationEventMulticaster.setTaskExecutor(taskExecutor());return simpleApplicationEventMulticaster;}/*** 目前服务器为8c，默认给他4个，一般事件推送的情况不会多。如果多的话，请检查一下业务使用* @return*/@Beanpublic TaskExecutor taskExecutor(){ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();executor.setCorePoolSize(4);return executor;}
}

配置完之后，事件监听那边都无需修改。

注意：

这种方式的配置是全局性的，一旦配置了之后，所有的事件都是异步的形式处理。如果需要个别业务是同步的，那么此种方式要特别注意。

5、@TransactionalEventListener

提到事件，这里再提一个注解@TransactionalEventListener，也即感知事务，基于事件形式与事务的某个阶段进行绑定。比如在事务提交之前或之后进行一些业务的处理，如短信提醒等等。@TransactionEventListener允许事件处理方法感知事务。它的phase属性，表示希望在事务的哪个阶段执行事件处理。

@Target({ElementType.METHOD, ElementType.ANNOTATION_TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@EventListener
public @interface TransactionalEventListener {/*** Phase to bind the handling of an event to.* <p>The default phase is {@link TransactionPhase#AFTER_COMMIT}.* <p>If no transaction is in progress, the event is not processed at* all unless {@link #fallbackExecution} has been enabled explicitly.*/TransactionPhase phase() default TransactionPhase.AFTER_COMMIT;/*** Whether the event should be handled if no transaction is running.*/boolean fallbackExecution() default false;/*** Alias for {@link #classes}.*/@AliasFor(annotation = EventListener.class, attribute = "classes")Class<?>[] value() default {};/*** The event classes that this listener handles.* <p>If this attribute is specified with a single value, the annotated* method may optionally accept a single parameter. However, if this* attribute is specified with multiple values, the annotated method* must <em>not</em> declare any parameters.*/@AliasFor(annotation = EventListener.class, attribute = "classes")Class<?>[] classes() default {};/*** Spring Expression Language (SpEL) attribute used for making the event* handling conditional.* <p>The default is {@code ""}, meaning the event is always handled.* @see EventListener#condition*/@AliasFor(annotation = EventListener.class, attribute = "condition")String condition() default "";/*** An optional identifier for the listener, defaulting to the fully-qualified* signature of the declaring method (e.g. "mypackage.MyClass.myMethod()").* @since 5.3* @see EventListener#id* @see TransactionalApplicationListener#getListenerId()*/@AliasFor(annotation = EventListener.class, attribute = "id")String id() default "";}

TransactionPhase枚举声明了事务提交的各个阶段：

public enum TransactionPhase {/*** Handle the event before transaction commit.* @see TransactionSynchronization#beforeCommit(boolean)*/BEFORE_COMMIT,/*** Handle the event after the commit has completed successfully.* <p>Note: This is a specialization of {@link #AFTER_COMPLETION} and therefore* executes in the same sequence of events as {@code AFTER_COMPLETION}* (and not in {@link TransactionSynchronization#afterCommit()}).* <p>Interactions with the underlying transactional resource will not be* committed in this phase. See* {@link TransactionSynchronization#afterCompletion(int)} for details.* @see TransactionSynchronization#afterCompletion(int)* @see TransactionSynchronization#STATUS_COMMITTED*/AFTER_COMMIT,/*** Handle the event if the transaction has rolled back.* <p>Note: This is a specialization of {@link #AFTER_COMPLETION} and therefore* executes in the same sequence of events as {@code AFTER_COMPLETION}.* <p>Interactions with the underlying transactional resource will not be* committed in this phase. See* {@link TransactionSynchronization#afterCompletion(int)} for details.* @see TransactionSynchronization#afterCompletion(int)* @see TransactionSynchronization#STATUS_ROLLED_BACK*/AFTER_ROLLBACK,/*** Handle the event after the transaction has completed.* <p>For more fine-grained events, use {@link #AFTER_COMMIT} or* {@link #AFTER_ROLLBACK} to intercept transaction commit* or rollback, respectively.* <p>Interactions with the underlying transactional resource will not be* committed in this phase. See* {@link TransactionSynchronization#afterCompletion(int)} for details.* @see TransactionSynchronization#afterCompletion(int)*/AFTER_COMPLETION
}

5.1、基本使用

在含有事务的方法里发布事件：

@Transactional(rollbackFor = Exception.class)
public void test(){DamIllegalDataAudit audit = new DamIllegalDataAudit();audit.setId("1726931543097610240");audit.setRemark("xxx");this.baseMapper.updateById(audit);DamIllegalDataDto build = DamIllegalDataDto.builder().illegalData("11111").source("2222").functionDesc("数据清理中错误了").functionName("333").build();applicationEventPublisher.publishEvent(new DamIllegalDataEvent(Collections.singletonList(build)));
}

定义感知事务监听：

@Component
public class TransactionalEventProcess {@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT)public void afterCommit(DamIllegalDataEvent event){System.out.println("事务提交后事件处理");}@TransactionalEventListener(phase = TransactionPhase.AFTER_ROLLBACK)public void afterRollback(DamIllegalDataEvent event){System.out.println("事务回滚后事件处理");}
}

当执行事务方法时候，可以发现：

注意：

如果事件自定义了ApplicationEventMulticaster，让事件变成异步，那么该感知事务会失效。

但是如果使用@Async或手动定义了 异步线程池ThreadUtil.execAsync还是可以生效的。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.rhkb.cn/news/202654.html

如若内容造成侵权/违法违规/事实不符，请联系长河编程网进行投诉反馈email:809451989@qq.com，一经查实，立即删除！

相关文章

【差分放大电路分析】2021-12-31

【差分放大电路分析】2021-12-31

缘由有哪位愿意帮助一下的-嵌入式-CSDN问答 截图&#xff0c;数值自己去计算。上2图是接电阻&#xff0c;下2图是接三极管。
阅读更多...
DNS 区域传输 （AXFR）

DNS 区域传输 （AXFR）

漏洞描述 docker环境搭建 使用 AXFR 协议的 DNS 区域传输是跨 DNS 服务器复制 DNS 记录的最简单机制。为了避免在多个 DNS 服务器上编辑信息&#xff0c;可以在一台服务器上编辑信息&#xff0c;并使用 AXFR 将信息复制到其他服务器。但是&#xff0c;如果您不保护您的服务器&…
阅读更多...
Javascript每天一道算法题（十八）——矩阵置零-中等

Javascript每天一道算法题（十八）——矩阵置零-中等

文章目录 1、问题2、示例3、解决方法&#xff08;1&#xff09;方法1——标记数组 1、问题 给定一个 y x x 的矩阵&#xff0c;如果一个元素为 0 &#xff0c;则将其所在行和列的所有元素都设为 0 。请使用 原地 算法。 2、示例 示例 1&#xff1a; 输入&#xff1a;matrix [[…
阅读更多...
Centos 7、Debian、Ubuntu中tree指令的检查与下载

Centos 7、Debian、Ubuntu中tree指令的检查与下载

目录 前言 Centos 7中检查tree指令是否安装的两种办法 which指令检查 查看当前版本指令 不同版本下安装tree指令 Centos 7的发行版本 重点 Debian的发行版本 重点 Ubuntu的发行版本 重点 前言 在大多数Linux发行版中&#xff0c;tree命令通常不是默认安装的指令。…
阅读更多...
Python|合并两个字典的8种方法

Python|合并两个字典的8种方法

在Python中&#xff0c;有多种方法可以通过使用各种函数和构造函数来合并字典。在本文中&#xff0c;我们将讨论一些合并字典的方法。 1. 使用方法update() 通过使用Python中的update()方法&#xff0c;可以将一个列表合并到另一个列表中。但是在这种情况下&#xff0c;第二个…
阅读更多...
Linux-基本指令（1.0）

Linux-基本指令（1.0）

Linux是一个非常流行的操作的知识&#xff0c;并提供实例帮助读者更好地理解。让我们一起来学习吧&#xff01;系统&#xff0c;也是云计算、大数据、人工智能等领域的重要基础。学习Linux命令是Linux系统管理的基础&#xff0c;也是开发过程中必不可少的技能。本博客将介绍Lin…
阅读更多...
springboot+vue基本微信小程序的旅游社系统

springboot+vue基本微信小程序的旅游社系统

项目介绍 现今市面上有关于旅游信息管理的微信小程序还是比较少的&#xff0c;所以本课题想对如今这么多的旅游景区做一个收集和分类。这样可以给身边喜欢旅游的朋友更好地推荐分享适合去旅行的地方。 前端采用HTML架构&#xff0c;遵循HTMLss JavaScript的开发方式&#xff0…
阅读更多...
学C的第十一天【查看汇编代码一步步了解 函数栈帧(栈区局部变量)的创建和销毁】

学C的第十一天【查看汇编代码一步步了解 函数栈帧(栈区局部变量)的创建和销毁】

相关代码gitee自取&#xff1a;C语言学习日记: 加油努力 (gitee.com) 接上期&#xff1a;学C的第十天&#xff08;继续深入学习函数、函数递归、练习&#xff09;-CSDN博客 函数栈帧的创建和销毁 越高级的编译器&#xff0c;越不容易学习和观察该过程 同时在不同的编译器下&…
阅读更多...
前缀和——238. 除自身以外数组的乘积

前缀和——238. 除自身以外数组的乘积

文章目录 &#x1f377;1. 题目&#x1f378;2. 算法原理&#x1f365;解法一&#xff1a;暴力求解&#x1f365;解法二&#xff1a;前缀和&#xff08;积&#xff09; &#x1f379;3. 代码实现 &#x1f377;1. 题目 题目链接&#xff1a;238. 除自身以外数组的乘积 - 力扣&a…
阅读更多...
我在electron中集成了自己的ai大模型

我在electron中集成了自己的ai大模型

同学们可以私信我加入学习群&#xff01; 正文开始 前言一、大模型选择二、获取key三、调用api四、调用ai模型api时&#xff0c;解决跨域总结 前言 最近单位把gpt、文心一言、通义千问、星火等等等等你能想到的ai大模型都给禁掉了&#xff0c;简直丧心病狂。 不知道有多少感同…
阅读更多...
leetcode 343.整数拆分 198.打家劫舍（动态规划）

leetcode 343.整数拆分 198.打家劫舍（动态规划）

OJ链接 &#xff1a;leetcode 343.整数拆分 代码&#xff1a; class Solution {public int integerBreak(int n) {int[] dp new int[n1];//每个n&#xff0c;拆分多个整数乘积的最大值dp [0] 0;dp [1] 1; for(int i 2 ; i<n; i){for(int j 0 ; j < i; j){dp[i] Ma…
阅读更多...
【JavaEE初阶】 网络编程基础与Socket套接字

【JavaEE初阶】 网络编程基础与Socket套接字

文章目录 &#x1f38b;网络编程基础&#x1f6a9;为什么需要网络编程&#xff1f;&#x1f6a9;什么是网络编程&#xff1f;&#x1f6a9;网络编程中的基本概念&#x1f4cc;发送端和接收端&#x1f4cc;请求和响应&#x1f4cc;客户端和服务端&#x1f4cc;常见的客户端服务端…
阅读更多...
03. Python中的语句

03. Python中的语句

1、前言 在《Python基础数据类型》一文中&#xff0c;我们了解了Python中的基础数据类型&#xff0c;今天我们继续了解下Python中的语句和函数。 2、语句 在Python中常用的语句可以大致分为两类&#xff1a;条件语句、循环语句。 2.1、条件语句 条件语句就是我们编码时常见…
阅读更多...
基于Haclon的Blob分析

基于Haclon的Blob分析

任务要求&#xff1a; 请用BLOB分析的方法计算图中所有灰度值在120和255之间的像素构成的8连通区域的面积与中心点坐标。 Blob基础&#xff1a; 分析过程&#xff1a;首先获取图像&#xff0c;然后根据特征对原始图像进行阈值分割&#xff08;区分背景像素和前景像素&#xf…
阅读更多...
openstack（2）

openstack（2）

目录 块存储服务 安装并配置控制节点 安装并配置一个存储节点 验证操作 封装镜像 上传镜像 块存储服务 安装并配置控制节点 创建数据库 [rootcontroller ~]# mysql -u root -pshg12345 MariaDB [(none)]> CREATE DATABASE cinder; MariaDB [(none)]> GRANT ALL PR…
阅读更多...
Git工作流和Commit规范

Git工作流和Commit规范

Git大家都非常熟悉了&#xff0c;就不做过多介绍&#xff0c;但是如何用好Git、如何进行合理的分支开发、Merge你是否有一个规范流程呢&#xff1f;&#x1f4a4; 不论是一个团队一起开发一个项目&#xff0c;还是自己独立开发一个项目&#xff0c;都少不了要和Git打交道&…
阅读更多...
AI赋能数据表设计

AI赋能数据表设计

数据表设计软件用过多种&#xff0c;用Ai 设计表几年Ai大模型爆发之后提升了新的高度 用navicat 设计表就是在跟团队的人介绍这次功能的表结构时&#xff0c;没办法看备注&#xff0c;只能看英文字段&#xff0c;导致在比较复杂的表中&#xff0c;总是在表结构和图形结构中来回…
阅读更多...
网络和Linux网络_4(应用层)序列化和反序列化(网络计算器)

网络和Linux网络_4(应用层)序列化和反序列化(网络计算器)

目录 1. 重新理解协议 2. 网络版本计算器 2.1 前期封装 Log.hpp sock.hpp TcpServer.hpp 第一次测试(链接) 2.2 计算器实现 第二次测试(序列化和反序列化) 第三次测试(客户端字节流) CalServer.cc CalClient.cc 3. 守护进程 3.1 守护进程和前后台进程 3.1 变成…
阅读更多...
zlmediakit实现rtsp流服务器

zlmediakit实现rtsp流服务器

本次实现是将内存中的H264数据经过zlmediakit实现为rtsp流。 我是用的是CAPI的方式&#xff0c;将zlmediakit作为一个sdk嵌入到自己的程序中而不是作为一个独立的进进程服务。 1.编译完成zkmedialit后会得到bin include lib三个文件夹如图 其中bin中的MediaServer是作为独立的…
阅读更多...
二蛋赠书八期：《Java物联网、人工智能和区块链编程实战》

二蛋赠书八期：《Java物联网、人工智能和区块链编程实战》

前言 大家好&#xff01;我是二蛋&#xff0c;一个热爱技术、乐于分享的工程师。在过去的几年里&#xff0c;我一直通过各种渠道与大家分享技术知识和经验。我深知&#xff0c;每一位技术人员都对自己的技能提升和职业发展有着热切的期待。因此&#xff0c;我非常感激大家一直…
阅读更多...
最新文章
推荐文章

Copyright @ 2022~2023