事务绑定事件

从 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。