用Spring的ApplicationEventPublisher进行事件发布和监听

概述

有时候，我们只是想发布一些本地的事件，并不需要引入MQ的，可以直接使用Spring的ApplicationEventPublisher来完成简单事件的发布和监听的。

比如像下面的场景，ApplicationEventPublisher就够用了。

模块间的逻辑解耦，但不跨服务；
轻量级的本地事件通知
应用内部的解耦和扩展点:比如说在DDD里，聚合保存数据成功后，需要触发若干的后续动作
无强事务要求、无强持久化要求的通知场景

生产环境实战,门店创建成功后发布【门店已成功创建的事件】

在我目前这边，门店一旦创建成功后，是有很多一系列的后续动作要去做的，比如配置门店的各种各样的规则信息。

具体的代码很简单。

就是用ApplicationEventPublisher的publishEvent方法发布事件
用EventListener注解监听事件就可以了。

具体的代码实现如下。

事件发布者封装 ApplicationEventPublisher

ShopCreationEventPublisher对 Spring 的ApplicationEventPublisher做了一层封装，统一事件创建和日志输出：

@Component @RequiredArgsConstructor @Slf4j public class ShopCreationEventPublisher { private final ApplicationEventPublisher applicationEventPublisher; public void publishShopCreationEvent(Long shopId) { if (shopId == null) { return; } applicationEventPublisher.publishEvent( new ShopCreationEvent( shopId, ShopConstant.ShopDomainEvent.SHOP_CREATION_EVENT.getCode() ) ); log.info("Publishing {} for shopId: {}", ShopConstant.ShopDomainEvent.SHOP_CREATION_EVENT.getCode(), shopId); } }

@AllArgsConstructor @Getter public enum ShopDomainEvent { SHOP_CREATION_EVENT("shop_creation_event", "门店已创建"), SHOP_UPDATE_EVENT("shop_update_event", "门店已更新"); /** * 编码 */ private final String code; /** * 描述 */ private final String desc; }

这个类做了几件小事：

封装事件构造：上层只需要传shopId，不关心事件 code 的细节
ShopDomainEvent：定义门店的时间，有创建和更新

通过这层封装，业务代码几乎完全与ApplicationEventPublisher解耦，只依赖一个语义明确的发布器。ShopApplicationService类只需要调用发布方法，事件就发布出去了。

@RequiredArgsConstructor @Service @Slf4j public class ShopApplicationService { private final ShopCreationEventPublisher shopCreationEventPublisher; /** * 保存门店聚合信息 */ public void saveShopInfo(SaveShopInfoCommand saveShopInfoCommand) { // 构建聚合根 ShopInfoAggregateRoot root = shopInfoFactory.createShopInfoAggregateRoot(saveShopInfoCommand); // 持久化 shopInfoRepository.persistence(root); // 发布【门店已创建】的事件 shopCreationEventPublisher.publishShopCreationEvent(root.getId()); } }

事件监听者实现

用EventListener注解就可以了。

@Component @Slf4j @RequiredArgsConstructor class NewShopRuleGenerateListener { @EventListener public void onShopCreationEvent(ShopCreationEvent event) { log.info("NewShopRuleGenerateListener received : {}", JSON.toJSONString(event)); Long shopId = event.getShopId(); if (shopId == null) { return; } // 新启一个线程执行，避免阻塞事件发布线程 new Thread(() -> { ShopInfoAggregateRoot shopInfoAggregateRoot = shopInfoRepository.selectByShopId(shopId.intValue()); // 新增的门店配置各种各样的规则 }).start(); }

可以看出：