Spring ApplicationEvent事件处理

news2024/12/22 20:26:27

Spring的事件

ApplicationEvent以及Listener是Spring为我们提供的一个事件监听、订阅的实现，内部实现原理是观察者设计模式，设计初衷也是为了系统业务逻辑之间的解耦，提高可扩展性以及可维护性。

ApplicationEvent就是Spring的事件接口
ApplicationListener就是Spring的事件监听器接口，所有的监听器都实现该接口
ApplicationEventPublisher是Spring的事件发布接口，ApplicationContext实现了该接口

自定义事件

定义监控基础业务类

/**
 * @author Jerry
 * 监听基础类
 */
public class EventModel {
}

定义更新代办接口参数


/**
 * 更新待办接口
 * @author Jerry
 */
@Data
public class LettersVisitsUpdateTodo extends EventModel {
    /**
     * 添加待办记录时返回的待办记录 id
     */
    private String prtcpt_id;
    /**
     * 待办记录的标题
     * 注意：若有传递此字段，且传递值为非空字符串，则会更新覆盖原记录该字段的值
     */
    private String title;

    /**
     * 待办事项的状态，枚举值：
     * "1"：处理中
     * "2"：待评价
     * "3"：已完成
     *   注意：若有传递此字段，且传递值为非空字符串，则会更新覆盖原记录该字段的值
     */
    private String prtcpt_stat;
    /**
     * 用户提交待办的时间，即用户创建该待办记录的时间。形式为 yyyy-MM-dd HH:mm:ss ，比如 2018-01-01 12:00:00
     *  注意：若有传递此字段，且传递值为非空字符串，则会更新覆盖原记录该字段的值
     */
    private String submt_tm;
    /**
     * 详情页面链接，仅支持h5跳转和内部小程序页面跳转
     *  注意：若有传递此字段，且传递值为非空字符串，则会更新覆盖原记录该字段的值
     */
    private String dtl_jump_lnk;
}

定义添加代办接口参数

/**
 * 添加待办接口参数
 * @author Jerry
 */
@Data
public class LettersVisitsAddTodoDto extends EventModel {

    /**
     * 用户身份证号码或其他可登录小程序的证件号码
     */
     private String cert_num;
    /**
     * 用户证件号类型，枚举值：
     * "10"：身份证
     * "14"：港澳居民来往内地通行证
     * "15"：台湾居民来往大陆通行证4：问卷调查
     * "20"：护照
     * "22"：港澳台居民居住证
     * "23"：外国人永久居留身份证
     * "40"：其他有效个人身份证件
     */
    private String cert_typ;
    /**
     * 即开放平台appid
     */
    private String frgn_id;
    /**
     * 业务系统的待办流水号，长度不允许超过64。
     *  注意：frgn_serial_id 不为空并且重复了，就会增加失败，返回之前的已经插入的待办记录ID
     */
    private String frgn_serial_id;
    /**
     * 待办记录的标题
     */
    private String title;
    /**
     * 待办记录的业务类型，枚举值
     * "1"：我有话对代表说
     * "2"：基层立法联系点留言
     * "3"：意见征集
     * "4"：问卷调查
     * "5"：人大信访
     */
    private String prtcpt_typ;
    /**
     * 待办记录的状态，枚举值
     *  1"：处理中
     * "2"：待评价
     * "3"：已完成
     */
    private String prtcpt_stat;
    /**
     * 户提交待办的时间，即用户创建该待办记录的时间。形式为 yyyy-MM-dd HH:mm:ss ，比如 2018-01-01 12:00:00
     */
    private String submt_tm;
    /**
     * 详情页面链接，仅支持h5跳转和内部小程序页面跳转
     */
    private String dtl_jump_lnk;
}

定义事件

/**
 * 专用监听器
 *
 * @author Jerry
 */
@Getter
@Setter
public class YdjApplicationEvent extends ApplicationEvent {

    private EventModel eventModel;

    public YdjApplicationEvent(Object source) {
        super(source);
    }

    public YdjApplicationEvent(Object source, EventModel eventModel) {
        super(source);
        this.eventModel = eventModel;
    }
}

事件监听三种方式

实现 `ApplicationListener` 接口

/**
 * @author Jerry
 */
@Component
public class YdjApplicationListener implements ApplicationListener<YdjApplicationEvent> {

    @Override
    public void onApplicationEvent(@NotNull YdjApplicationEvent event) {
        EventModel eventModel = event.getEventModel();
        // 这里还可以不仅可以根据类来，还可以设置不同code或者做策略
        System.out.println(event.getEventModel());
    }
}

使用@EventListener注解

/**
 * 处理触发消息发送的事件的handler
 *
 * @author Jerry
 */
@Component
@Slf4j
public class MessageSendEventHandler {

    @Autowired
    private YdjApplicationEventServiceImpl ydjApplicationEventService;

    /**
     *  专用监听器的方法
     *
     * @param ydjApplicationEvent
     */
    @EventListener(YdjApplicationEvent.class)
    public void handleYdjApplicationEvent(YdjApplicationEvent ydjApplicationEvent) {
        EventModel eventModel = ydjApplicationEvent.getEventModel();
        // 添加待办记录
        if (eventModel instanceof LettersVisitsAddTodoDto) {
            ydjApplicationEventService.lettersVisitsAddTodo((LettersVisitsAddTodoDto) eventModel);
        }
        // 更新待办记录
        if (eventModel instanceof LettersVisitsUpdateTodo) {
            ydjApplicationEventService.lettersVisitsUpdateTodo((LettersVisitsUpdateTodo) eventModel);
        }
    }
}

使用@TransactionalEventListener注解

使用@TransactionalEventListener注解来定义一个监听器

@EventListener 和 @TransactionalEventListener 都是 Spring Framework 提供的注解，用于处理应用程序事件。它们的主要区别在于它们处理事件的时间和事务的关联性。

@EventListener：这个注解可以应用于任何方法，使得该方法成为一个事件监听器。当一个事件被发布时，所有标记为 @EventListener 的方法都会被调用，无论当前是否存在一个活动的事务。这意味着 @EventListener 注解的方法可能在事务提交之前或之后被调用。
@TransactionalEventListener：这个注解是 @EventListener 的一个特化版本，它允许更精细地控制事件监听器在事务处理过程中的执行时机。@TransactionalEventListener 默认在当前事务提交后才处理事件（TransactionPhase.AFTER_COMMIT），这可以确保事件处理器只在事务成功提交后才被调用。也可以通过 phase 属性来改变事件处理的时机，例如在事务开始前、事务提交前、事务提交后或者事务回滚

注意：此注解需要spring-tx的依赖；

/**
 * @author Jerry
 * @date 2024-01-02 15:25
 */
@Component
public class DemoListener {

    @TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT, value = {YdjApplicationEvent.class})
    public void messageListener(YdjApplicationEvent event) {
        EventModel eventModel = event.getEventModel();
        System.out.println("DemoListener获取到了监听消息:" + eventModel);
    }
}

 这个注解取值有：
 BEFORE_COMMIT(指定目标方法在事务commit之前执行)
 AFTER_COMMIT(指定目标方法在事务commit之后执行)、
 AFTER_ROLLBACK(指定目标方法在事务rollback之后执行)
 AFTER_COMPLETION(指定目标方法在事务完成时执行，这里的完成是指无论事务是成功提交还是事务回滚了)
 各个值都代表什么意思表达什么功能，非常清晰
 需要注意的是：AFTER_COMMIT + AFTER_COMPLETION是可以同时生效的
 AFTER_ROLLBACK + AFTER_COMPLETION是可以同时生效的