Spring事件监听基本原理与使用详解

 更新时间:2024年01月27日 09:48:31   作者:魅Lemon  
这篇文章主要介绍了Spring事件监听基本原理与使用详解,Spring的事件监听机制和发布订阅机制是很相似的:发布了一个事件后,监听该类型事件的所有监听器会触发相应的处理逻辑,需要的朋友可以参考下

一、简介

1、Spring事件监听基本原理

Spring的事件监听机制和发布订阅机制是很相似的:发布了一个事件后,监听该类型事件的所有监听器会触发相应的处理逻辑。

正如Spring官方文档上所说的,整个上就是一个观察者的模式。那么,我们不妨猜测下,Spring是如何来实现事件发布监听的:底层使用一个集合存储了所有的监听器,当发布了一个事件后,遍历事件监听器集合,然后过滤符合事件类型的监听器,最后触发相应的事件处理逻辑。

2、Spring中事件监听的相关规范

在Spring中,事件监听机制主要涉及到了一下几个关键的规范(抽象类及接口):ApplicationEvent、ApplicationListener、ApplicationEventPublisher

  • ApplicationEvent: Spring的事件是符合jdk的规范的,这个抽象类继承了jdk内置的事件规范类EventObject(即jdk建议所有的事件都继承EventObject这个类)。ApplicationEvent是Spring家的事件规范。所以我们在自定义事件的时候,可以继承与ApplicationEvent,比如,Spring家自己关于容器上下文事件就又定义了一个容器上下文的时间规范ApplicationContextEvent,它同样是继承于ApplicationEvent的,只不过扩充了获取发出事件容器的方法;今后,我们同样可以在继承于ApplicationEvent的基础上定义自己的事件规范。
  • ApplicationListener:这是一个函数式接口,同样时事件监听器的规范,当监听到自己监听的事件类型时就会调用onApplicationEvent方法来执行监听逻辑
  • ApplicationEventPublisher:这同样是一个函数式接口,定义了事件发布的规范,任何的事件发布器ApplicationEventPublisher都是通过调用publishEvent来进行事件的发布

二、Spring事件监听器的使用

1、自定义事件创建

在Spring中,所有的事件需要继承自ApplicationEvent,自定义事件的不同可以监听多个,一个最基础的MsgEvent如下

public class MyEvent extends ApplicationEvent {
    private String msg;
    // 必须继承实现
    public MyEvent(Object source, String msg) {
        super(source);
        this.msg = msg;
    }
    @Override
    public String toString() {
        return "MyEvent{" +
                "msg='" + msg + '\'' +
                '}';
    }
}

2、自定义监听器

2.1 方法介绍

springboot进行事件监听有四种方式,选择任意一种即可

  • 将监听器装载入spring容器(常用)
  • 通过@EventListener注解实现事件监听(常用)
  • 手工向ApplicationContext中添加监听器
  • 在application.properties中配置监听器

2.2 将监听器装载入spring容器

// 装载入spring容器中
@Slf4j
@Component
public class MyListener1 implements ApplicationListener<MyEvent> {
    @Override
    public void onApplicationEvent(MyEvent event) {
        // 这里可以自定义自己的方法
        log.info(String.format("%s监听到事件源:%s.", MyListener1.class.getName(), event.toString()));
    }
}

如果不加@Component注解加入Spring容器,也可以手动加入

@SpringBootApplication
public class ListenerApplication {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(ListenerApplication.class, args);
        //装载监听
        context.addApplicationListener(new MyListener1());
    }
}

也可以通过配置文application.properties中配置监听器:context.listener.classes=com.listener.MyListener1

2.3 @EventListener注解实现事件监听

@Component
@Slf4j
public class MyListener2{
    // 通过注解的方法
    @EventListener(MyEvent.class)
    public void consumer(MyEvent msgEvent) {
        log.info(String.format("%s监听到事件源:%s.", MsgPublisher.class.getName(), msgEvent.toString()));
    }
}

3、事件发布

前面是消费事件,消费的前提是有事件产生,在Spring中,发布事件主要需要借助ApplicationContext来实现

@Component
@Slf4j
public class MsgPublisher implements ApplicationContextAware {
    private ApplicationContext applicationContext;
    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        this.applicationContext = applicationContext;
    }
    // 发起事件通知
    public void publish(String msg) {
        applicationContext.publishEvent(new MyEvent1(this, msg));
    }
    // 通过注解的方法
    @EventListener(MyEvent.class)
    public void consumer(MyEvent msgEvent) {
        log.info(String.format("%s监听到事件源:%s.", MsgPublisher.class.getName(), msgEvent.toString()));
    }
    /**
     * 这个只是测试,到时候spring直接调用即可
    */
    public static void main(String[] args) {
        ApplicationContext context = new AnnotationConfigApplicationContext(MsgPublisher.class);
        MsgPublisher msgPublisher = context.getBean(MsgPublisher.class);
        msgPublisher.publish("hello world");
    }
}

到此这篇关于Spring事件监听基本原理与使用详解的文章就介绍到这了,更多相关Spring事件监听内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • 浅谈使用java解析和生成JSON

    浅谈使用java解析和生成JSON

    在www.json.org上公布了很多JAVA下的json构造和解析工具,其中google-gson和org.json比较简单,两者使用上差不多但还是有些区别。下面我们就来分别介绍下用他们构造和解析Json数据的方法示例。
    2015-08-08
  • Java 超详细讲解对象的构造及初始化

    Java 超详细讲解对象的构造及初始化

    面向对象乃是Java语言的核心,是程序设计的思想。Java语言的面向对象技术包括了面向对象和面向过程的基本概念,面向对象的特征,Java语言的类,对象,修饰符,抽象类等一系列的知识点
    2022-03-03
  • 教你怎么用java一键自动生成数据库文档

    教你怎么用java一键自动生成数据库文档

    最近小编也在找这样的插件,就是不想写文档了,浪费时间和心情啊,果然我找到一款比较好用,操作简单不复杂.screw 是一个简洁好用的数据库表结构文档的生成工具,支持 MySQL、Oracle、PostgreSQL 等主流的关系数据库.需要的朋友可以参考下
    2021-05-05
  • Mybatis-Plus save和saveBatch方法忽略自增主键详解

    Mybatis-Plus save和saveBatch方法忽略自增主键详解

    Mybatis-Plus在从3.4.0升级到3.5.6后,save和saveBatch方法在处理自增主键时会出现主键冲突的问题,这是因为3.5.6版本中增加了`ignoreAutoIncrementColumn`属性,默认值为false,导致在生成SQL语句时忽略了自增主键,解决方法是手动设置主键值
    2025-12-12
  • Spring MVC实现mysql数据库增删改查完整实例

    Spring MVC实现mysql数据库增删改查完整实例

    这篇文章主要介绍了Spring MVC实现mysql数据库增删改查完整实例,从创建一个web项目开始,分享了项目结构以及具体Java代码和前端页面等相关内容,具有一定借鉴价值,需要的朋友可以了解下。
    2017-12-12
  • SpringBoot3集成iText实现PDF导出功能

    SpringBoot3集成iText实现PDF导出功能

    不知道小伙伴们在项目中有没有遇到过导出 PDF 的需求,小编在之前的 tienchin 项目中有一个合同导出的功能,需要将文档导出为PDF,将文档导出为 PDF 有很多方案,不同方案的优缺点也各不相同,今天小编就和大家演示一个,感兴趣的小伙伴跟着小编一起来看看吧
    2024-10-10
  • spring三级缓存以及为什么不用二级缓存解读

    spring三级缓存以及为什么不用二级缓存解读

    Spring三级缓存机制解决了循环依赖问题,通过一级缓存存放完全初始化的bean,二级缓存存放实例化但未完成依赖注入和初始化的bean,三级缓存存放bean的创建工厂,避免了重复创建和确保代理对象的正确生成
    2025-02-02
  • Maven jar包冲突的解决方案

    Maven jar包冲突的解决方案

    这篇文章主要介绍了Maven jar包冲突的解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-04-04
  • SpringBoot里使用Servlet进行请求的实现示例

    SpringBoot里使用Servlet进行请求的实现示例

    这篇文章主要介绍了SpringBoot里使用Servlet进行请求的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2021-01-01
  • Java中的数组流ByteArrayOutputStream用法

    Java中的数组流ByteArrayOutputStream用法

    Java中的ByteArrayOutputStream是java.io包中的一个类,用于在内存中创建字节数组缓冲区,支持动态扩展,它继承自OutputStream,允许以字节形式写入数据,无需与外部设备交互,常用方法包括write()、toByteArray()、toString()等
    2024-09-09

最新评论