SpringBoot Event 事件同步、异步处理

业务需求场景：按照一定的顺序做一些事情，例如向A表插入数据事物提交之后，向B表中插入历史记录，最后向C表插入。

事件机制

事件监听机制可以理解为是一种观察者模式，有数据发布者（事件源）和数据接受者（监听器）；在Java中，事件对象都是继承java.util.EventObject对象，事件监听器都是java.util.EventListener实例;Spring中

Java事件

EventObject

java.util.EventObject是事件状态对象的基类，它封装了事件源对象以及和事件相关的信息。所有java的事件类都需要继承该类。

EventListener

java.util.EventListener是一个标记接口，就是说该接口内是没有任何方法的。所有事件监听器都需要实现该接口。事件监听器注册在事件源上，当事件源的属性或状态改变的时候，调用相应监听器内的回调方法。

Source

事件源不需要实现或继承任何接口或类，它是事件最初发生的地方。因为事件源需要注册事件监听器，所以事件源内需要有相应的盛放事件监听器的容器。

Spring 事件

在 Spring 中，初始化容器时会调用 org.springframework.context.ConfigurableApplicationContext 接口中的 reFresh() 方法进行 Bean的加载，该方法会进行事件的监听注册。

代码实例

UserEvent：user事件对象，继承ApplicationEvent

public class UserEvent extends ApplicationEvent {

    private T data;

    public UserEvent(T source) {

        super(source);

        this.data =source;

    }

    public T getData() {

        return this.data;

    }

    public void setData(final T data) {

        this.data = data;

    }

}

发布插入用户的事件

@Autowired

private ApplicationEventPublisher publisher;

/**

  * 发布插入user表的事件

  */

private void sendInsertUser() {

    User user = new User();

    user.setId(20210317);

    user.setUsername("测试张三");

    UserEvent userEvent = new UserEvent<>(user);

    // 发布事件

    publisher.publishEvent(userEvent);

}

插入用户监听器：同步操作

/**

* 监听插入User的事件

*/

@EventListener

public void insertUserLinster(UserEvent userEvent) {

User data = userEvent.getData();

String message = String.format("get user message: %s", JSON.toJSONString(data));

log.info(message);

// 后续操作；继续处理

}

测试代码：

/**

  * SpringBoot Event 使用

  *

  * @return

  */

@Override

public BackResult testEvent() {

    BackResult backResult = new BackResult();

    try {

        // 向user 表插入数据

        insertUsers();

        // 添加user插入对象操作

        sendInsertUser();

        backResult.setSuccess(true);

        backResult.setMessage("操作成功!");

    } catch (Exception e) {

        backResult.setMessage(e.getMessage());

        backResult.setSuccess(false);

    }

    return backResult;

}

insertUsers：开启事务

/**

  * 插入开启事物

  */

@Transactional(rollbackFor = Exception.class)

public void insertUsers() {

    insertUserBatch();

}

思考

测试代码中，方法执行顺序应该是insertUsers()执行完成，事务提交之后在执行sendInsertUser()，所以事件监听器因该改进一下，在事务提交之后去执行。改进代码如下。

插入用户监听器：

/**

  * 监听插入User的事件 : 在上个事务提交之后在执行

  */

@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT,fallbackExecution = true)

public void insertUserLinster(UserEvent userEvent) {

User data = userEvent.getData();

String message = String.format("get user message: %s", JSON.toJSONString(data));

log.info(message);

// 后续操作；继续处理

}

还有一个问题就是没有考虑，同步和异步的问题，上面的方式是同步的，这样会影响正常的业务逻辑，为了不影响正常的业务操作，可以将监听器修改为异步执行的即可。使用 @Async 标记即可，注意前提条件是：使用 @EnableAsync 开启 Spring 异步。

/**

  * 监听插入User的事件 : 在上个事务提交之后在执行

  */

@Async

@TransactionalEventListener(phase = TransactionPhase.AFTER_COMMIT,fallbackExecution = true)

public void insertUserLinster(UserEvent userEvent) {

    User data = userEvent.getData();

    String message = String.format("get user message: %s", JSON.toJSONString(data));

    log.info(message);

    // 后续操作；继续处理

}

完整代码地址 ：https://gitee.com/Marlon_Brando/back/commit/de586caed15004d0e8e3ae2e9a59f6f170d726d1

————————————————

版权声明：本文为CSDN博主「MarlonBrando1998」的原创文章，遵循CC 4.0 BY-SA版权协议，转载请附上原文出处链接及本声明。

原文链接：https://blog.csdn.net/qq_37248504/article/details/115269995