事务绑定事件

从 Spring 4.2 开始,事件的监听器可以绑定到事务的一个阶段。 典型的例子是在事务成功完成时处理事件。 这样做可以让事件在当前事务的结果对监听器确实很重要时,以更大的灵活性使用。

你可以使用 @EventListener 注解注册一个常规事件监听器。 如果需要将其绑定到事务,请使用 @TransactionalEventListener。 当你这样做时,监听器默认绑定到事务的提交阶段。

下一个示例展示了这个概念。假设一个组件发布了一个订单创建事件,并且我们希望定义一个监听器,该监听器只应在发布该事件的事务成功提交后才处理该事件。以下示例设置了这样一个事件监听器:

  • Java

  • Kotlin

@Component
public class MyComponent {

	@TransactionalEventListener
	public void handleOrderCreatedEvent(CreationEvent<Order> creationEvent) {
		// ...
	}
}
@Component
class MyComponent {

	@TransactionalEventListener
	fun handleOrderCreatedEvent(creationEvent: CreationEvent<Order>) {
		// ...
	}
}

@TransactionalEventListener 注解公开了一个 phase 属性,允许你自定义监听器应绑定到的事务阶段。 有效阶段包括 BEFORE_COMMITAFTER_COMMIT(默认)、AFTER_ROLLBACK,以及聚合事务完成(无论是提交还是回滚)的 AFTER_COMPLETION

如果没有事务正在运行,则根本不会调用监听器,因为我们无法满足所需的语义。但是,你可以通过将注解的 fallbackExecution 属性设置为 true 来覆盖该行为。

从 6.1 开始,@TransactionalEventListener 可以与 PlatformTransactionManager 管理的线程绑定事务以及 ReactiveTransactionManager 管理的响应式事务一起工作。 对于前者,监听器保证能看到当前线程绑定的事务。 由于后者使用 Reactor 上下文而不是线程局部变量,因此事务上下文需要作为事件源包含在已发布的事件实例中。 有关详细信息,请参阅 TransactionalEventPublisher 的 Javadoc。