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事件监听内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家!

相关文章

  • Spring Boot高级教程之使用Redis实现session共享

    Spring Boot高级教程之使用Redis实现session共享

    这篇文章主要为大家详细介绍了Spring Boot高级教程之使用Redis实现session共享,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-10-10
  • mybatis-plus 实现分页查询的示例代码

    mybatis-plus 实现分页查询的示例代码

    本文介绍了在MyBatis-Plus中实现分页查询,包括引入依赖、配置分页插件、使用分页查询以及在控制器中调用分页查询的方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2024-11-11
  • java文件上传技术深入剖析

    java文件上传技术深入剖析

    这篇文章主要为大家详细介绍了java文件上传技术深入剖析,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2016-10-10
  • Java中使用COS实现文件上传功能

    Java中使用COS实现文件上传功能

    cos是O'Rrilly公司开发的一款用于HTTP上传文件的OpenSource组件。下面通过本文给大家分享使用COS实现文件上传功能,感兴趣的朋友一起看看吧
    2017-08-08
  • IntelliJ IDEA安装scala插件并创建scala工程的步骤详细教程

    IntelliJ IDEA安装scala插件并创建scala工程的步骤详细教程

    这篇文章主要介绍了IntelliJ IDEA安装scala插件并创建scala工程的步骤,本文通过图文并茂的形式给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2020-07-07
  • Mybatis-Plus自动生成代码的实现示例

    Mybatis-Plus自动生成代码的实现示例

    在工作中,程序员很多时候都是在写类似的代码,可以使用自动生成代码,本文主要介绍了Mybatis-Plus自动生成代码的实现示例,具有一定的参考价值,感兴趣的可以了解一下
    2023-11-11
  • Java实现多项式除法的代码示例

    Java实现多项式除法的代码示例

    今天小编就为大家分享一篇关于Java实现多项式除法的代码示例,小编觉得内容挺不错的,现在分享给大家,具有很好的参考价值,需要的朋友一起跟随小编来看看吧
    2018-10-10
  • java创建二维码并赋予url链接的功能实现

    java创建二维码并赋予url链接的功能实现

    这篇文章给大家分享java创建二维码并赋予url链接的功能实现,需要获取要赋值给二维码的链接后缀,通过设置二维码的访问路径等一系列操作,具体实现代码跟随小编一起看看吧
    2021-06-06
  • spring boot 日志/页面处理、实体类构建、后台管理功能的实现

    spring boot 日志/页面处理、实体类构建、后台管理功能的实现

    这篇文章主要介绍了spring boot 日志/页面处理、实体类构建、后台管理功能的实现,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-08-08
  • Java数组索引异常产生及解决方案

    Java数组索引异常产生及解决方案

    这篇文章主要介绍了Java数组索引异常产生及解决方案,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
    2020-01-01

最新评论