Spring Boot 中的事件发布与监听：深入理解 ApplicationEventPublisher（附Demo）

目录

  • 前言
  • 1. 基本知识
  • 2. Demo
  • 3. 实战代码

前言

🤟 找工作，来万码优才：👉 #小程序://万码优才/r6rqmzDaXpYkJZF

基本的Java知识推荐阅读：

  1. java框架 零基础从入门到精通的学习路线 附开源项目面经等（超全）
  2. 【Java项目】实战CRUD的功能整理（持续更新）

1. 基本知识

ApplicationEventPublisher 是 Spring 框架中一个功能接口（@FunctionalInterface），用于发布事件

是 Spring 的事件驱动模型的核心部分，开发者可以通过实现这个接口或通过 Spring 提供的现成实现来发布和管理事件

基本知识如下：

  1. 事件驱动模型：
    Spring 提供了一个内置的事件模型，通过事件发布者（ApplicationEventPublisher）和事件监听器（@EventListener 或 ApplicationListener）
    事件可以是框架提供的（例如：ContextRefreshedEvent），也可以是用户自定义的事件

  2. @FunctionalInterface 注解：
    声明此接口是函数式接口，只有一个抽象方法：publishEvent(Object event)
    可以使用 lambda 表达式或方法引用来实现

  3. 事件类型：
    支持两种事件对象：
    ApplicationEvent 类型
    非 ApplicationEvent 类型（会被包装成 PayloadApplicationEvent）

  4. 事件传播特点：
    异步/同步：事件的传播方式取决于事件监听器的实现，发布者本身不决定事件的执行方式
    高效性建议：事件监听器应尽量快速完成任务，对于耗时操作建议使用异步处理

主要方法解析

  1. publishEvent(ApplicationEvent event)
    接收 ApplicationEvent 类型事件
    实际是将事件转换为 Object 类型后调用 publishEvent(Object event) 方法
  2. publishEvent(Object event)
    接收任何对象类型的事件
    如果事件不是 ApplicationEvent 类型，会封装为 PayloadApplicationEvent

2. Demo

完整的可执行 Spring Boot 示例，展示了如何使用 ApplicationEventPublisher 实现事件发布和监听功能

这是一个基于 Spring Boot 核心功能的示例，无需 Spring Cloud

项目结构如下：

src/main/java/com/example/demo
    ├── DemoApplication.java
    ├── CustomEvent.java
    ├── CustomEventListener.java
    ├── EventPublisherService.java

截图如下：

在这里插入图片描述

主体流程如下：

+-----------------------+
|   DemoApplication     |   <--- 运行时触发事件发布
+-----------------------+
          |
          v
+----------------------------+   1. 通过依赖注入调用服务类
| EventPublisherService      |   
+----------------------------+
          |
          v
+-----------------------+     2. 使用 ApplicationEventPublisher 发布事件
| ApplicationEventPublisher |   -------> 发布 CustomEvent
+-----------------------+
          |
          v
+----------------------+
|     CustomEvent      |   <--- 发布事件包含消息
+----------------------+
          |
          v
+-----------------------+
|   CustomEventListener |
+-----------------------+
          |
          v
+-----------------------------+
| 打印 "Received custom event" |
+-----------------------------+
  1. DemoApplication (主类)
package com.example.demo;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
public class DemoApplication implements CommandLineRunner {

    @Autowired
    private EventPublisherService eventPublisherService;

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args);
    }

    @Override
    public void run(String... args) {
        // 发布自定义事件
        eventPublisherService.publishEvent("Hello, ApplicationEventPublisher!");
    }
}
  1. CustomEvent (事件类)
    继承自 ApplicationEvent
    可以封装任何自定义属性，例如 message
package com.example.demo;

import org.springframework.context.ApplicationEvent;

public class CustomEvent extends ApplicationEvent {

    private final String message;

    public CustomEvent(Object source, String message) {
        super(source);
        this.message = message;
    }

    public String getMessage() {
        return message;
    }
}
  1. CustomEventListener (事件监听器)
    使用 @EventListener 注解监听特定事件
    方法参数即为监听的事件类型
package com.example.demo;

import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;

@Component
public class CustomEventListener {

    @EventListener
    public void handleCustomEvent(CustomEvent event) {
        System.out.println("Received custom event: " + event.getMessage());
    }
}
  1. EventPublisherService (事件发布服务)
    用于在应用上下文中发布事件
    Spring 框架会自动分发事件到匹配的监听器
package com.example.demo;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.stereotype.Service;

@Service
public class EventPublisherService {

    @Autowired
    private ApplicationEventPublisher eventPublisher;

    public void publishEvent(String message) {
        // 构造并发布事件
        CustomEvent event = new CustomEvent(this, message);
        eventPublisher.publishEvent(event);
        System.out.println("Event published: " + message);
    }
}

运行 DemoApplication 后，控制台输出如下：

Event published: Hello, ApplicationEventPublisher!
Received custom event: Hello, ApplicationEventPublisher!

截图如下：

在这里插入图片描述

扩展功能

  1. 异步事件监听：在监听方法上加 @Async，并在主类中启用异步：
@SpringBootApplication
@EnableAsync
public class DemoApplication { ... }

  1. 多监听器：可以定义多个监听器监听相同事件，Spring 会自动分发到每个监听器

  2. 自定义事件的继承：可以继承 CustomEvent 定义不同类型的事件，以实现事件的多态性

3. 实战代码

比如发送邮件，如果单纯跟接口进行绑定，代码后续扩展优化会非常冗余！

使用 事件机制（applicationContext.publishEvent 和监听器）

有如下好处：

  1. 解耦业务逻辑
    通过事件机制，发送邮件的逻辑和业务逻辑分离：
    业务代码只需要关心触发“发送邮件”这一行为（发布事件）
    实际的邮件发送逻辑由监听器单独处理

这种解耦方式的优势：

  • 更清晰的代码职责：业务代码不会夹杂具体的邮件发送逻辑
  • 方便扩展：如果未来需要增加更多处理逻辑（如记录日志、重试机制等），可以直接扩展监听器，而不用修改业务代码

而且最主要的是：

  1. 支持异步操作
    在监听器上添加了 @Async 注解，可以让事件的处理逻辑异步执行：
@Async
@EventListener
public void onMessage(MailSendMessage message) {
    log.info("[onMessage][消息内容({})]", message);
    mailSendService.doSendMail(message);
}

这样，主线程可以迅速完成主要业务逻辑（如创建发送日志）并返回，而不用等待邮件发送完成

对于高并发场景，这种异步机制非常有用

如果直接在业务方法中调用发送函数，就无法方便地实现异步处理，可能会导致：

  • 性能问题：主线程被邮件发送操作阻塞
  • 用户体验问题：如果邮件发送需要较长时间，业务响应时间会变长
  1. 灵活性和可扩展性
    使用事件机制后，邮件发送的逻辑变成了“事件订阅者”：
    可以轻松增加或移除其他监听器，而不会影响现有的业务代码
    例如，除了发送邮件外，还可以添加监听器发送短信、推送通知、记录操作日志等
    可以根据不同的事件类型（不同的事件类）触发不同的逻辑

上述功能比较抽象，以实际代码为例：

如果做一个接口，发送邮件，信息量很大的时候，需要等这个邮件信息，待结果返回，才可以给客户！

  1. 发送邮件的代码和业务代码紧密耦合，修改或扩展会很麻烦
  2. 如果要实现异步发送，还需要自己额外管理线程池或异步任务，增加复杂度
  3. 如果未来需要在发送邮件时附加其他逻辑（如发送通知），业务代码会变得越来越复杂
public Long sendSingleMail(...) {
    ...
    // 直接发送邮件
    mailSendService.doSendMail(...);
    return sendLogId;
}

以下是结合ApplicationEventPublisher，下述代码以ruoyi-vue-pro代码为例子进行讲解

整体目录如下：

在这里插入图片描述

使用 @EventListener 注解监听特定事件

方法参数即为监听的事件类型
方法参数即为监听的事件类型
方法参数即为监听的事件类型

/**
 * 针对 {@link MailSendMessage} 的消费者
 */
@Component
@Slf4j
public class MailSendConsumer {

    @Resource
    private MailSendService mailSendService;

    @EventListener
    @Async // Spring Event 默认在 Producer 发送的线程，通过 @Async 实现异步
    public void onMessage(MailSendMessage message) {
        log.info("[onMessage][消息内容({})]", message);
        mailSendService.doSendMail(message);
    }

}

对应的实体类：

@Data
public class MailSendMessage {

    /**
     * 邮件日志编号
     */
    @NotNull(message = "邮件日志编号不能为空")
    private Long logId;
    /**
     * 接收邮件地址
     */
    @NotNull(message = "接收邮件地址不能为空")
    private String mail;
    /**
     * 邮件账号编号
     */
    @NotNull(message = "邮件账号编号不能为空")
    private Long accountId;

    /**
     * 邮件发件人
     */
    private String nickname;
    /**
     * 邮件标题
     */
    @NotEmpty(message = "邮件标题不能为空")
    private String title;
    /**
     * 邮件内容
     */
    @NotEmpty(message = "邮件内容不能为空")
    private String content;

//    private File files;

}

对应发送消息：

@Slf4j
@Component
public class MailProducer {

    @Resource
    private ApplicationContext applicationContext;

    /**
     * 发送 {@link MailSendMessage} 消息
     *
     * @param sendLogId 发送日志编码
     * @param mail 接收邮件地址
     * @param accountId 邮件账号编号
     * @param nickname 邮件发件人
     * @param title 邮件标题
     * @param content 邮件内容
     */
    public void sendMailSendMessage(Long sendLogId, String mail, Long accountId,
                                    String nickname, String title, String content) {
        MailSendMessage message = new MailSendMessage()
                .setLogId(sendLogId).setMail(mail).setAccountId(accountId)
                .setNickname(nickname).setTitle(title).setContent(content);
        applicationContext.publishEvent(message);
    }

}

实际主体代码是直接使用发送消息，不用对接接收消息，接收消息是直接监听就好！

业务逻辑代码：

在这里插入图片描述

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

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

DeepSeek 第二弹：Janus-Pro 文生图模型

DeepSeek 第二弹：Janus-Pro 文生图模型

最近&#xff0c;DeepSeek 可谓是科技圈的焦点&#xff0c;还火出了圈外&#xff0c;掀起了一场全民创作热潮。大家纷纷借助 DeepSeek R1 挥洒才情&#xff0c;实现诗人、小说家的梦想。然而&#xff0c;就在这场文字狂欢之际&#xff0c;DeepSeek 又悄然推出了一款重磅产品——…
阅读更多...
leetcode 2563. 统计公平数对的数目

leetcode 2563. 统计公平数对的数目

题目如下 数据范围 显然数组长度最大可以到10的5次方n方的复杂度必然超时&#xff0c;阅读题目实际上就是寻找两个位置不同的数满足不等式即可(实际上i j无所谓是哪个 我们只要把位置小的想成i就行)。 按照上面的思路我们只需要排序数组然后从前往后遍历数组然后利用二分查找…
阅读更多...
2024第十五届蓝桥杯网安赛道省赛题目--cc(CyberChef)/crypto

2024第十五届蓝桥杯网安赛道省赛题目--cc(CyberChef)/crypto

打开链接后是&#xff1a; 通过题目界面可以知道是AES加密&#xff0c;并且告诉我们key是gamelabgamelab&#xff0c;IV是gamelabgamelab&#xff0c;Mode是CBC模式&#xff0c;输入是flag&#xff0c;输出为Hex十六进制4da72144967f1c25e6273950bf29342aae635e2396ae17c80b1b…
阅读更多...
【视频+图文详解】HTML基础4-html标签的基本使用

【视频+图文详解】HTML基础4-html标签的基本使用

图文教程 html标签的基本使用 无序列表 作用&#xff1a;定义一个没有顺序的列表结构 由两个标签组成&#xff1a;<ul>以及<li>&#xff08;两个标签都属于容器级标签&#xff0c;其中ul只能嵌套li标签&#xff0c;但li标签能嵌套任何标签&#xff0c;甚至ul标…
阅读更多...
Python-基于PyQt5,wordcloud,pillow,numpy,os,sys等的智能词云生成器

Python-基于PyQt5,wordcloud,pillow,numpy,os,sys等的智能词云生成器

前言&#xff1a;日常生活中&#xff0c;我们有时后就会遇见这样的情形&#xff1a;我们需要将给定的数据进行可视化处理&#xff0c;同时保证呈现比较良好的量化效果。这时候我们可能就会用到词云图。词云图&#xff08;Word cloud&#xff09;又称文字云&#xff0c;是一种文…
阅读更多...
自制虚拟机(C/C++)(二、分析引导扇区，虚拟机读二进制文件img软盘)

自制虚拟机(C/C++)(二、分析引导扇区，虚拟机读二进制文件img软盘)

先修复上一次的bug&#xff0c;添加新指令&#xff0c;并增加图形界面 #include <graphics.h> #include <conio.h> #include <windows.h> #include <commdlg.h> #include <iostream> #include <fstream> #include <sstream> #inclu…
阅读更多...
工作流引擎Camunda

工作流引擎Camunda

一&#xff0c;什么是Camunda&#xff1f; Camunda是一个开源的工作流引擎和业务流程管理平台&#xff0c;基于Java和Spring框架构建。它支持BPMN 2.0标准&#xff0c;允许用户通过图形界面或编程方式定义复杂的工作流和业务流程。Camunda可以嵌入到任何Java应用程序中&#x…
阅读更多...
C++，STL，【目录篇】

C++，STL，【目录篇】

文章目录 一、简介二、内容提纲第一部分&#xff1a;STL 概述第二部分&#xff1a;STL 容器第三部分&#xff1a;STL 迭代器第四部分&#xff1a;STL 算法第五部分&#xff1a;STL 函数对象第六部分&#xff1a;STL 高级主题第七部分&#xff1a;STL 实战应用 三、写作风格四、…
阅读更多...
【已解决】黑马点评项目Redis版本替换过程的数据迁移

【已解决】黑马点评项目Redis版本替换过程的数据迁移

黑马点评项目Redis版本替换过程的数据迁移 【哭哭哭】附近商户中需要用到的GEO功能只在Redis 6.2以上版本生效 如果用的是老版本&#xff0c;美食/KTV的主页能正常返回&#xff0c;但无法显示内容 上次好不容易升到了5.0以上版本&#xff0c;现在又用不了了 Redis 6.2的windo…
阅读更多...
文献阅读 250201-The carbon budget of China: 1980–2021

文献阅读 250201-The carbon budget of China: 1980–2021

The carbon budget of China: 1980–2021 来自 <https://www.sciencedirect.com/science/article/pii/S2095927323007703> 中国碳预算&#xff1a;1980–2021 年 ## Abstract: Using state-of-the-art datasets and models, this study comprehensively estimated the an…
阅读更多...
《OpenCV》——图像透视转换

《OpenCV》——图像透视转换

图像透视转换简介 在 OpenCV 里&#xff0c;图像透视转换属于重要的几何变换&#xff0c;也被叫做投影变换。下面从原理、实现步骤、相关函数和应用场景几个方面为你详细介绍。 原理 实现步骤 选取对应点&#xff1a;要在源图像和目标图像上分别找出至少四个对应的点。这些对…
阅读更多...
条件变量 实现2生产者2消费者模型

条件变量 实现2生产者2消费者模型

1个生产者在生产的时候&#xff0c;另个生产者不能生产(生产者之间互斥) 条件变量用于线程同步&#xff0c;线程挂起/被唤醒。 条件变量和互斥锁共同保证生产者之间互斥生产者和消费者的同步。 思路&#xff1a; 1 定义、初始化共享资源 a 缓冲区&#xff1a;存储物品…
阅读更多...
一个开源 GenBI AI 本地代理（确保本地数据安全），使数据驱动型团队能够与其数据进行互动，生成文本到 SQL、图表、电子表格、报告和 BI

一个开源 GenBI AI 本地代理（确保本地数据安全），使数据驱动型团队能够与其数据进行互动，生成文本到 SQL、图表、电子表格、报告和 BI

一、GenBI AI 代理介绍&#xff08;文末提供下载&#xff09; github地址&#xff1a;https://github.com/Canner/WrenAI 本文信息图片均来源于github作者主页 在 Wren AI&#xff0c;我们的使命是通过生成式商业智能 &#xff08;GenBI&#xff09; 使组织能够无缝访问数据&…
阅读更多...
使用C#开发一款通用数据库管理工具

使用C#开发一款通用数据库管理工具

由于经常使用各种数据库&#xff0c;笔者自己动手丰衣足食&#xff0c;使用C#开发了一款通用数据库管理工具&#xff0c;支持Mysql、Oracle、Sqlite、SQL Server等数据库的表、视图、存储过程、函数管理功能&#xff0c;并支持导入导出、数据字典生成、拖拽式跨机器跨库数据一键…
阅读更多...
sqli-labs靶场通关

sqli-labs靶场通关

sqli-las通关 mysql数据库5.0以上版本有一个自带的数据库叫做information_schema,该数据库下面有两个表一个是tables和columns。tables这个表的table_name字段下面是所有数据库存在的表名。table_schema字段下是所有表名对应的数据库名。columns这个表的colum_name字段下是所有…
阅读更多...
DNS缓存详解（DNS Cache Detailed Explanation）

DNS缓存详解（DNS Cache Detailed Explanation）

DNS缓存详解 清空DNS缓存可以让网页访问更快捷。本文将从什么是DNS缓存、为什么清空DNS缓存、如何清空DNS缓存、清空DNS缓存存在的问题四个方面详细阐述DNS缓存清空的相关知识。 一、什么是DNS缓存 1、DNS缓存的定义&#xff1a; DNS缓存是域名系统服务在遇到DNS查询时自动…
阅读更多...
【VM】VirtualBox安装CentOS8虚拟机

【VM】VirtualBox安装CentOS8虚拟机

阅读本文前&#xff0c;请先根据 VirtualBox软件安装教程 安装VirtualBox虚拟机软件。 1. 下载centos8系统iso镜像 可以去两个地方下载&#xff0c;推荐跟随本文的操作用阿里云的镜像 centos官网&#xff1a;https://www.centos.org/download/阿里云镜像&#xff1a;http://…
阅读更多...
2024第十五届蓝桥杯网安赛道省赛题目--rc4

2024第十五届蓝桥杯网安赛道省赛题目--rc4

rc4 一、查壳 无壳&#xff0c;32位 二、IDA分析 1.main 2.sub_401005 根据题目以及该函数的内容都可以让我们确定这是个rc4加密题。 所以
阅读更多...
区块链项目孵化与包装设计：从概念到市场的全流程指南

区块链项目孵化与包装设计：从概念到市场的全流程指南

区块链技术的快速发展催生了大量创新项目&#xff0c;但如何将一个区块链项目从概念孵化成市场认可的产品&#xff0c;是许多团队面临的挑战。本文将从孵化策略、包装设计和市场落地三个维度&#xff0c;为你解析区块链项目成功的关键步骤。 一、区块链项目孵化的核心要素 明确…
阅读更多...
【机器学习】自定义数据集 使用scikit-learn中svm的包实现svm分类

【机器学习】自定义数据集 使用scikit-learn中svm的包实现svm分类

一、支持向量机(support vector machines. &#xff0c;SVM)概念 1. SVM 绪论 支持向量机&#xff08;SVM&#xff09;的核心思想是找到一个最优的超平面&#xff0c;将不同类别的数据点分开。SVM 的关键特点包括&#xff1a; ① 分类与回归&#xff1a; SVM 可以用于分类&a…
阅读更多...
最新文章

Copyright @ 2022~2023