Java-SpringBoot-04-自定义监听器及事件

简介: 日常项目中,很多业务场景会用到监听器,比如在Service中处理业务时,我们需要记录一个操作的日志到数据库中,我们怎么实现呢?

上篇文章我们看到SpringBoot应用在启动时提供了几种事件的监听,今天来看下如何自定义一个监听器。

       日常项目中,很多业务场景会用到监听器,比如在Service中处理业务时,我们需要记录一个操作的日志到数据库中,我们怎么实现呢?

分析场景

       1.我们需要一个Service类来处理业务。

       2.在操作完或者报错的时候,要监听到事件并处理,所以需要一个监听类和一个事件类。


一、新建实体类

       实体类用来进行业务操作对象的映射。

packagecom.xing.studyboot.entity.dto;
importlombok.Data;
/***  业务日志记录实体类* @author xing**/@DatapublicclassBusinessLogDto {
/*** 业务类型*/privateStringtype;
/*** 业务处理时长*/privatelongbusinessTime;
/*** 业务处理结果*/privateStringresult;
/*** 请求参数*/privateStringparams;
/*** 操作者*/publicStringreceiver;
}


二、建一个事件,集成ApplicationEvent类

packagecom.xing.studyboot.event;
importorg.springframework.context.ApplicationEvent;
importcom.xing.studyboot.entity.dto.BusinessLogDto;
importlombok.Getter;
/***  业务日志事件* @author xing**/@GetterpublicclassBusinessLogEventextendsApplicationEvent {
privatestaticfinallongserialVersionUID=1L;
privateBusinessLogDtobusinessLogDto;
publicBusinessLogEvent(Objectsource, BusinessLogDtobusinessLogDto) {
super(source);
this.businessLogDto=businessLogDto;
  }
}


三、注册业务日志的监听器

       这里注册有多种方法,我们使用@Component注解,实现 ApplicationListener<BusinessLogEvent> 接口。

packagecom.xing.studyboot.listener;
importorg.springframework.context.ApplicationListener;
importorg.springframework.core.annotation.Order;
importorg.springframework.stereotype.Component;
importcom.xing.studyboot.entity.dto.BusinessLogDto;
importcom.xing.studyboot.event.BusinessLogEvent;
/***  注册业务日志的监听器* @author xing* @createTime*/@Component@Order(1)
publicclassBusinessLogListenerimplementsApplicationListener<BusinessLogEvent> {
@OverridepublicvoidonApplicationEvent(BusinessLogEventbusinessLogEvent) {
BusinessLogDtobusinessLogDto=businessLogEvent.getBusinessLogDto();
System.out.println("BusinessLogListener接收到的监听数据是->"+businessLogDto);
    }
}


四、在业务类中将事件发布到应用

packagecom.xing.studyboot.rest.service.impl;
importorg.springframework.beans.factory.annotation.Autowired;
importorg.springframework.context.ApplicationContext;
importorg.springframework.stereotype.Service;
importcom.xing.studyboot.entity.dto.BusinessLogDto;
importcom.xing.studyboot.event.BusinessLogEvent;
importcom.xing.studyboot.rest.service.CommonService;
@ServicepublicclassCommonServiceImplimplementsCommonService {
@AutowiredprivateApplicationContextapplicationContext;
@OverridepublicStringindex() {
BusinessLogDtodto=newBusinessLogDto();
dto.setType("0");
dto.setResult("ok");
dto.setParams("params");
dto.setBusinessTime(20L);
dto.setReceiver("xinghua");
System.out.println("CommonServiceImpl->记录操作日志,发布事件到应用");
applicationContext.publishEvent(newBusinessLogEvent(this, dto));
return"CommonServiceImpl.index";
  }
}



测试发现,输出了监听到的发布事件。

image.png


五、也可以用@EventListener注解来注册监听器,等同于上面的实现 ApplicationListener<BusinessLogEvent> 接口。

@Async是异步监听

packagecom.xing.studyboot.listener;
importorg.springframework.context.event.EventListener;
importorg.springframework.core.annotation.Order;
importorg.springframework.scheduling.annotation.Async;
importorg.springframework.stereotype.Component;
importcom.xing.studyboot.entity.dto.BusinessLogDto;
importcom.xing.studyboot.event.BusinessLogEvent;
/***  使用注解的形式注册监听器* @author xing* @createTime*/@Component@Order(2)
publicclassBusinessLogAnnotationListener {
/*** 注册监听实现方法* @param businessLogEvent 业务处理推送事件*/@EventListener@Asyncpublicvoidregister(BusinessLogEventbusinessLogEvent) {
// 获取业务处理日志对象BusinessLogDtobusinessLogDto=businessLogEvent.getBusinessLogDto();
System.out.println("BusinessLogAnnotationListener接收到的监听数据是->"+businessLogDto);
    }
}

测试发现同样监听到了事件,ok!

image.png

@Order(2)注解可以设置监听器的优先级。

相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
目录
相关文章
|
30天前
|
XML Java 数据格式
Springboot中自定义组件
Springboot中自定义组件
|
30天前
|
Java
java自定义Service的异常
java自定义Service的异常
19 0
|
30天前
|
缓存 Java Sentinel
Springboot 中使用 Redisson+AOP+自定义注解 实现访问限流与黑名单拦截
Springboot 中使用 Redisson+AOP+自定义注解 实现访问限流与黑名单拦截
|
30天前
|
算法 安全 Java
性能工具之 JMeter 自定义 Java Sampler 支持国密 SM2 算法
【4月更文挑战第28天】性能工具之 JMeter 自定义 Java Sampler 支持国密 SM2 算法
49 1
性能工具之 JMeter 自定义 Java Sampler 支持国密 SM2 算法
|
2天前
|
JavaScript Java 测试技术
《手把手教你》系列技巧篇(七十一)-java+ selenium自动化测试-自定义类解决元素同步问题(详解教程)
【6月更文挑战第12天】本文介绍了如何创建一个自定义类库来解决自动化测试中的元素同步问题。作者指出,大部分错误源于元素因时间不同步而引发,为此提供了一种解决方案。在项目实践中,首先在`library`包下创建名为`MyWait`的类,包含一个方法`isElementPresent`,该方法通过循环尝试并等待指定元素出现,避免了直接使用时间等待可能导致的不准确性。之后,在测试类中调用此自定义方法,成功实现了元素同步。代码示例展示了如何在Java+Selenium自动化测试中应用这个自定义类。
27 2
|
7天前
|
Java
JAVA Swing自定义JScorllPanel
JAVA Swing自定义JScorllPanel
9 1
|
10天前
|
Java API 项目管理
Java一分钟之-Gradle插件开发:自定义构建逻辑
【6月更文挑战第5天】Gradle插件开发详解:从入门到发布。文章介绍如何创建自定义插件,强调依赖管理、任务命名和配置阶段的理解。示例代码展示插件实现及避免常见问题的方法。最后,讨论插件的发布与共享,助你提升构建效率并贡献于开发者社区。动手实践,打造强大Gradle插件!
31 3
|
21天前
|
设计模式 消息中间件 Java
Java观察者模式:实现松耦合的事件通知机制
Java观察者模式:实现松耦合的事件通知机制
21 2
|
22天前
|
Java UED
Java中的事件处理机制
Java中的事件处理机制
41 1
|
23天前
|
Java
【JAVA学习之路 | 提高篇】自定义异常类
【JAVA学习之路 | 提高篇】自定义异常类