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异步消费机制的资料请关注脚本之家其它相关文章!

相关文章

  • Java集合的总体框架相关知识总结

    Java集合的总体框架相关知识总结

    今天带大家学习Java集合框架的相关知识,文中有非常详细的图文介绍,对正在学习Java的小伙伴们很有帮助,需要的朋友可以参考下
    2021-05-05
  • Java生成随机姓名、性别和年龄的实现示例

    Java生成随机姓名、性别和年龄的实现示例

    这篇文章主要介绍了Java生成随机姓名、性别和年龄的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2020-09-09
  • JAVA十大排序算法之选择排序详解

    JAVA十大排序算法之选择排序详解

    这篇文章主要介绍了java中的选择排序,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-08-08
  • 详解 JAVA的回调机制CallBack

    详解 JAVA的回调机制CallBack

    最近学习java,接触到了回调机制(CallBack)。初识时感觉比较混乱,而且在网上搜索到的相关的讲解,要么一言带过,要么说的比较单纯的像是给CallBack做了一个定义,本文给大家介绍JAVA的回调机制CallBack,感兴趣的朋友一起学习
    2016-04-04
  • MyBatis实现两种查询树形数据的方法详解(嵌套结果集和递归查询)

    MyBatis实现两种查询树形数据的方法详解(嵌套结果集和递归查询)

    树形结构数据在开发中十分常见,比如:菜单数、组织树, 利用 MyBatis 提供嵌套查询功能可以很方便地实现这个功能需求。本文主要介绍了两种方法,感兴趣的可以了解一下
    2021-09-09
  • 基于springboot搭建的web系统架构的方法步骤

    基于springboot搭建的web系统架构的方法步骤

    这篇文章主要介绍了基于springboot搭建的web系统架构的方法步骤,小编觉得挺不错的,现在分享给大家,也给大家做个参考。一起跟随小编过来看看吧
    2019-04-04
  • 在Eclipse中使用版本管理工具SVN的图文教程

    在Eclipse中使用版本管理工具SVN的图文教程

    下面小编就为大家分享一篇在Eclipse中使用版本管理工具SVN的图文教程,具有很好的参考价值,一起跟随小编过来看看吧
    2017-11-11
  • Java Swing实现记事本页面

    Java Swing实现记事本页面

    这篇文章主要为大家详细介绍了Java Swing实现记事本页面,文中示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-02-02
  • Java中SimpleDateFormat的使用方法

    Java中SimpleDateFormat的使用方法

    这篇文章主要为大家详细介绍了Java中SimpleDateFormat的使用方法,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-12-12
  • springboot 如何配置多个jndi数据源

    springboot 如何配置多个jndi数据源

    这篇文章主要介绍了springboot 如何配置多个jndi数据源的操作,具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
    2021-07-07

最新评论