Spring Boot Event 观察者模式，轻松实现业务解耦

我们了解一下 Spring Event观察者模式，以同步或异步实现监听动态变化，简化开发节省性能

Spring Event 同步使用
Spring Event（Application Event）其实就是一个 观察者设计模式 ，一个 Bean 处理完成任务后希望通知其它 Bean 或者说一个 Bean 想观察监听另一个Bean 的行为。

Spring Event 用来解耦业务真的贼好用！

1. 自定义事件
   定义事件，继承 ApplicationEvent 的类成为一个事件类

    @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 接口，并指定监听的事件类型
    */
    @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 发布事件

    @Slf4j
    @Service
    @RequiredArgsConstructor
    public class OrderService {
    
      /** 注入ApplicationContext用来发布事件 */
      private final ApplicationContext applicationContext;
   
      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. 自定义事件

2.  @Data
    @AllArgsConstructor
    public class MsgEvent {
    
      /** 该类型事件携带的信息 */
      public String orderId;
    }
   

3. 定义监听器

    推荐使用 @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));
      }
    }
   

4. 定义发布者

    /**
      * 下单
      * @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 "购买成功";
    }
   

5. 单测执行（同步）

    @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   : 开发发送邮件