Spring Boot框架强大的事件驱动模型(ApplicationEvent)

ops/2024/10/22 16:46:58/

文章目录

    • 前言
    • 应用场景
      • 异步处理
      • 事务边界外的操作
      • 跨微服务通信
      • 系统监控与日志聚合
      • UI更新
      • 生命周期管理
      • 工作流或业务流程
      • 缓存同步
    • 小试牛刀
      • 定义事件
      • 实现事件处理器
      • 注册事件处理器
      • 发布事件
      • 测试事件
    • 写在最后

前言

在Spring Boot应用中,事件处理器是指那些处理特定类型事件的对象。SpringBoot框架提供了强大的事件驱动模型(ApplicationEvent),允许应用程序组件之间通过发布和监听事件来进行松耦合的通信。在实际的生产场景中,我们可以使用事件进行缓存、邮件、日志解耦,从而提高系统性能。

应用场景

异步处理

当某个业务操作完成后,需要触发一系列耗时较长的后台任务(如发送邮件通知、更新缓存、清理资源、日志记录等),但又不想阻塞主线程或直接影响用户响应时间。此时,可以通过发布一个事件,由专门的异步事件处理器监听并执行这些任务。

事务边界外的操作

当某个业务操作在一个数据库事务内完成,而后续操作(如更新搜索索引、消息队列投递)需要在事务提交后进行,以避免数据不一致。可以在事务成功提交后发布一个事件,让监听器在事务外部处理这些后续操作。

跨微服务通信

在微服务体系中,不同的服务通常独立部署。当一个服务发生重要状态变更(如订单创建、用户注册、库存更新等)时,可以通过事件机制向其他服务广播事件,使它们能及时响应并更新自身状态,无需直接调用API。这符合“发布-订阅”模式,有助于降低服务间的耦合度。

系统监控与日志聚合

系统中的关键操作或异常情况可以触发特定事件,如性能指标收集、审计日志记录、报警触发等。事件处理器可以统一收集这些事件,将其发送到监控系统、日志平台或报警服务,实现系统的集中监控和日志分析。

UI更新

在Web应用中,尤其是单页应用(SPA)或使用WebSocket等技术实现实时通信的场景,前端界面需要对后端状态变化做出即时响应。后端可以发布事件通知前端更新特定区域的内容,如刷新用户通知列表、显示新消息提示等。

生命周期管理

Spring框架内部及用户自定义组件的生命周期事件也是Event Handler的典型应用场景。例如,Spring容器启动和关闭时会发布相关事件,允许开发者注册监听器来执行初始化配置、资源清理等工作。此外,对于自定义的领域对象,如用户账户的激活、注销等状态变更,也可以通过事件进行通知和处理。

工作流或业务流程

在复杂的业务流程中,如订单审批、文章审核等,每个步骤的完成可以触发事件,促使流程推进到下一个阶段。事件处理器负责检查条件、更新状态,并可能触发新的事件,从而驱动整个流程自动运行。

缓存同步

当主数据发生更改时,如数据库记录的增删改,可以通过事件通知缓存系统更新或失效相应的缓存项,确保数据一致性。
总结来说,Spring Event Handler适用于任何需要在不同组件、服务或层级之间解耦通信、异步处理任务或响应特定状态变更的场景,它有助于构建松耦合、响应式和灵活扩展的系统架构。

小试牛刀

以下是一个Spring Boot事件处理器的示例,我们可以在事件处理其中实现自己想要的逻辑代码。

定义事件

首先,定义一个自定义事件类,它通常继承自ApplicationEvent。例如,假设我们要创建一个表示用户注册成功的事件:

java">import org.springframework.context.ApplicationEvent;/*** UserRegisteredEvent* @author senfel* @version 1.0* @date 2024/4/25 16:38*/
public class UserRegisteredEvent extends ApplicationEvent {private final String username;public UserRegisteredEvent(Object source, String username) {super(source);this.username = username;}public String getUsername() {return username;}
}

这里,UserRegisteredEvent包含了注册成功的用户名信息。

实现事件处理器

创建一个实现了ApplicationListener接口的类,指定它监听的事件类型。在本例中,我们将创建一个监听UserRegisteredEvent的处理器:

java">import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;/*** UserRegisteredEventHandler* @author senfel* @version 1.0* @date 2024/4/25 16:39*/
@Component
public class UserRegisteredEventHandler implements ApplicationListener<UserRegisteredEvent> {@Overridepublic void onApplicationEvent(UserRegisteredEvent event) {String username = event.getUsername();System.out.println("User registered: " + username);// TODO 具体的业务,这里直接打印完成的信息System.out.println("business action complete: " + username);}
}

onApplicationEvent方法会在接收到匹配类型的事件时被调用。在这个示例中,我们只是简单地打印出已注册用户的用户名,并演示打印缓存结果。

注册事件处理器

由于UserRegisteredEventHandler是一个Spring Bean,只需将其纳入Spring容器管理,它就会自动成为事件监听器。通常,您可以通过@Component注解将其声明为一个Spring Bean,并确保该类所在的包(或指定的包)在Spring Boot主类的@SpringBootApplication注解扫描范围内。

java">import org.springframework.stereotype.Component;@Component
public class UserRegisteredEventHandler implements ApplicationListener<UserRegisteredEvent> {// ...
}

或者,如果您使用Java配置类,可以显式注册该监听器:

java">import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;@Configuration
public class AppConfig {@Beanpublic UserRegisteredEventHandler userRegisteredEventHandler() {return new UserRegisteredEventHandler();}
}

发布事件

当用户注册成功时,在相应的业务逻辑处发布UserRegisteredEvent。通常,您可以在服务层、控制器或其他适当的地方发布事件:

java">import com.example.ccedemo.event.UserRegisteredEvent;
import com.example.ccedemo.service.UserService;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.context.ApplicationEventPublisherAware;
import org.springframework.stereotype.Service;/*** UserServiceImpl* @author senfel* @version 1.0* @date 2024/4/25 16:45*/
@Service
public class UserServiceImpl implements UserService, ApplicationEventPublisherAware {private ApplicationEventPublisher publisher;@Overridepublic void getUsername(String username) {// 执行注册逻辑...System.out.println("User registered successfully: " + username);// 发布UserRegisteredEventpublisher.publishEvent(new UserRegisteredEvent(this, username));}@Overridepublic void setApplicationEventPublisher(ApplicationEventPublisher publisher) {this.publisher = publisher;}
}

上述代码中,UserService实现了ApplicationEventPublisherAware接口,Spring会自动注入ApplicationEventPublisher实例。在registerUser方法中,完成用户注册逻辑后,发布UserRegisteredEvent。此时,UserRegisteredEventHandler会接收到该事件并执行相应的处理逻辑。

测试事件

我们直接新增一个测试类调用获取用户信息方法:

java">import com.example.ccedemo.service.UserService;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import javax.annotation.Resource;/*** SpringEventTest* @author senfel* @version 1.0* @date 2024/4/25 16:49*/
@SpringBootTest
public class SpringBootEventTest {@Resourceprivate UserService userService;@Testpublic void test(){userService.getUsername("senfel");}
}

在这里插入图片描述

写在最后

总结起来,要创建一个Spring Boot事件处理器,需要:

1、定义一个继承自ApplicationEvent的自定义事件类;
2、实现一个ApplicationListener,指定监听的事件类型,并在onApplicationEvent方法中编写处理逻辑;
3、将事件处理器注册为Spring Bean,使其能自动监听发布的事件;
4、在适当的位置发布事件,通常使用ApplicationEventPublisher。

实际应用中,我们可以根据业务需求定义更多类型的事件和对应的处理器,利用事件驱动模型来解耦组件间的交互。


http://www.ppmy.cn/ops/21519.html

相关文章

SQLAlchemy的使用

SQLAlchemy中filter函数的使用 https://blog.csdn.net/m0_67093160/article/details/133318889 创建临时字段 select id , CONCAT(‘内容’) AS fullname from example_table; Pandas数据类型转换_pandas转换数据类型 https://blog.csdn.net/qq_41404557/article/details/125…

vue快速入门(四十二)ref与$refs的使用

注释很详细&#xff0c;直接上代码 上一篇 新增内容 使用ref标记元素或组件通过$refs获取元素或组件实例 源码 App.vue <template><div id"app"><!-- ref相当于为子组件或者元素绑定一个ref属性&#xff0c;然后通过this.$refs属性获取到对应的元素或…

Linux内核广泛采用的侵入式数据结构设计

Linux内核广泛采用的侵入式数据结构设计恐怕很难应用到一般程序开发中。基本上是个高维十字链表&#xff0c;一个节点(struct)可以同时位于多个hash/list/tree中。我分享下我的经历&#xff0c;我刚入行时遇到一个好公司和师父&#xff0c;给了我机会&#xff0c;一年时间从3k薪…

Kafka导航【Kafka】

Kafka导航【Kafka】 前言版权推荐Kafka随堂笔记 第三章 生产者3.4生产者分区3.4.1.分区好处3.4.2 生产者发送消息的分区策略3.4.3 自定义分区器 3.5 生产经验——生产者如何提高吞吐量3.6 生产经验——数据可靠性3.7 生产经验——数据去重3.7.1 数据传递语义3.7.2 幂等性3.7.3生…

一键设置jdk环境脚本

自动化脚本 一、使用方法 创建一个txt文本&#xff0c;放在和jdk存放的同一目录下&#xff0c;复制粘贴进我的代码&#xff0c;利用全局替换&#xff0c;将jdk1.8,改成你自己的jdk包名字&#xff0c;再重新把这个文件保存为.vbs文件。然后运行就行了 MsgBox "Runing s…

【HarmonyOS4学习笔记】《HarmonyOS4+NEXT星河版入门到企业级实战教程》课程学习笔记(二)

课程地址&#xff1a; 黑马程序员HarmonyOS4NEXT星河版入门到企业级实战教程&#xff0c;一套精通鸿蒙应用开发 &#xff08;本篇笔记对应课程第 3 - 4节&#xff09; P3《开发准备-了解ArkTS》 鸿蒙开发主要是用来开发移动端应用的。 以前我们开发移动端应用的代码&#xff…

(二十一)C++自制植物大战僵尸游戏僵尸游戏关卡结束数据处理

植物大战僵尸游戏开发教程专栏地址http://t.csdnimg.cn/8UFMs 文件位置 代码实现的文件在Class\Scenes\GameScene文件夹中,如下图所示。 GameEndLayer.h class GSGameEndLayer :public LayerColor { public:CREATE_FUNC(GSGameEndLayer);void successfullEntry();void brea…

用Python编写一个简单的数字累加器 数字累加器

目录 一.总体说明 二.完整代码 三.逐行分析 一.总体说明 数字累加器是一种用于对数字进行持续累加的设备或算法。它可以在每次输入一个数字时将其与之前的累加结果相加,并更新累加结果。数字累加器通常用于计算总和、平均值或其他需要对连续数字进行累加的应用场景。 在计…