SpringBoot Event实现异步消费机制的示例代码

 更新时间:2024年04月25日 11:56:40   作者:壹粒麦子  
这篇文章主要介绍了SpringBoot Event实现异步消费机制,ApplicationEvent以及Listener是Spring为我们提供的一个事件监听、订阅的实现,内部实现原理是观察者设计模式,文中有详细的代码示例供大家参考,需要的朋友可以参考下

SpringBoot Event实现异步消费机制

ApplicationEvent以及Listener是Spring为我们提供的一个事件监听、订阅的实现,内部实现原理是观察者设计模式,设计初衷也是为了系统业务逻辑之间的解耦,提高可扩展性以及可维护性。

通过 ApplicationEvent 类和 ApplicationListener 接口来提供在 ApplicationContext 中处理事件。如果一个 bean 实现 ApplicationListener,那么每次 ApplicationEvent 被发布到 ApplicationContext 上,那个 bean 会被通知。

(1) ApplicationContext.publishEvent 默认是同步操作, 并非异步操作,发布事件后需要等 @EventListener 执行完

(2) 如果需要开启异步操作 需要在 @EventListener 上 增加 @Async 注解。

创建OrderEvent

用于传递消息

@Data
public class OrderEvent extends ApplicationEvent {  // 第一步 extends ApplicationEvent

   // 可添加多个字段
    public String message;

  	// 根据需要添加字段
    public OrderEvent(Object source, String message) {
        // 固定写法
        super(source);  
        this.message = message;
    }

}

生产者

@RestController
@RequestMapping("order")
public class OrderController {

    // 第一步
    @Autowired
    private ApplicationContext applicationContext;

    @GetMapping("/createOrder/{orderNo}")
    public String createOrder(@PathVariable String orderNo) {
      
      	// 第二步
        applicationContext.publishEvent(new OrderEvent(this, String.format("订单创建成功,订单号为:%s", orderNo)));
        return "订单常见成功";
      
    }
}

监听者

方式一:Event事件监听

事件监听是无序的

@Component   // 第一步
public class GlobalListener {

    private static Logger logger = LoggerFactory.getLogger(GlobalListener.class);

    @EventListener(OrderEvent.class)  // 第二步
    public void createOrder(OrderEvent orderEvent) {
        logger.info("{} 监听器接收到消息,订单号为:{}", LocalDateTime.now(), orderEvent.getMessage());
    }
}

方式二:实现 ApplicationListener接口

事件监听是无序的

@Component		// 第一步
public class OrderListener implements ApplicationListener<OrderEvent> {		// 第一步 implements ApplicationListener<OrderEvent>

    private static Logger logger = LoggerFactory.getLogger(OrderListener.class);

  	// 第三步
    @Override
    public void onApplicationEvent(OrderEvent orderEvent) {
        logger.info("方式二: {} 监听器接收到消息,订单号为:{}", LocalDateTime.now(), orderEvent.getMessage());
    }
}

方式三:SmartApplicationListener实现有序监听

事件监听是有序的

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.context.ApplicationEvent;
import org.springframework.context.event.SmartApplicationListener;
import org.springframework.stereotype.Component;

import java.time.LocalDateTime;

@Component  // 第一步
public class SmartOrderListener implements SmartApplicationListener {

    private static Logger logger = LoggerFactory.getLogger(SmartOrderListener.class);

    /**
     * 该方法返回true&supportsSourceType同样返回true时,才会调用该监听内的onApplicationEvent方法
     *
     * @param aClass 接收到的监听事件类型
     * @return
     */
    @Override
    public boolean supportsEventType(Class<? extends ApplicationEvent> aClass) {
        // 指定只有 OrderEvent 监听类型才会执行下面逻辑
        return aClass == OrderEvent.class;
    }

    /**
     * 该方法返回true&supportsEventType同样返回true时,才会调用该监听内的onApplicationEvent方法
     *
     * @param sourceType
     * @return
     */
    @Override
    public boolean supportsSourceType(Class<?> sourceType) {
        //只有在 OrderService 内发布的 OrderEvent 事件时才会执行下面逻辑,这里没有,下面是案列
        // return aClass == OrderService.class;
        return SmartApplicationListener.super.supportsSourceType(sourceType);
    }

    /**
     * supportsEventType & supportsSourceType 两个方法返回true时调用该方法执行业务逻辑
     *
     * @param applicationEvent 具体监听实例,这里是 OrderEvent
     */
    @Override
    public void onApplicationEvent(ApplicationEvent applicationEvent) {

        //转换事件类型
        OrderEvent orderEvent = (OrderEvent) applicationEvent;
        String message = orderEvent.getMessage();
        logger.info("方式三(有序): {} 监听器接收到消息,订单号为:{}", LocalDateTime.now(), orderEvent.getMessage());
    }

    @Override
    public int getOrder() {
        return 0;
    }

}

以上就是SpringBoot Event实现异步消费机制的示例代码的详细内容,更多关于SpringBoot Event异步消费机制的资料请关注脚本之家其它相关文章!

相关文章

  • Spring MVC+FastJson+hibernate-validator整合的完整实例教程

    Spring MVC+FastJson+hibernate-validator整合的完整实例教程

    这篇文章主要给大家介绍了关于Spring MVC+FastJson+hibernate-validator整合的完整实例教程,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧。
    2018-04-04
  • Java正则表达式API边界匹配

    Java正则表达式API边界匹配

    这篇文章主要介绍了Java正则表达式API边界匹配,文章围绕主题展开相应的相关资料,具有一定的参考价值,需要的朋友可以参考一下
    2022-06-06
  • IDEA全量替换一次性解决旧项目并将所有文件换行符改为LF问题

    IDEA全量替换一次性解决旧项目并将所有文件换行符改为LF问题

    这篇文章主要介绍了IDEA全量替换一次性解决旧项目并将所有文件换行符改为LF问题,非常不错,具有一定的参考借鉴价值,需要的朋友参考下
    2019-05-05
  • Springboot自动装配之注入DispatcherServlet的实现方法

    Springboot自动装配之注入DispatcherServlet的实现方法

    这篇文章主要介绍了Springboot自动装配之注入DispatcherServlet,Springboot向外界提供web服务,底层依赖了springframework中的web模块来实现,那么springboot在什么时机向容器注入DispatcherServlet这个核心类的呢?带着这个问题一起通过本文学习吧
    2022-05-05
  • Idea调用WebService的关键步骤和注意事项

    Idea调用WebService的关键步骤和注意事项

    这篇文章主要介绍了如何在Idea中调用WebService,包括理解WebService的基本概念、获取WSDL文件、阅读和理解WSDL文件、选择对接测试工具或方式、发送请求和接收响应、处理响应结果以及错误处理,需要的朋友可以参考下
    2025-01-01
  • Java中import导入的用法说明

    Java中import导入的用法说明

    这篇文章主要介绍了Java中import导入的用法说明,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2022-06-06
  • 使用Java校验SQL语句的合法性五种解决方案

    使用Java校验SQL语句的合法性五种解决方案

    这篇文章主要介绍了如何用java校验SQL语句的合法性(提供五种解决方案),使用JDBC API和JSqlParser库、正则表达式、ANTLR解析器生成器或Apache Calcite库都可以实现校验SQL语句的合法性,需要的朋友可以参考下
    2023-04-04
  • Java8中stream和functional interface的配合使用详解

    Java8中stream和functional interface的配合使用详解

    这篇文章主要给大家介绍了关于Java8中stream和functional interface配合使用的相关资料,文中通过示例代码介绍的非常详细,对大家学习或者使用java8具有一定的参考学习价值,需要的朋友们下面来一起看看吧。
    2017-11-11
  • springmvc 获取@Requestbody转换的异常处理方式

    springmvc 获取@Requestbody转换的异常处理方式

    这篇文章主要介绍了springmvc 获取@Requestbody转换的异常处理方式,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07
  • java去除字符串中的空格、回车、换行符、制表符的小例子

    java去除字符串中的空格、回车、换行符、制表符的小例子

    java去除字符串中的空格、回车、换行符、制表符的小例子,需要的朋友可以参考一下
    2013-06-06

最新评论