在spring boot中,事件监听是一种机制,通过该机制,你可以定义和触发自定义的事件,以及在应用程序中注册监听器来响应这些事件,提供了一种解耦的方式来处理应用程序中的事件。
事件监听的主要组件包括:
事件(event):
- 事件是一个普通的java对象,用于封装与应用程序中发生的某个动作或状态变化相关的信息。
事件发布器(event publisher):
- 事件发布器是一个负责将事件发布给注册的监听器的组件。在spring中,
applicationeventpublisher接口定义了事件发布器的标准。
- 事件发布器是一个负责将事件发布给注册的监听器的组件。在spring中,
事件监听器(event listener):
- 事件监听器是用于监听和响应特定事件的组件。在spring中,通过
applicationlistener接口或使用@eventlistener注解来定义事件监听器。
在spring boot中实现事件监听的步骤如下:
定义事件类:
- 创建一个普通的java类,用于表示特定的事件。该类通常继承自
applicationevent或其子类。
定义事件发布器(可选):
- 可以在需要的地方注入
applicationeventpublisher并使用它来发布事件,或者直接通过spring容器(applicationcontext)发布事件。
定义事件监听器:
- 创建一个实现
applicationlistener接口或使用@eventlistener注解的类,用于监听特定的事件,并在事件发生时执行相应的逻辑。
注册监听器:
- 将事件监听器注册到spring容器中,可以通过注解、java配置或xml配置来完成。
以下是一个简单的示例,演示了如何在spring boot中实现事件监听(主要代码展示):
代码层级结构:

1.自定义事件类 coursestestevent继承applicationevent:
package com.example.springbootredis.event;
import lombok.getter;
import lombok.setter;
import org.springframework.context.applicationevent;
/**
* 课程事件类,继承自 applicationevent,表示课程相关的事件。
*/
@setter
@getter
public class coursestestevent extends applicationevent {
private integer id;
/**
* 课程标题
*/
private string title;
/**
* 课程封面
*/
private string thumb;
/**
* 课程价格(分)
*/
private integer charge;
/**
* 随便传递几个参数
* */
public coursestestevent(object source, string title, string thumb) {
super(source);
this.title = title;
this.thumb = thumb;
}
}
2.创建一个事件监听器类 coursestestlistener:
package com.example.springbootredis.listener;
import com.example.springbootredis.event.coursestestevent;
import com.example.springbootredis.service.coursesservice;
import lombok.extern.slf4j.slf4j;
import org.springframework.beans.factory.annotation.autowired;
import org.springframework.context.event.eventlistener;
import org.springframework.scheduling.annotation.async;
import org.springframework.stereotype.component;
/**
* 用于测试监听事务,异步执行方法
* 课程事件监听器类,用于异步更新课程信息。
*/
@component
@slf4j
public class coursestestlistener {
//根据实际的需求进行注入
@autowired
private coursesservice coursesservice;
/**
* 异步事件监听方法,用于监听coursestestevent进行更新课程相关信息。
* @param event 触发的课程的事件。
*/
// @async("mytaskexecutor") // 异步执行的注解,线程池
// @async() // 异步执行的注解
@eventlistener // 事件监听器的注解
public void updatelogininfo(coursestestevent event) {
//检查是否能够获取到coursestestevent
system.out.println("title:"+event.gettitle());
system.out.println("thumb:"+event.getthumb());
system.out.println(3);
// 打印当前线程的信息
system.out.println("执行当前线程的名称3: " + thread.currentthread().getname());
}
}
3.在业务逻辑中进行测试事件监听:
package com.example.springbootredis.service.impl;
import com.example.springbootredis.domain.courses;
import com.example.springbootredis.event.coursestestevent;
import com.example.springbootredis.mapper.coursesmapper;
import com.example.springbootredis.service.coursesservice;
import lombok.extern.slf4j.slf4j;
import org.springframework.beans.factory.annotation.autowired;
import org.springframework.context.applicationcontext;
import org.springframework.stereotype.service;
import java.util.list;
@service
@slf4j
public class coursesserviceimpl implements coursesservice {
@autowired
private coursesmapper coursesmapper;
//用于管理和维护bean以及处理bean之间依赖关系的核心容器。
@autowired
private applicationcontext applicationcontext;
//进行异步测试
@override
public list<courses> asytest() {
list<courses> courses = coursesmapper.findall();
system.out.println(1);
// 打印当前线程的信息
system.out.println("执行当前线程的名称1: " + thread.currentthread().getname());
// 发布自定义的课程测试事件
applicationcontext.publishevent(new coursestestevent(this,courses.get(0).gettitle(),courses.get(0).getthumb()));
system.out.println(2);
system.out.println("执行当前线程的名称2: " + thread.currentthread().getname());
return courses;
}
}
4.代码执行结果(没有使用异步):

测试达到了监听的效果了,但是都是同一个线程执行,按照顺序进行执行,没有达到异步的效果。为了增加响应的效率,对监听事件进行异步的执行。
spring boot的异步任务通常使用以下几个核心注解:
@enableasync:在spring boot应用程序的配置类上添加@enableasync注解,以启用异步任务支持。这样spring会为异步方法创建一个代理,允许它们在单独的线程中执行。
package com.example.springbootredis;
import org.mybatis.spring.annotation.mapperscan;
import org.springframework.boot.springapplication;
import org.springframework.boot.autoconfigure.springbootapplication;
import org.springframework.scheduling.annotation.enableasync;
@springbootapplication
@mapperscan("com.example.springbootredis.mapper")
@enableasync //开启异步任务支持(主要)
public class springbootredisapplication {
public static void main(string[] args) {
springapplication.run(springbootredisapplication.class, args);
}
}
@async:在需要异步执行的方法上添加@async注解。这告诉spring框架将这个方法的调用包装在一个新的线程中执行。
package com.example.springbootredis.listener;
import com.example.springbootredis.event.coursestestevent;
import com.example.springbootredis.service.coursesservice;
import lombok.extern.slf4j.slf4j;
import org.springframework.beans.factory.annotation.autowired;
import org.springframework.context.event.eventlistener;
import org.springframework.scheduling.annotation.async;
import org.springframework.stereotype.component;
/**
* 用于测试监听事务,异步执行方法
* 课程事件监听器类,用于异步更新课程信息。
*/
@component
@slf4j
public class coursestestlistener {
//根据实际的需求进行注入
@autowired
private coursesservice coursesservice;
/**
* 异步事件监听方法,用于监听coursestestevent进行更新课程相关信息。
* @param event 触发的课程的事件。
*/
// @async("mytaskexecutor") // 异步执行的注解,线程池
@async() // 异步执行的注解
@eventlistener // 事件监听器的注解
public void updatelogininfo(coursestestevent event) {
//检查是否能够获取到coursestestevent
system.out.println("title:"+event.gettitle());
system.out.println("thumb:"+event.getthumb());
system.out.println(3);
// 打印当前线程的信息
system.out.println("执行当前线程的名称3: " + thread.currentthread().getname());
}
}
再进行测试(异步):

这样就达到异步的效果了,对监听事件进行异步执行。如果想直接进行测试,下面是gitee地址:创建一个数据库将courses.sql文件进行执行,启动即可测试:https://gitee.com/sophisticatedxin/springboot-asy-demo.git
到此这篇关于springboot实现事件监听(异步执行)的示例代码的文章就介绍到这了,更多相关springboot 事件监听内容请搜索代码网以前的文章或继续浏览下面的相关文章希望大家以后多多支持代码网!
发表评论