springboot事件监听器怎么使用
引导案例下面看一个简单的案例，@ConfigurationpublicclassSelfBusiness{publicstaticvoidmain(String[]args){AnnotationConfigApplicationContextcontext=newAnnotationConfigApplicationContext(SelfBusiness.class);context.getBean(MyService.class).doBusiness();context.close();}@Com
引导案例
下面看一个简单的案例，
@Configuration
public class SelfBusiness {
public static void main(String[] args) {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(SelfBusiness.class);
context.getBean(MyService.class).doBusiness();
context.close();
}
@Component
static class MyService {
private static final Logger logger = LoggerFactory.getLogger(MyService.class);
@Autowired
private ApplicationEventPublisher publisher;
public void doBusiness (){
logger.debug("主线业务");
logger.debug("发送短信");
logger.debug("发送邮件");
}
}运行上面的代码，观察效果
结合输出结果，这这段代码要实现的逻辑是，在主线业务执行完成后，需要执行发短信，发邮件等操作，这样写也没毛病，但不够优雅，从后续的业务可扩展性上来讲，不够友好，如果后续主线业务执行完毕，还需再增加一个其他的审计操作，则需要新增代码逻辑，这就将主线业务和支线逻辑紧密的耦合了起来；
就是说，我们期待的效果是，主线业务根本不关心其他的业务操作，只需要完成自身的逻辑就ok了，这就需要使用到spring提供的事件监听器功能；
使用事件监听器改造过程
springboot（spring）的事件监听器使用主要有两种方式，通过实现ApplicationListener接口，另一个就是在类上添加 @EventListener 注解来实现，接下来将对这两种方式逐一说明；
一、通过实现ApplicationListener接口实现步骤
1、自定义一个事件类（对象），继承ApplicationEvent
static class MyEvent extends ApplicationEvent {
public MyEvent(Object source) {
super(source);
}
}可以这么理解，在代码中，可能有很多种类型的事件，不同的业务对应着不同的事件，对于某个具体的监听器来说，它只想监听A这种类型的事件；
2、自定义业务类实现ApplicationListener 接口
@Data
static class Params {
private String id ;
private String name;
private String phone;
}
@Component
static class SmsApplicationListener implements ApplicationListener {
private static final Logger logger = LoggerFactory.getLogger(SmsApplicationListener.class);
@Override
public void onApplicationEvent(MyEvent myEvent) {
Object source = myEvent.getSource();
try {
Params params = objectMapper.readValue(source.toString(), Params.class);
logger.debug("userId : {}",params.getId());
} catch (JsonProcessingException e) {
e.printStackTrace();
}
logger.debug("执行 sms 发短信业务");
}
}
@Component
static class EmailApplicationListener implements ApplicationListener {
private static final Logger logger = LoggerFactory.getLogger(SmsApplicationListener.class);
@Override
public void onApplicationEvent(MyEvent myEvent) {
Object source = myEvent.getSource();
logger.debug("执行 email 发邮件业务");
}
} 显然，这里的监听器要监听的事件类型，正是上面我们定义的MyEvent ，这样，当业务被触发的时候，就可以在onApplicationEvent中拿到传递过来的参数，从而执行发短信（发邮件）业务操作了
3、主线业务发布事件
@Component
static class MyService {
private static final Logger logger = LoggerFactory.getLogger(MyService.class);
@Autowired
private ApplicationEventPublisher publisher;
public void doBusiness (){
Params params = new Params();
params.setId("001");
params.setName("xiaoma");
params.setPhone("133******");
logger.debug("主线业务");
try {
publisher.publishEvent(new MyEvent(objectMapper.writeValueAsString(params)));
} catch (JsonProcessingException e) {
e.printStackTrace();
}
//publisher.publishEvent(new MyEvent("MyService doBusiness()"));
//logger.debug("发送短信");
//logger.debug("发送邮件");
}
}对主线业务来说，这时候就不再需要写发送短信或邮件逻辑了，只需要一个publisher将事件发布出去即可，如果需要传递参数，将参数一起传递过去
完整的代码
@Configuration
public class SelfBusiness {
private static ObjectMapper objectMapper = new ObjectMapper();
public static void main(String[] args) {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(SelfBusiness.class);
context.getBean(MyService.class).doBusiness();
context.close();
}
@Data
static class Params {
private String id ;
private String name;
private String phone;
}
/**
* 自定义事件对象
*/
static class MyEvent extends ApplicationEvent {
public MyEvent(Object source) {
super(source);
}
}
@Component
static class MyService {
private static final Logger logger = LoggerFactory.getLogger(MyService.class);
@Autowired
private ApplicationEventPublisher publisher;
public void doBusiness (){
Params params = new Params();
params.setId("001");
params.setName("xiaoma");
params.setPhone("133******");
logger.debug("主线业务");
try {
publisher.publishEvent(new MyEvent(objectMapper.writeValueAsString(params)));
} catch (JsonProcessingException e) {
e.printStackTrace();
}
//publisher.publishEvent(new MyEvent("MyService doBusiness()"));
//logger.debug("发送短信");
//logger.debug("发送邮件");
}
}
/**
* 监听事件触发后要执行的业务
*/
@Component
static class SmsApplicationListener implements ApplicationListener {
private static final Logger logger = LoggerFactory.getLogger(SmsApplicationListener.class);
@Override
public void onApplicationEvent(MyEvent myEvent) {
Object source = myEvent.getSource();
try {
Params params = objectMapper.readValue(source.toString(), Params.class);
logger.debug("userId : {}",params.getId());
} catch (JsonProcessingException e) {
e.printStackTrace();
}
logger.debug("执行 sms 发短信业务");
}
}
@Component
static class EmailApplicationListener implements ApplicationListener {
private static final Logger logger = LoggerFactory.getLogger(SmsApplicationListener.class);
@Override
public void onApplicationEvent(MyEvent myEvent) {
Object source = myEvent.getSource();
logger.debug("执行 email 发邮件业务");
}
}
} 再次运行上面的代码，观察效果，可以看到，仍然能满足预期的效果
二、通过添加 @EventListener 注解来实现
这种方式不再需要实现ApplicationListener 接口，而是直接在监听类的方法上面添加 @EventListener注解即可，相对要简化了一些，下面直接贴出完整的代码
package com.congge.config;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import lombok.Data;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.ApplicationEvent;
import org.springframework.context.ApplicationEventPublisher;
import org.springframework.context.ApplicationListener;
import org.springframework.context.annotation.AnnotationConfigApplicationContext;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.event.EventListener;
import org.springframework.stereotype.Component;
@Configuration
public class SelfBusiness2 {
private static ObjectMapper objectMapper = new ObjectMapper();
public static void main(String[] args) {
AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(SelfBusiness2.class);
context.getBean(MyService.class).doBusiness();
context.close();
}
@Data
static class Params {
private String id ;
private String name;
private String phone;
}
/**
* 自定义事件对象
*/
static class MyEvent extends ApplicationEvent {
public MyEvent(Object source) {
super(source);
}
}
@Component
static class MyService {
private static final Logger logger = LoggerFactory.getLogger(MyService.class);
@Autowired
private ApplicationEventPublisher publisher;
public void doBusiness (){
Params params = new Params();
params.setId("001");
params.setName("xiaoma");
params.setPhone("133******");
logger.debug("主线业务");
try {
publisher.publishEvent(new MyEvent(objectMapper.writeValueAsString(params)));
} catch (JsonProcessingException e) {
e.printStackTrace();
}
}
}
@Component
static class SmsListenerService {
private static final Logger logger = LoggerFactory.getLogger(SmsListenerService.class);
@EventListener
public void smsListener(MyEvent myEvent){
Object source = myEvent.getSource();
try {
SelfBusiness2.Params params = objectMapper.readValue(source.toString(), SelfBusiness2.Params.class);
logger.debug("userId : {}",params.getId());
} catch (JsonProcessingException e) {
e.printStackTrace();
}
logger.debug("执行 sms 发短信业务");
}
}
@Component
static class EmailListenerService {
private static final Logger logger = LoggerFactory.getLogger(EmailListenerService.class);
@EventListener
public void emailListener(MyEvent myEvent){
Object source = myEvent.getSource();
try {
SelfBusiness2.Params params = objectMapper.readValue(source.toString(), SelfBusiness2.Params.class);
logger.debug("userId : {}",params.getId());
} catch (JsonProcessingException e) {
e.printStackTrace();
}
logger.debug("执行 email 发邮件业务");
}
}
}运行上面的代码，观察效果，同样可以达到预期的效果
三、使用异步
更进一步来说，为了提升主线业务的逻辑执行效率，我们希望发布事件的业务逻辑异步执行，这个该如何做呢?
翻阅源码可以知道，ApplicationEventPublisher 默认发布事件时候采用单线程同步发送，如果需要使用异步，需要自定义 ThreadPoolTaskExecutor ，以及SimpleApplicationEventMulticaster ，因此我们只需要覆盖一下这两个组件的bean即可，在上面的业务类中将下面的这两个bean添加进去；
@Bean
public ThreadPoolTaskExecutor executor() {
ThreadPoolTaskExecutor executor = new ThreadPoolTaskExecutor();
executor.setCorePoolSize(5);
executor.setMaxPoolSize(10);
executor.setQueueCapacity(100);
return executor;
}
@Bean
public SimpleApplicationEventMulticaster applicationEventMulticaster(ThreadPoolTaskExecutor executor) {
SimpleApplicationEventMulticaster eventMulticaster = new SimpleApplicationEventMulticaster();
eventMulticaster.setTaskExecutor(executor);
return eventMulticaster;
}这时候再次运行代码，反复运行多次，就可以看到效果
对比下上面单线程效果
springBoot项目常用目录springBoot项目的目录结构及名规范介绍基于SpringBoot开发时的目录结构及命名规范，通过介绍能够为你解决，在实际项目中如何规划目录结构？如何命名目录更规范？各个目录分别代表什么含义？等三个问题。目录说明servicex//项目名|-admin-ui//管理服务前端代码(一般将UI和SERVICE放到一个工程中，便于管理)|-servicex-auth//模块1|-servicex-common//模块2|-servicex-gateway//模块3|-serv
解析SpringBoot和SpringMVC之间的异同SpringBoot和SpringMVC是Java领域中非常重要的开发框架。虽然它们都属于Spring框架的一部分，但是在使用和功能上有一些明显的区别。本文将对SpringBoot和SpringMVC进行比较，解析它们之间的异同。首先，让我们来了解一下SpringBoot。SpringBo
近年来，随着云计算和分布式架构的兴起，微服务架构的应用越来越广泛。而SpringCloud和SpringBoot作为Java开发中的两个重要框架，对于微服务的实现起到了重要的作用。然而，很多人对于它们在微服务领域的不同应用方式还存在一定的疑惑。本文将从不同的角度探索SpringCloud和SpringBoot在微服务中的应用方式。首先，我们来了解一下Spri
SpringBoot与SpringMVC的不同之处在哪里？SpringBoot和SpringMVC是两个非常流行的Java开发框架，用于构建Web应用程序。尽管它们经常分别被使用，但它们之间的不同之处也是很明显的。首先，SpringBoot可以被看作是一个Spring框架的扩展或者增强版。它旨在简化Spring应用程序的初始化和配置过程，以帮助开发人
SpringBoot和SpringMVC都是Java开发中常用的框架，但它们之间有一些明显的差异。本文将探究这两个框架的特点和用途，并对它们的差异进行比较。首先，我们来了解一下SpringBoot。SpringBoot是由Pivotal团队开发的，它旨在简化基于Spring框架的应用程序的创建和部署。它提供了一种快速、轻量级的方式来构建独立的、可执行
SpringBoot和SpringMVC是Java开发中常用的两个框架，它们都是由Spring框架所提供的，但在功能和使用方式上有着一些区别。本文将分别介绍SpringBoot和SpringMVC的特点和区别。一、SpringBoot的特点：简化配置：SpringBoot通过约定优于配置的原则，大大简化了项目的配置过程。它可以自动配置项目所需要的参数，开发人
SpringCloud和SpringBoot是目前Java领域中最热门的开源框架，它们分别提供了一套完善的微服务架构和快速构建应用程序的解决方案。本文将对它们的功能进行比较，并给出选择指南，以帮助读者了解它们的优势和适用场景。SpringBoot是一个用于开发Java应用程序的框架，它提供了一个简化的开发流程，集成了大量常用的功能和组件，减少了开发者的工作量
深入剖析SpringCloud和SpringBoot的异同引言：在构建企业级应用程序时，Spring框架已经成为开发者们的首选。它提供了一种简单而强大的方式来构建独立于平台的应用程序。Spring框架由两个核心模块组成：SpringBoot和SpringCloud。虽然它们都可以帮助开发者快速搭建应用程序，但它们的目标和用途存在一些差异。本文将深入剖析Spr
从架构角度看SpringCloud与SpringBoot的差异引言：在当今的互联网时代，构建分布式系统已经成为了一种必要的需求。而SpringBoot和SpringCloud正是为了满足这个需求而诞生的。尽管它们都是由Spring框架所提供的解决方案，但从架构角度来看，它们存在着一些重要的差异。本文将从架构的角度出发，对SpringBoot和SpringCl
JavaAPI开发中使用SpringBoot的利弊分析随着互联网的快速发展和技术的不断更新迭代，Java技术在开发中的广泛应用引起了人们的重视。而SpringBoot作为一种微服务架构的解决方案，已经逐渐成为Java开发中的热门选择。那么，在JavaAPI开发中使用SpringBoot，到底有哪些利弊呢？下面来分析一下。利：简化开发
火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力，依托字节自研豆包多模态大模型，凭借火山方舟一站式平台，提供模型精调、推理部署、智能应用搭建等全链路服务，结合高性能AI算力，助力各行业快速落地大模型数字化与智能化应用。
