Spring Boot Event 觀察者模式，輕松實現(xiàn)業(yè)務(wù)解耦！

• 歡迎準(zhǔn)備 Java 面試以及學(xué)習(xí) Java 的同學(xué)加入我的知識星球，干貨很多！收費雖然是白菜價，但星球里的內(nèi)容或許比你參加上萬的培訓(xùn)班質(zhì)量還要高。
• 《Java 面試指北》持續(xù)更新完善中！這是一份教你如何更高效地準(zhǔn)備面試的小冊，涵蓋常見八股文（系統(tǒng)設(shè)計、常見框架、分布式、高并發(fā) ......）、優(yōu)質(zhì)面經(jīng)等內(nèi)容。

原文：https://blog.csdn.net/csp732171109/article/details/124377254

實際業(yè)務(wù)開發(fā)過程中，業(yè)務(wù)邏輯可能非常復(fù)雜，核心業(yè)務(wù) + N個子業(yè)務(wù)。如果都放到一塊兒去做，代碼可能會很長，耦合度不斷攀升，維護(hù)起來也麻煩，甚至頭疼。還有一些業(yè)務(wù)場景不需要在一次請求中同步完成，比如郵件發(fā)送、短信發(fā)送等。

“

MQ 確實可以解決這個問題，但 MQ 重啊，非必要不提升架構(gòu)復(fù)雜度。

”

針對這些問題，我們了解一下 Spring Event。

Spring Event 同步使用

Spring Event（Application Event）其實就是一個觀察者設(shè)計模式，一個 Bean 處理完成任務(wù)后希望通知其它 Bean 或者說一個 Bean 想觀察監(jiān)聽另一個Bean 的行為。

Spring Event 用來解耦業(yè)務(wù)真的賊好用！

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. 定義監(jiān)聽器

監(jiān)聽并處理事件，實現(xiàn) ApplicationListener 接口或者使用 @EventListener 注解；關(guān)注公眾號：“碼猿技術(shù)專欄”，回復(fù)關(guān)鍵詞：“3333”，獲取阿里內(nèi)部《Spring Cloud Alibaba實戰(zhàn)》手冊

/**
 * 實現(xiàn) ApplicationListener 接口，并指定監(jiān)聽的事件類型
 *
 * @author Strive
 * @date 2022/4/24 09:09
 * @description
 */
@Slf4j
@Component
public class OrderProductListener implements ApplicationListener<OrderProductEvent> {

  /** 使用 onApplicationEvent 方法對消息進(jìn)行接收處理 */
  @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. 定義發(fā)布者

發(fā)布事件，通過 ApplicationEventPublisher 發(fā)布事件；

推薦個人知識總結(jié)網(wǎng)站：www.java-family.cn

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

  /** 注入ApplicationContext用來發(fā)布事件 */
  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("任務(wù)全部完成，總耗時：({})毫秒", end - start);
    return "購買成功";
  }
}

4.單測執(zhí)行

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

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

執(zhí)行結(jié)果如下：

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   : 任務(wù)全部完成，總耗時：(2009)毫秒

Spring Event 異步使用

有些業(yè)務(wù)場景不需要在一次請求中同步完成，比如郵件發(fā)送、短信發(fā)送等。

1. 自定義事件

@Data
@AllArgsConstructor
public class MsgEvent {

  /** 該類型事件攜帶的信息 */
  public String orderId;
}

2. 定義監(jiān)聽器

推薦使用 @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("開發(fā)發(fā)送短信");
    log.info("開發(fā)發(fā)送郵件");
    Thread.sleep(4000);
    long end = System.currentTimeMillis();
    log.info("{}：發(fā)送短信、郵件耗時：({})毫秒", orderId, (end - start));
  }
}

3. 定義發(fā)布者

/**
  * 下單
  * @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("任務(wù)全部完成，總耗時：({})毫秒", end - start);
    return "購買成功";
}

4. 單測執(zhí)行（同步）

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

執(zhí)行結(jié)果如下：

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   : 開發(fā)發(fā)送短信
2022-04-24 10:24:13.907  INFO 54848 --- [           main] c.c.mingyue.event.listener.MsgListener   : 開發(fā)發(fā)送郵件
2022-04-24 10:24:17.908  INFO 54848 --- [           main] c.c.mingyue.event.listener.MsgListener   : 732171109：發(fā)送短信、郵件耗時：(4002)毫秒
2022-04-24 10:24:17.908  INFO 54848 --- [           main] c.c.mingyue.event.service.OrderService   : 任務(wù)全部完成，總耗時：(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("開發(fā)發(fā)送短信");
    log.info("開發(fā)發(fā)送郵件");
    Thread.sleep(4000);
    long end = System.currentTimeMillis();
    log.info("{}：發(fā)送短信、郵件耗時：({})毫秒", orderId, (end - start));
}

6.單測執(zhí)行（異步）

發(fā)送短信的線程顯示 task-1，主線程結(jié)束后（總耗時：(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   : 任務(wù)全部完成，總耗時：(2017)毫秒
2022-04-24 10:30:59.028  INFO 59448 --- [         task-1] c.c.mingyue.event.listener.MsgListener   : 開發(fā)發(fā)送短信
2022-04-24 10:30:59.028  INFO 59448 --- [         task-1] c.c.mingyue.event.listener.MsgListener   : 開發(fā)發(fā)送郵件