首页 > 资讯 > 后端开发 > Python >SpringBoot实现自定义事件的方法详解

599

分享到

SpringBoot实现自定义事件的方法详解

2024-04-02 19:04:59 599人浏览八月长安

Python 官方文档：入门教程 => 点击学习

摘要

目录简介步骤1：自定义事件步骤2：自定义监听器方案1：ApplicationListener方案2：SmartApplicationListener步骤3：注册监听器法1：@Comp

简介

说明

本文用实例来介绍如何在SpringBoot中自定义事件来使用观察者模式。

事件的顺序

可使用实现Ordered接口的方式，调整监听器顺序。

注意：必须是同时实现 ApplicationListener<MyEvent>,Ordered这样的方法才能控制顺序。

下边几种都是无法控制顺序的：

@Component+@EventListerner+实现Ordered
实现 ApplicationListener<MyEvent>+@Order

步骤1：自定义事件

通过继承ApplicationEvent来自定义事件。

构造器的参数为该事件的相关数据对象，监听器可以获取到该数据对象，进而进行相关逻辑处理。

package com.example.event;
 
import org.springframework.context.ApplicationEvent;
 
public class MyEvent extends ApplicationEvent {
 
    public MyEvent(Object source) {
        super(source);
    }
 
}

步骤2：自定义监听器

方案1：ApplicationListener

法1：@EventListener

监听单个事件

package com.example.event;
 
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
 
public class MyListener {
    @EventListener
    public void abc(MyEvent event) {
        System.out.println("监听器：     " + "MyListener");
        System.out.println("  线程：     " + Thread.currentThread().getName());
        System.out.println("  事件：     " + event);
        System.out.println("  事件的数据：" + event.getSource());
    }
}

或者

package com.example.event;
 
import org.springframework.context.ApplicationEvent;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
 
public class MyListener {
    @EventListener({MyEvent.class})
    public void abc(ApplicationEventevent) {
        System.out.println("监听器：      " + "MyListener");
        System.out.println("  线程：      " + Thread.currentThread().getName());
        System.out.println("  事件：      " + event);
        System.out.println("  事件的数据： " + event.getSource());
    }
}

上边的办法比较好，因为不需要类型转换了。直接就能确定是MyEvent类型。

监听多个事件

事件进来之后，可以使用if(event instanceOf MyEvent.class)来判断是哪种事件。

package com.example.event;
 
import org.springframework.context.ApplicationEvent;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
 
@Component
public class MyListener {
    @EventListener({MyEvent.class, MyEvent2.class})
    public void abc(ApplicationEvent event) {
        System.out.println("监听器：      " + "MyListener");
        System.out.println("  所在线程：  " + Thread.currentThread().getName());
        System.out.println("  事件：      " + event);
        System.out.println("  事件的数据：" + event.getSource());
    }
}

监听所有ApplicationEvent

若使用这种写法，启动时会打印很多Spring自带的事件。任意ApplicationEvent都会进入这里边。

package com.example.event;
 
import org.springframework.context.ApplicationEvent;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
 
@Component
public class MyListener {
    @EventListener
    public void abc(ApplicationEvent event) {
        System.out.println("监听器：     " + "MyListener");
        System.out.println("  所在线程： " + Thread.currentThread().getName());
        System.out.println("  事件：     " + event);
        System.out.println("  事件的数据：" + event.getSource());
    }
}

法2：实现ApplicationListener<T>接口

public class MyListener implements ApplicationListener<MyEvent>{
 
    public void onApplicationEvent(MyEvent event){
        System.out.println("监听器：     " + "MyListener");
        System.out.println("  所在线程： " + Thread.currentThread().getName());
        System.out.println("  事件：     " + event);
        System.out.println("  事件的数据：" + event.getSource());
    }
}

方案2：SmartApplicationListener

源码如下

public interface SmartApplicationListener extends ApplicationListener<ApplicationEvent>, Ordered {
    boolean supportsEventType(Class<? extends ApplicationEvent> var1);
 
    default boolean supportsSourceType(@Nullable Class<?> sourceType) {
        return true;
    }
 
    default int getOrder() {
        return 2147483647;
    }
}

supportsEventType：支持的事件的类型

supportsSourceType：支持的数据的类型

getOrder：2147483641：是2^31-1，也就是32位的int的最大正数。

示例

事件

package com.example.event;
 
import org.springframework.context.ApplicationEvent;
 
public class MyEvent extends ApplicationEvent {
 
    public MyEvent(Object source) {
        super(source);
    }
 
}

监听器1

package com.example.event;
 
import org.springframework.context.ApplicationEvent;
import org.springframework.context.event.SmartApplicationListener;
import org.springframework.stereotype.Component;
 
@Component
public class MyListener implements SmartApplicationListener {
 
    @Override
    public boolean supportsEventType(Class<? extends ApplicationEvent> aClass) {
        return aClass == MyEvent.class;
    }
 
    @Override
    public boolean supportsSourceType(Class<?> sourceType) {
        return sourceType == String.class;
    }
 
    @Override
    public int getOrder() {
        return 2;
    }
 
    @Override
    public void onApplicationEvent(ApplicationEvent event) {
        System.out.println("监听器：      " + "MyListener");
        System.out.println("  所在线程：  " + Thread.currentThread().getName());
        System.out.println("  事件：      " + event);
        System.out.println("  事件的数据：" + event.getSource());
        System.out.println("  是MyEvent？：" + (event instanceof MyEvent));
    }
}

监听器2

package com.example.event;
 
import org.springframework.context.ApplicationEvent;
import org.springframework.context.event.SmartApplicationListener;
import org.springframework.stereotype.Component;
 
@Component
public class MyListener2 implements SmartApplicationListener {
 
    @Override
    public boolean supportsEventType(Class<? extends ApplicationEvent> aClass) {
        return aClass == MyEvent.class;
    }
 
    @Override
    public boolean supportsSourceType(Class<?> sourceType) {
        return sourceType == String.class;
    }
 
    @Override
    public int getOrder() {
        return 1;
    }
 
    @Override
    public void onApplicationEvent(ApplicationEvent event) {
        System.out.println("监听器：      " + "MyListener2");
        System.out.println("  所在线程：  " + Thread.currentThread().getName());
        System.out.println("  事件：      " + event);
        System.out.println("  事件的数据：" + event.getSource());
        System.out.println("  是MyEvent？：" + (event instanceof MyEvent));
    }
}

发布器

package com.example.event;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;
 
@Component
public class MyPublisher {
    @Autowired
    ApplicationContext applicationContext;
 
    public void myPublish(String message) {
        System.out.println("发布器所在线程：" + Thread.currentThread().getName());
        applicationContext.publishEvent(new MyEvent(message));
    }
}

测试

package com.example.controller;
 
import com.example.event.MyPublisher;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.WEB.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
 
@RestController
public class HelloController {
    @Autowired
    MyPublisher myPublisher;
 
    @GetMapping("/test1")
    public String test1() {
        myPublisher.myPublish("Hello");
        return "test1 success";
    }
 
}

启动后，访问：Http://localhost:8080/test1

后端输出：

发布器所在线程：http-NIO-8080-exec-2
监听器： MyListener2
所在线程： http-nio-8080-exec-2
事件： com.example.event.MyEvent[source=Hello]
事件的数据：Hello
是MyEvent？：true
监听器： MyListener
所在线程： http-nio-8080-exec-2
事件： com.example.event.MyEvent[source=Hello]
事件的数据：Hello
是MyEvent？：true

如果将监听器的实现的Ordered顺序颠倒，则输出结果如下：

发布器所在线程：http-nio-8080-exec-1
监听器： MyListener
所在线程： http-nio-8080-exec-1
事件： com.example.event.MyEvent[source=Hello]
事件的数据：Hello
是MyEvent？：true
监听器： MyListener2
所在线程： http-nio-8080-exec-1
事件： com.example.event.MyEvent[source=Hello]
事件的数据：Hello
是MyEvent？：true

步骤3：注册监听器

方式	适用范围	能否搭配@Async注解，进行异步监听
@Component	所有监听器	能
application.yml中添加配置	实现ApplicationListener<T>接口的监听器	不能
启动类中注册	实现ApplicationListener<T>接口的监听器	不能

法1：@Component（适用于所有监听器）

package com.example.event;
 
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
 
@Component
public class MyListener {
    @EventListener
    public void abc(MyEvent event) {
        System.out.println("监听器：" + "MyListener");
        System.out.println("线程：" + Thread.currentThread().getName());
        System.out.println("事件：" + event);
        System.out.println("事件的数据：" + event.getSource());
    }
}

package com.example.event;
 
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;
 
@Component
public class MyListener2 implements ApplicationListener<MyEvent> {
 
    @Override
    public void onApplicationEvent(MyEvent event) {
        System.out.println("监听器：" + "MyListener2");
        System.out.println("线程：" + Thread.currentThread().getName());
        System.out.println("事件：" + event);
        System.out.println("事件的数据：" + event.getSource());
    }
}

法2：application.yml中添加配置

只适用于实现ApplicationListener<T>接口的监听器

context:
listener:
classes: com.example.event.MyListener,com.example.event.MyListener2

法3：启动类中注册

只适用于实现ApplicationListener<T>接口的监听器

package com.example;
 
import com.example.event.MyListener;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
 
@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        // 原来是这样的：SpringApplication.run(DemoApplication.class, args);
        ConfigurableApplicationContext context = SpringApplication.run(DemoApplication.class, args);
        context.addApplicationListener(new MyListener());
    }
}

步骤4：发布事件

法1：注入ApplicationContext，调用其publishEvent方法

package com.example.event;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationContext;
import org.springframework.stereotype.Component;
 
@Component
public class MyPublisher {
    @Autowired
    ApplicationContext applicationContext;
 
    public void myPublish(String message) {
        applicationContext.publishEvent(new MyEvent(message));
    }
}

法2：启动类中发布

package com.example;
 
import com.example.event.MyEvent;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ConfigurableApplicationContext;
 
@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args) {
        //原来是：SpringApplication.run(DemoApplication.class, args);
        ConfigurableApplicationContext context =SpringApplication.run(DemoApplication.class, args);
        context.publishEvent(new MyEvent("Hello"));
    }
}

以上就是SpringBoot实现自定义事件的方法详解的详细内容，更多关于SpringBoot自定义事件的资料请关注编程网其它相关文章！

您可能感兴趣的文档:

点击免费下载>>软考高级考试备考技巧/历年真题/备考精华资料

--结束END--

本文标题: SpringBoot实现自定义事件的方法详解

本文链接: https://www.lsjlt.com/news/152215.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑，方便收藏和打印～

下载Word文档

去做题

猜你喜欢

SpringBoot实现自定义事件的方法详解

目录简介步骤1：自定义事件步骤2：自定义监听器方案1：ApplicationListener方案2：SmartApplicationListener步骤3：注册监听器法1：@Comp...

99+

2022-11-13
SpringBoot自定义Starter与自动配置实现方法详解

目录前言本次练习的代码仓库代码简要说明custom-springboot-starter-demo 的pom文件customer-starter 的pom文件test 的pom文件配...

99+

2023-02-07

SpringBoot自定义Starter SpringBoot自动配置
SpringBoot注入自定义的配置文件的方法详解

目录一、简介二、代码实践2.1 通过@value注解实现参数加载2.2 通过@ConfigurationProperties注解实现参数加载2.3 通过@PropertySource...

99+

2022-11-13
Python用tkinter实现自定义记事本的方法详解

目录一、思考二、代码实现三、展示总结一、思考想要完成记事本，我们首先需要考虑一个正常的记事本都需要具有哪些功能，我们将这些功能按键添加到我们的UI界面上即可。一般功能如下：新建文...

99+

2022-11-13
SpringBoot详解实现自定义异常处理页面方法

目录1.相关介绍2.代码实现3.运行测试1.相关介绍当发生异常时, 跳转到我们自定义的异常处理页面. SpringBoot中只需在静态资源目录下创建一个error文件夹, 并把异常...

99+

2022-11-13
SpringBoot自定义注解实现Token校验的方法

1.定义Token的注解，需要Token校验的接口，方法上加上此注解 import java.lang.annotation.ElementType; import java.l...

99+

2022-11-11
SpringBoot自定义Starter实现流程详解

目录starter起步依赖starter命名规则自定义starternew module添加依赖simplebean自动配置类META-INF\spring.factories在sp...

99+

2022-11-13
SpringBoot实现自定义配置文件提示的方法

目录SpringBoot如何实现自定义配置文件提示1、编写一个配置类 2、引入自动提示插件 2.1、引入插件2.2、重新编译3、配置验证SpringBoot如何实...

99+

2022-11-12
SpringBoot 实现自定义的 @ConditionalOnXXX 注解示例详解

目录实现一个自定义的 @Conditional 派生注解Conditional 派生注解的类如何注入到 spring 容器实现一个自定义的 @Conditional 派生注解自定义...

99+

2022-11-13
Android自定义View实现LayoutParams的方法详解

目录第一层理解第二层理解第三层理解这一期我们来讲一讲LayoutParams这个玩意儿。Android入门的第一行代码就牵扯到这个东西，然而，你真的理解够了吗？第一层理解 <...

99+

2023-02-02

Android自定义View实现LayoutParams Android实现LayoutParams Android LayoutParams
Vue之组件的自定义事件详解

目录总结 <template> <div > <h2>{{msg}}</h2> <!-- 通过父组件给...

99+

2022-11-12
springboot自定义starter方法及注解实例

目录SpringBoot starter自定义starter自定义starter步骤实现打包测试注解解释SpringBoot starter 用了springboot 那么久了居然都...

99+

2022-11-13

springboot自定义starter springboot starter
SpringBoot实现自定义启动器的示例详解

目录开发步骤测试自定义启动器启动器支持多Druid和C3P0开发步骤 1.创建启动器项目添加启动器相关依赖创建属性配置类创建自动配置类编写自动配置文件(spring.factori...

99+

2023-01-12

SpringBoot自定义启动器 SpringBoot 启动器
Android自定义Toast样式实现方法详解

目录原生Toast样式自定义Toast样式创建样式封装引用原生Toast样式自定义Toast样式创建样式所谓自定义一个Toast就是建立一个布局文件，然后使用一个view容...

99+

2023-01-17

Android自定义Toast Android Toast样式
Java注解详解及实现自定义注解的方法

目录概念‍♀️作用⛹JDK中预定义的一些注解注解生成文档案例自定义注解格式本质属性：接口中的抽象方法元注解：用于描述注解的注解‍♂️在程序使用(解析)注解：获取注解中...

99+

2022-11-13
详解SpringBoot中自定义和配置拦截器的方法

目录1.SpringBoot版本2.什么是拦截器3.工作原理4.拦截器的工作流程4.1正常流程4.2中断流程5.应用场景6.如何自定义一个拦截器7.如何使其在Spring Boot中...

99+

2022-11-13
Android编程实现自定义手势的方法详解

本文实例讲述了Android编程实现自定义手势的方法。分享给大家供大家参考，具体如下：之前介绍过如何在Android程序中使用手势，主要是系统默认提供的几个手势，这次介绍一下...

99+

2022-06-06

自定义方法手势 Android
SpringBoot详解自定义Stater的应用

目录1、SpringBoot starter机制2、为什么要自定义starter3、自定义starter的命名规则4、使用自定义starter1、SpringBoot starter...

99+

2022-11-13
android自定义组件实现方法

本文实例讲述了android自定义组件实现方法。分享给大家供大家参考。具体如下： atts.xml： <?xml version="1.0" encoding...

99+

2022-06-06

方法 Android
Android编程自定义菜单实现方法详解

本文实例讲述了Android编程自定义菜单实现方法。分享给大家供大家参考，具体如下：在android开发的过程中系统自带的菜单往往满足不了开发中的一些需求，比如说一排最多只能...

99+

2022-06-06

自定义菜单方法 Android