Spring Boot Event 觀察者模式,輕鬆實現業務解耦!

碼猿技術專欄發表於2022-07-14

實際業務開發過程中,業務邏輯可能非常複雜,核心業務 + N個子業務。如果都放到一塊兒去做,程式碼可能會很長,耦合度不斷攀升,維護起來也麻煩,甚至頭疼。還有一些業務場景不需要在一次請求中同步完成,比如郵件傳送、簡訊傳送等。

MQ 確實可以解決這個問題,但 MQ 重啊,非必要不提升架構複雜度。

針對這些問題,我們瞭解一下 Spring Event。

Spring Event 同步使用

Spring Event(Application Event)其實就是一個觀察者設計模式,一個 Bean 處理完成任務後希望通知其它 Bean 或者說一個 Bean 想觀察監聽另一個Bean 的行為。

Spring Event 用來解耦業務真的賊好用!

1. 自定義事件

定義事件,繼承 ApplicationEvent 的類成為一個事件類

/**
 * @author Strive
 * @date 2022/4/22 18:00
 * @description
 */
@Data
@ToString
public class OrderProductEvent extends ApplicationEvent {

  /** 該型別事件攜帶的資訊 */
  private String orderId;

  public OrderProductEvent(Object source, String orderId) {
    super(source);
    this.orderId = orderId;
  }
}

2. 定義監聽器

監聽並處理事件,實現 ApplicationListener 介面或者使用 @EventListener 註解

/**
 * 實現 ApplicationListener 介面,並指定監聽的事件型別
 *
 * @author Strive
 * @date 2022/4/24 09:09
 * @description
 */
@Slf4j
@Component
public class OrderProductListener implements ApplicationListener<OrderProductEvent> {

  /** 使用 onApplicationEvent 方法對訊息進行接收處理 */
  @SneakyThrows
  @Override
  public void onApplicationEvent(OrderProductEvent event) {
    String orderId = event.getOrderId();
    long start = System.currentTimeMillis();
    Thread.sleep(2000);
    long end = System.currentTimeMillis();
    log.info("{}:校驗訂單商品價格耗時:({})毫秒", orderId, (end - start));
  }
}

3. 定義釋出者

釋出事件,通過 ApplicationEventPublisher 釋出事件

/**
 * @author Strive
 * @date 2022/4/24 09:25
 * @description
 */
@Slf4j
@Service
@RequiredArgsConstructor
public class OrderService {

  /** 注入ApplicationContext用來發布事件 */
  private final ApplicationContext applicationContext;

  /**
   * 下單
   *
   * @param orderId 訂單ID
   */
  public String buyOrder(String orderId) {
    long start = System.currentTimeMillis();
    // 1.查詢訂單詳情

    // 2.檢驗訂單價格 (同步處理)
    applicationContext.publishEvent(new OrderProductEvent(this, orderId));

    // 3.簡訊通知(非同步處理)

    long end = System.currentTimeMillis();
    log.info("任務全部完成,總耗時:({})毫秒", end - start);
    return "購買成功";
  }
}

4.單測執行

@SpringBootTest
public class OrderServiceTest {
  @Autowired private OrderService orderService;

  @Test
  public void buyOrderTest() {
    orderService.buyOrder("732171109");
  }
}

執行結果如下:

2022-04-24 10:13:17.535  INFO 44272 --- [           main] c.c.m.e.listener.OrderProductListener    : 732171109:校驗訂單商品價格耗時:(2008)毫秒
2022-04-24 10:13:17.536  INFO 44272 --- [           main] c.c.mingyue.event.service.OrderService   : 任務全部完成,總耗時:(2009)毫秒

Spring Event 非同步使用

有些業務場景不需要在一次請求中同步完成,比如郵件傳送、簡訊傳送等。

1. 自定義事件

@Data
@AllArgsConstructor
public class MsgEvent {

  /** 該型別事件攜帶的資訊 */
  public String orderId;
}

2. 定義監聽器

推薦使用 @EventListener 註解

@Slf4j
@Component
public class MsgListener {

  @SneakyThrows
  @EventListener(MsgEvent.class)
  public void sendMsg(MsgEvent event) {
    String orderId = event.getOrderId();
    long start = System.currentTimeMillis();
    log.info("開發傳送簡訊");
    log.info("開發傳送郵件");
    Thread.sleep(4000);
    long end = System.currentTimeMillis();
    log.info("{}:傳送簡訊、郵件耗時:({})毫秒", orderId, (end - start));
  }
}

3. 定義釋出者

/**
  * 下單
  * @param orderId 訂單ID
  */
public String buyOrder(String orderId) {
    long start = System.currentTimeMillis();
    // 1.查詢訂單詳情

    // 2.檢驗訂單價格 (同步處理)
    applicationContext.publishEvent(new OrderProductEvent(this, orderId));

    // 3.簡訊通知(非同步處理)
    applicationContext.publishEvent(new MsgEvent(orderId));

    long end = System.currentTimeMillis();
    log.info("任務全部完成,總耗時:({})毫秒", end - start);
    return "購買成功";
}

4. 單測執行(同步)

@Test
public void buyOrderTest() {
    orderService.buyOrder("732171109");
}

執行結果如下:

2022-04-24 10:24:13.905  INFO 54848 --- [           main] c.c.m.e.listener.OrderProductListener    : 732171109:校驗訂單商品價格耗時:(2004)毫秒
2022-04-24 10:24:13.906  INFO 54848 --- [           main] c.c.mingyue.event.listener.MsgListener   : 開發傳送簡訊
2022-04-24 10:24:13.907  INFO 54848 --- [           main] c.c.mingyue.event.listener.MsgListener   : 開發傳送郵件
2022-04-24 10:24:17.908  INFO 54848 --- [           main] c.c.mingyue.event.listener.MsgListener   : 732171109:傳送簡訊、郵件耗時:(4002)毫秒
2022-04-24 10:24:17.908  INFO 54848 --- [           main] c.c.mingyue.event.service.OrderService   : 任務全部完成,總耗時:(6008)毫秒

5.開啟非同步

啟動類增加 @EnableAsync 註解

@EnableAsync
@SpringBootApplication
public class MingYueSpringbootEventApplication {

  public static void main(String[] args) {
    SpringApplication.run(MingYueSpringbootEventApplication.class, args);
  }
}

Listener 類需要開啟非同步的方法增加 @Async 註解

@Async
@SneakyThrows
@EventListener(MsgEvent.class)
public void sendMsg(MsgEvent event) {
    String orderId = event.getOrderId();
    long start = System.currentTimeMillis();
    log.info("開發傳送簡訊");
    log.info("開發傳送郵件");
    Thread.sleep(4000);
    long end = System.currentTimeMillis();
    log.info("{}:傳送簡訊、郵件耗時:({})毫秒", orderId, (end - start));
}

6.單測執行(非同步)

傳送簡訊的執行緒顯示 task-1,主執行緒結束後(總耗時:(2017)毫秒)控制檯停止列印了

2022-04-24 10:30:59.002  INFO 59448 --- [           main] c.c.m.e.listener.OrderProductListener    : 732171109:校驗訂單商品價格耗時:(2009)毫秒
2022-04-24 10:30:59.009  INFO 59448 --- [           main] c.c.mingyue.event.service.OrderService   : 任務全部完成,總耗時:(2017)毫秒
2022-04-24 10:30:59.028  INFO 59448 --- [         task-1] c.c.mingyue.event.listener.MsgListener   : 開發傳送簡訊
2022-04-24 10:30:59.028  INFO 59448 --- [         task-1] c.c.mingyue.event.listener.MsgListener   : 開發傳送郵件

最後說一句(別白嫖,求關注)

陳某每一篇文章都是精心輸出,已經寫了3個專欄,整理成PDF,獲取方式如下:

  1. 《Spring Cloud 進階》PDF:關注公眾號:【Java後端面試官】回覆關鍵詞 Spring Cloud 進階 獲取!
  2. 《Spring Boot 進階》PDF:關注公眾號:【Java後端面試官】回覆關鍵詞 Spring Boot進階 獲取!
  3. 《Mybatis 進階》PDF:關注公眾號:【Java後端面試官】回覆關鍵詞 Mybatis 進階 獲取!

如果這篇文章對你有所幫助,或者有所啟發的話,幫忙點贊在看轉發收藏,你的支援就是我堅持下去的最大動力!

本文由mdnice多平臺釋出

相關文章