SpringBoot Event實現(xiàn)異步消費機制的示例代碼

更新時間：2024年04月25日 11:56:40 作者：壹粒麥子

這篇文章主要介紹了SpringBoot Event實現(xiàn)異步消費機制,ApplicationEvent以及Listener是Spring為我們提供的一個事件監(jiān)聽、訂閱的實現(xiàn),內部實現(xiàn)原理是觀察者設計模式,文中有詳細的代碼示例供大家參考,需要的朋友可以參考下

SpringBoot Event實現(xiàn)異步消費機制

ApplicationEvent以及Listener是Spring為我們提供的一個事件監(jiān)聽、訂閱的實現(xiàn)，內部實現(xiàn)原理是觀察者設計模式，設計初衷也是為了系統(tǒng)業(yè)務邏輯之間的解耦，提高可擴展性以及可維護性。

通過 ApplicationEvent 類和 ApplicationListener 接口來提供在 ApplicationContext 中處理事件。如果一個 bean 實現(xiàn) ApplicationListener，那么每次 ApplicationEvent 被發(fā)布到 ApplicationContext 上，那個 bean 會被通知。

(1) ApplicationContext.publishEvent 默認是同步操作, 并非異步操作，發(fā)布事件后需要等 @EventListener 執(zhí)行完

(2) 如果需要開啟異步操作需要在 @EventListener 上增加 @Async 注解。

創(chuàng)建OrderEvent

用于傳遞消息

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

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

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

}

生產(chǎn)者

@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("訂單創(chuàng)建成功，訂單號為：%s", orderNo)));
        return "訂單常見成功";
      
    }
}

監(jiān)聽者

方式一：Event事件監(jiān)聽

事件監(jiān)聽是無序的

@Component   // 第一步
public class GlobalListener {

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

    @EventListener(OrderEvent.class)  // 第二步
    public void createOrder(OrderEvent orderEvent) {
        logger.info("{} 監(jiān)聽器接收到消息，訂單號為：{}", LocalDateTime.now(), orderEvent.getMessage());
    }
}

方式二：實現(xiàn) ApplicationListener接口

事件監(jiān)聽是無序的

@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("方式二： {} 監(jiān)聽器接收到消息，訂單號為：{}", LocalDateTime.now(), orderEvent.getMessage());
    }
}

方式三：SmartApplicationListener實現(xiàn)有序監(jiān)聽

事件監(jiān)聽是有序的

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時，才會調用該監(jiān)聽內的onApplicationEvent方法
     *
     * @param aClass 接收到的監(jiān)聽事件類型
     * @return
     */
    @Override
    public boolean supportsEventType(Class<? extends ApplicationEvent> aClass) {
        // 指定只有 OrderEvent 監(jiān)聽類型才會執(zhí)行下面邏輯
        return aClass == OrderEvent.class;
    }

    /**
     * 該方法返回true&supportsEventType同樣返回true時，才會調用該監(jiān)聽內的onApplicationEvent方法
     *
     * @param sourceType
     * @return
     */
    @Override
    public boolean supportsSourceType(Class<?> sourceType) {
        //只有在 OrderService 內發(fā)布的 OrderEvent 事件時才會執(zhí)行下面邏輯，這里沒有，下面是案列
        // return aClass == OrderService.class;
        return SmartApplicationListener.super.supportsSourceType(sourceType);
    }

    /**
     * supportsEventType & supportsSourceType 兩個方法返回true時調用該方法執(zhí)行業(yè)務邏輯
     *
     * @param applicationEvent 具體監(jiān)聽實例，這里是 OrderEvent
     */
    @Override
    public void onApplicationEvent(ApplicationEvent applicationEvent) {

        //轉換事件類型
        OrderEvent orderEvent = (OrderEvent) applicationEvent;
        String message = orderEvent.getMessage();
        logger.info("方式三(有序)： {} 監(jiān)聽器接收到消息，訂單號為：{}", LocalDateTime.now(), orderEvent.getMessage());
    }

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

}

以上就是SpringBoot Event實現(xiàn)異步消費機制的示例代碼的詳細內容，更多關于SpringBoot Event異步消費機制的資料請關注腳本之家其它相關文章！

您可能感興趣的文章: